doc/global.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Global</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Global</h1>

    
<section>

<header>
    
        <h2></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
<dl class="details">

    
</dl>


    </div>

    
        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="addAdmin"><span class="type-signature">(private) </span>addAdmin<span class="signature">(groupID, adminID)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Adds an additional admin (ID) to an existing group's admins list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>adminID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of admin to add</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1138">line 1138</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="addAdminHelper"><span class="type-signature">(private) </span>addAdminHelper<span class="signature">(groupID, adminID, pubkeys)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Adds admin locally and remotely on all devices in group (specified by pubkeys
parameter).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>adminID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of admin to add</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pubkeys</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">devices to remotely make this modification on</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1152">line 1152</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="addAdminInMem"><span class="type-signature">(private) </span>addAdminInMem<span class="signature">(oldGroupValue, adminID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Adds admin to admins list of a group (modifies group in place). Necessary
for some functionality to do this in-place, e.g. when adding contacts the
current device adds itself as an admin and needs to propagate that to all
the other linked devices (which would fail the permissions check if it was
sent as a separate message).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>oldGroupValue</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">group value with admins list to update</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>adminID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id of admin to add</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1122">line 1122</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="addChild"><span class="type-signature">(private) </span>addChild<span class="signature">(groupID, childID)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Adds an additional child (ID or pubkey) to an existing group's children list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>childID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of child to add</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line980">line 980</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="addChildHelper"><span class="type-signature">(private) </span>addChildHelper<span class="signature">(groupID, childID, pubkeys)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Adds child locally and remotely on all devices in group (specified by pubkeys
parameter).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>childID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of child to add</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pubkeys</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">devices to remotely make this modification on</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line994">line 994</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="addContact"><span class="type-signature"></span>addContact<span class="signature">(contactPubkey)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Shares own contact info and requests the contact info of contactPubkey.
TODO implement private contact discovery and return contact name.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>contactPubkey</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">hex-formatted public key</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line681">line 681</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="addParent"><span class="type-signature">(private) </span>addParent<span class="signature">(groupID, parentID)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Adds an additional parent (ID) to an existing group's parents list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>parentID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of parent to add</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1038">line 1038</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="addParentHelper"><span class="type-signature">(private) </span>addParentHelper<span class="signature">(groupID, parentID, pubkeys)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Adds parent locally and remotely on all devices in group (specified by pubkeys
parameter).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>parentID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of parent to add</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pubkeys</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">devices to remotely make this modification on</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1052">line 1052</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="addWriter"><span class="type-signature">(private) </span>addWriter<span class="signature">(oldGroupValue, writerID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Adds writer to writers list of a group (modifies group in place).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>oldGroupValue</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">group value with admins list to update</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>writerID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id of writer to add</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1215">line 1215</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="addWriterHelper"><span class="type-signature">(private) </span>addWriterHelper<span class="signature">(groupID, writerID, pubkeys)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Adds writer locally and remotely on all devices in group (specified by pubkeys
parameter).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>writerID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of writer to add</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pubkeys</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">devices to remotely make this modification on</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1229">line 1229</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="checkPermissions"><span class="type-signature">(private) </span>checkPermissions<span class="signature">(payload, srcPubkey)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Checks that sender has proper permissions according to group and resolves
the dumultiplexing function.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>payload</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">decrypted message contents</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>srcPubkey</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">sender public key</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1877">line 1877</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="confirmContact"><span class="type-signature">(private) </span>confirmContact<span class="signature">(contactName, contactGroups)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Processes and stores the requested contact info.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>contactName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">linked name of requested contact</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>contactGroups</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Object></span>


            </td>

            
            <td class="description last">linked group information of requested contact</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line726">line 726</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="confirmUpdateLinked"><span class="type-signature">(private) </span>confirmUpdateLinked<span class="signature">(existingGroups, existingData)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Updates linked group info and and group info for all devices that are 
children of the linked group.

TODO also process any other data sent from the device being linked with.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>existingGroups</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Object></span>


            </td>

            
            <td class="description last">existing groups on linked device</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>existingData</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Object></span>


            </td>

            
            <td class="description last">existing data on linked device</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line615">line 615</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="connectDevice"><span class="type-signature"></span>connectDevice<span class="signature">(pubkey<span class="signature-attributes">nullable</span>)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Connects the device to the server, e.g. when a client adds a new
device or when a previously-added device comes back online.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pubkey</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">public key of current device</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line208">line 208</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="createDevice"><span class="type-signature"></span>createDevice<span class="signature">(linkedName<span class="signature-attributes">nullable</span>, deviceName<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Initializes device and its linked group.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>linkedName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">human-readable name (for contacts)</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>deviceName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">human-readable name (for self)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line397">line 397</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="createGroup"><span class="type-signature">(private) </span>createGroup<span class="signature">(ID, name, parents, children)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Wrapper function for assigning a group ID to a group object consisting
of a name and children list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">group ID</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">human-readable name</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>parents</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">groups that point to this group</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>children</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">groups that this group points to</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line885">line 885</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="createKey"><span class="type-signature">(private) </span>createKey<span class="signature">(ID, name, parents)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Wrapper function for assigning a key ID to a key object consisting
of a name.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">hex-formatted public key</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">human-readable name</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>parents</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">groups that point to this group</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line899">line 899</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="createLinkedDevice"><span class="type-signature"></span>createLinkedDevice<span class="signature">(dstPubkey, deviceName<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Initializes device and requests to link with existing device.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>dstPubkey</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">hex-formatted public key of device to link with</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>deviceName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">human-readable name (for self)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line410">line 410</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="deleteAllLinkedDevices"><span class="type-signature"></span>deleteAllLinkedDevices<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Deletes all devices that are children of this device's linked group.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line835">line 835</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="deleteData"><span class="type-signature">(private) </span>deleteData<span class="signature">(key)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Deletes data key (and associated value).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data key</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1587">line 1587</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="deleteDevice"><span class="type-signature"></span>deleteDevice<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Deletes the current device's data and removes it's public key from 
the server.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line807">line 807</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="deleteGroup"><span class="type-signature">(private) </span>deleteGroup<span class="signature">(groupID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Unlinks the group denoted by groupID from its parents and children
and then deletes the group itself.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to delete</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line850">line 850</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="deleteLinkedDevice"><span class="type-signature"></span>deleteLinkedDevice<span class="signature">(pubkey)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Deletes the device pointed to by pubkey.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pubkey</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">hex-formatted public key</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line825">line 825</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="disconnectDevice"><span class="type-signature"></span>disconnectDevice<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Simulates offline devices
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line219">line 219</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="getAdmins"><span class="type-signature">(private) </span>getAdmins<span class="signature">(groupID)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    Get admins list of group.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id of group whose admins list to get</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1083">line 1083</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="getAdminsMem"><span class="type-signature">(private) </span>getAdminsMem<span class="signature">(groupIDs)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    Gets the set of admins for a new group by getting the intersection of all
the admins lists of all parent groups (since adding this new group will 
presumably need to modify all parents).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupIDs</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">list of group ids to check across</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1098">line 1098</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="getAllGroups"><span class="type-signature">(private) </span>getAllGroups<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;Object>}</span></h4>
    

<div class="description">
    Gets all groups on current device.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1291">line 1291</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;Object></span>


    </dd>
</dl>

    
    <h4 class="name" id="getAllSubgroups"><span class="type-signature">(private) </span>getAllSubgroups<span class="signature">(groupID)</span><span class="type-signature"> &rarr; {Array.&lt;Object>}</span></h4>
    

<div class="description">
    Recursively gets all children groups in the subtree with root groupID.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to get all subgroups of</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line954">line 954</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;Object></span>


    </dd>
</dl>

    
    <h4 class="name" id="getChildren"><span class="type-signature">(private) </span>getChildren<span class="signature">(groupID)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    Gets childrens list of group with groupID.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to get children of</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line942">line 942</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="getContacts"><span class="type-signature"></span>getContacts<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    Get all contacts.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line783">line 783</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="getData"><span class="type-signature"></span>getData<span class="signature">(prefix<span class="signature-attributes">nullable</span>, id<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {Object|Array.&lt;Object>|null}</span></h4>
    

<div class="description">
    If only prefix is specified, gets a list of data objects whose keys begin
with that prefix, otherwise get a single data object. Allows getting data
for either a single prefix at a time or _all_ app prefixes.
TODO allow specifying a sublist of app prefixes?
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">data prefix</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">app-specific object id</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1462">line 1462</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>
|

<span class="param-type">Array.&lt;Object></span>
|

<span class="param-type">null</span>


    </dd>
</dl>

    
    <h4 class="name" id="getDataKey"><span class="type-signature">(private) </span>getDataKey<span class="signature">(prefix, id)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Get storage key for item given prefix and id.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">key prefix (GROUPS or app-specific)</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">auto-incremented id</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1389">line 1389</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="getDataPrefix"><span class="type-signature">(private) </span>getDataPrefix<span class="signature">(prefix)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Get partial storage key for a particular data prefix.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">key prefix (app-specific)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1401">line 1401</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="getGroup"><span class="type-signature">(private) </span>getGroup<span class="signature">(groupID)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Group getter.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to get</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1280">line 1280</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="getLinkedDevices"><span class="type-signature"></span>getLinkedDevices<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    Linked group getter.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1323">line 1323</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="getLinkedName"><span class="type-signature"></span>getLinkedName<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Get linked name.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1332">line 1332</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="getNewGroupID"><span class="type-signature">(private) </span>getNewGroupID<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Randomly generates a new group ID.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1343">line 1343</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="getOutstandingLinkPubkey"><span class="type-signature">(private) </span>getOutstandingLinkPubkey<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Helper for retrieving temporary state to help with permission checks when
the current device has requested to be linked with another.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line447">line 447</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    the pubkey with which this device has requested to link
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="getParents"><span class="type-signature">(private) </span>getParents<span class="signature">(groupID)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    Gets parents list of group with groupID.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group whose parents list to get</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1025">line 1025</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="getPendingContacts"><span class="type-signature"></span>getPendingContacts<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    Get pending contacts.
TODO implement pending list.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line793">line 793</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="getPrivkey"><span class="type-signature">(private) </span>getPrivkey<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Private key getter.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line2084">line 2084</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="getPubkey"><span class="type-signature"></span>getPubkey<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Public key getter.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line2062">line 2062</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="getWriters"><span class="type-signature">(private) </span>getWriters<span class="signature">(groupID)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    Gets writers list of group.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id of group to get writers list of</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1203">line 1203</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="grantAdminPrivs"><span class="type-signature"></span>grantAdminPrivs<span class="signature">(prefix, id, toShareGroupID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Allow application to share particular data object with another set of devices
with read/write/admin privileges.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">app prefix for this data object</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data object id</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>toShareGroupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">group to grant read/write/admin privileges to</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1627">line 1627</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="grantReaderPrivs"><span class="type-signature"></span>grantReaderPrivs<span class="signature">(prefix, id, toShareGroupID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Allow application to share particular data object with another set of devices
with read privileges.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">app prefix for this data object</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data object id</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>toShareGroupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">group to grant read privileges to</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1599">line 1599</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="grantWriterPrivs"><span class="type-signature"></span>grantWriterPrivs<span class="signature">(prefix, id, toShareGroupID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Allow application to share particular data object with another set of devices
with read/write privileges.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">app prefix for this data object</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data object id</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>toShareGroupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">group to grant read/write privileges to</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1611">line 1611</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="groupReplace"><span class="type-signature">(private) </span>groupReplace<span class="signature">(group, IDToReplace, replacementID)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Replaces specified ID with another ID in all fields of a group.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>IDToReplace</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id to replace</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>replacementID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">replacement id</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line589">line 589</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    new group with all instances of IDToReplace replaced with
  replacementID
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="groupReplaceHelper"><span class="type-signature">(private) </span>groupReplaceHelper<span class="signature">(key, fullGroup, IDToReplace, replacementID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Helper function that replaces (in place) the specified ID in the specified 
group field with another ID, modifying the group data in place.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">name of group field to update</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fullGroup</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">actual group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>IDToReplace</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id to replace</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>replacementID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">replacement id</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line567">line 567</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="hasAdminPriv"><span class="type-signature">(private) </span>hasAdminPriv<span class="signature">(toCheckID, groupID, inDB)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Check if one groupID has admin privileges for another groupID.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>toCheckID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="default">
                
                </td>
            

            <td class="description last">id to check if has permissions</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="default">
                
                </td>
            

            <td class="description last">id to use for checking permissions</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>inDB</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last">boolean used to encode the need for an in-memory 
  admin-privilege-checking function, rather than one that queries storage</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1978">line 1978</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="hasWriterPriv"><span class="type-signature">(private) </span>hasWriterPriv<span class="signature">(toCheckID, groupID)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Check if one groupID has writer privileges for another groupID.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>toCheckID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">is to check if has permissions</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id to use for checking permissions</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1994">line 1994</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(ip, port, config)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Initializes client-server connection and client state.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ip</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">server IP address</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>port</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">server port number</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>config</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">client configuration options</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line189">line 189</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="initDevice"><span class="type-signature">(private) </span>initDevice<span class="signature">(linkedName<span class="signature-attributes">nullable</span>, deviceName<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Initializes a new device with a keypair and adds the public key to the
server.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>linkedName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

                <td class="default">
                
                    null
                
                </td>
            

            <td class="description last">human-readable name (for contacts)</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>deviceName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

                <td class="default">
                
                    null
                
                </td>
            

            <td class="description last">human-readable name (for self)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line367">line 367</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="isKey"><span class="type-signature">(private) </span>isKey<span class="signature">(group)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Helper function for determining if resolveIDs has hit it's base case or not.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>group</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">a group</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line344">line 344</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="isMember"><span class="type-signature">(private) </span>isMember<span class="signature">(toCheckGroupID, groupIDList)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

<div class="description">
    Checks if a groupID is a member of a group.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>toCheckGroupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to check for</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>groupIDList</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">list of group IDs to check all children of</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line2007">line 2007</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    
    <h4 class="name" id="linkGroups"><span class="type-signature">(private) </span>linkGroups<span class="signature">(parentID, childID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Links parentID with childID by updating their childrens and parents lists,
respectively.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>parentID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to update</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>childID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of new group</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line635">line 635</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="listIntersect"><span class="type-signature">(private) </span>listIntersect<span class="signature">(list1, list2)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    Helper function for determining the intersection between two lists.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>list1</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>list2</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1510">line 1510</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    intersection of list1 and list2
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="newGroupHelper"><span class="type-signature">(private) </span>newGroupHelper<span class="signature">(groupID, value, pubkeys)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Sends NEW_GROUP message to specified pubkeys.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id of group to add</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">group value to add</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pubkeys</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">list of pubkeys to add group on</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line661">line 661</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="onMessage"><span class="type-signature"></span>onMessage<span class="signature">(msg)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Decrypts, validates, and demultiplexes the received message to
appropriate handler.

TODO consider: expose ordered or unordered message reception?
E.g. ordered may be simpler to program against but maybe 
real-time apps would benefit from an unordered API (perhaps
make this composable?).

TODO make private to module instead of exporting fully.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>msg</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">message with encrypted contents</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line281">line 281</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="parseContactInfo"><span class="type-signature">(private) </span>parseContactInfo<span class="signature">(contactName, contactGroups)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Parses and stores the supplied contact info, relinking previous 
parent/child pointers from LINKED to contactName.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>contactName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">contact name</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>contactGroups</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Object></span>


            </td>

            
            <td class="description last">contact's linked group information</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line739">line 739</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="processRequestContact"><span class="type-signature">(private) </span>processRequestContact<span class="signature">(reqContactName, reqContactGroups)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Asks user if contact exchange should be accepted, and if so processes
and stores the requesting party's contact info and sends back own 
contact info.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>reqContactName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">requesting party's linked name</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>reqContactGroups</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Object></span>


            </td>

            
            <td class="description last">list of requesting party's linked subgroups</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line706">line 706</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="processUpdateLinkedRequest"><span class="type-signature">(private) </span>processUpdateLinkedRequest<span class="signature">(tempName, srcPubkey, newLinkedMembers)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Creates a new group for the requesting device, adds the new group ID to the 
current device's linked group, and send the requesting device the list of 
and group information of any existing devices (including the current one).

TODO send other data from this device (e.g. app data)? Would be useful for 
backups.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>tempName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">temporary name of device requesting to link</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>srcPubkey</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">pubkey of device requesting to link</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>newLinkedMembers</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;Object></span>


            </td>

            
            <td class="description last">linked subgroups of device requesting to link</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line480">line 480</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="removeAdmin"><span class="type-signature">(private) </span>removeAdmin<span class="signature">(groupID, adminID)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Removes an admin (ID or pubkey) from an existing group's admins list.
Noop if admin did not exist in the admins list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>adminID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of admin to remove</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1171">line 1171</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="removeAdminHelper"><span class="type-signature">(private) </span>removeAdminHelper<span class="signature">(groupID, adminID, pubkeys)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Removes admin locally and remotely on all devices in group (specified by pubkeys
parameter).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>adminID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of admin to remove</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pubkeys</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">devices to remotely make this modification on</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1185">line 1185</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="removeChild"><span class="type-signature">(private) </span>removeChild<span class="signature">(groupID, childID)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Removes a child (ID or pubkey) from an existing group's children list.
Noop if child did not exist in the children list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>childID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of child to remove</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1013">line 1013</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="removeContact"><span class="type-signature"></span>removeContact<span class="signature">(name)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Remove contact.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">contact name</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line771">line 771</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="removeData"><span class="type-signature"></span>removeData<span class="signature">(prefix, id)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Removes the datum with prefix and id.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data prefix</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data id (app-specific)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1524">line 1524</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="removeDataHelper"><span class="type-signature">(private) </span>removeDataHelper<span class="signature">(key, groupID<span class="signature-attributes">nullable</span>)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Function that handles propagating data removal to all members of the 
group and deleting the datum locally.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">data key</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">group ID to use for resolving pubkeys to delete from</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1537">line 1537</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="removeGroup"><span class="type-signature">(private) </span>removeGroup<span class="signature">(groupID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Group remover.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to remove</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1314">line 1314</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="removeOutstandingLinkPubkey"><span class="type-signature">(private) </span>removeOutstandingLinkPubkey<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Clears temporary state.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line456">line 456</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="removeParent"><span class="type-signature">(private) </span>removeParent<span class="signature">(groupID, parentID)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Removes a parent (ID or pubkey) from an existing group's parents list.
Noop if parent did not exist in the parent list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>parentID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of parent to remove</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1071">line 1071</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="removeWriter"><span class="type-signature">(private) </span>removeWriter<span class="signature">(groupID, writerID)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Removes a writer (ID or pubkey) from an existing group's writers list.
Noop if writer did not exist in the writers list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>writerID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of writer to remove</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1248">line 1248</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="removeWriterHelper"><span class="type-signature">(private) </span>removeWriterHelper<span class="signature">(groupID, writerID, pubkeys)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Removes writer locally and remotely on all devices in group (specified by pubkeys
parameter).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>writerID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of writer to remove</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pubkeys</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">devices to remotely make this modification on</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1262">line 1262</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="resolveIDs"><span class="type-signature">(private) </span>resolveIDs<span class="signature">(ids)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    Resolves a list of one or more group IDs to a list of public keys.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ids</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">group IDs to resolve</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line321">line 321</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="revokeAdminPrivs"><span class="type-signature"></span>revokeAdminPrivs<span class="signature">(prefix, id, toUnshareGroupID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Remove member from the relevant group's admins list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">app-specific data prefix</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data object id</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>toUnshareGroupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id of member to revoke admin privileges of</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1730">line 1730</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="revokeAllPrivs"><span class="type-signature"></span>revokeAllPrivs<span class="signature">(prefix, id, toUnshareGroupID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Remove member from all of the relevant group's lists.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">app-specific data prefix</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data object id</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>toUnshareGroupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id of member to revoke privileges of</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1741">line 1741</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="revokeWriterPrivs"><span class="type-signature"></span>revokeWriterPrivs<span class="signature">(prefix, id, toUnshareGroupID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Remove member from the relevant group's writers list.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">app-specific data prefix</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data object id</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>toUnshareGroupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id of member to revoke write privileges of</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1719">line 1719</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="sendMessage"><span class="type-signature">(private) </span>sendMessage<span class="signature">(dstPubkeys, payload)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Called like: sendMessage(resolveIDs(id), payload) (see example in 
deleteAllLinkedDevices()).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>dstPubkeys</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
            <td class="description last">public keys to send message to</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>payload</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">message contents</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line238">line 238</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setData"><span class="type-signature"></span>setData<span class="signature">(prefix, data, id)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Generates ID for data value, resolves the full key given the prefix, 
adds group information, stores value and sends to other devices
in the group to also store.
TODO allow named groups from app.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">prefix name</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">app-specific data object</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">app-specific object id</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1415">line 1415</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setDataHelper"><span class="type-signature">(private) </span>setDataHelper<span class="signature">(key, data, groupID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Function that handles propagating data to all members of the 
group and storing the datum locally.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data key</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">data value</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to propagate to</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1429">line 1429</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setGroup"><span class="type-signature">(private) </span>setGroup<span class="signature">(groupID, groupValue)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Group setter.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to set</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>groupValue</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">value to set group to</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1303">line 1303</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setOutstandingLinkPubkey"><span class="type-signature">(private) </span>setOutstandingLinkPubkey<span class="signature">(pubkey)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Helper that sets temporary state to help with permission checks when
the current device has requested to be linked with another.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pubkey</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">pubkey to link with and from which additional/updated
  group information will come (and which this device should thus allow)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line435">line 435</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setPrivkey"><span class="type-signature">(private) </span>setPrivkey<span class="signature">(privkey)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Private key setter.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>privkey</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">hex-formatted private key to set as device's private key</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line2095">line 2095</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setPubkey"><span class="type-signature">(private) </span>setPubkey<span class="signature">(pubkey)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Public key setter.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pubkey</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">hex-formatted public key to set as device's public key</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line2073">line 2073</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setValidateCallback"><span class="type-signature"></span>setValidateCallback<span class="signature">(newValidateCallback)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Sets the callback function with which to perform message validation
for this application.

TODO validate newValidateCallback to ensure it only takes one arg (payload)
and returns boolean.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>newValidateCallback</code></td>
            

            <td class="type">
            
                
<span class="param-type">callback</span>


            </td>

            
            <td class="description last">new validation callback</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line2034">line 2034</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="shareData"><span class="type-signature">(private) </span>shareData<span class="signature">(prefix, id, toShareGroupID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Shares data item by creating new group that subsumes both it's 
current group and the new group to share with (commonly, a contact's 
name). Then propagates the new group info to all members of that 
group along with the data item itself.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data prefix</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data id</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>toShareGroupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id with which to share data</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1649">line 1649</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="unlinkAndDeleteGroupHelper"><span class="type-signature">(private) </span>unlinkAndDeleteGroupHelper<span class="signature">(groupID, parentID, pubkeys, local)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Removes the parent back-pointer to the group-to-delete and then deletes
the group, both locally and remotely.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="default">
                
                </td>
            

            <td class="description last">id of group whose parent pointer point to the group-to-delete</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>parentID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="default">
                
                </td>
            

            <td class="description last">id of group-to-delete</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pubkeys</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;string></span>


            </td>

            
                <td class="default">
                
                </td>
            

            <td class="description last">list of pubkeys to make remote modification on</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>local</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last">flag for making modification locally</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1358">line 1358</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="unshareChecks"><span class="type-signature">(private) </span>unshareChecks<span class="signature">(prefix, id, toUnshareGroupID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Performs necessary checks before any unsharing/privilege revoking can take place.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">app-specific data prefix</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data object id</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>toUnshareGroupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id of member to revoke privileges of</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1754">line 1754</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="unshareData"><span class="type-signature">(private) </span>unshareData<span class="signature">(prefix, id, toUnshareGroupID)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Unshares data item by creating new group that excludes groupID (commonly
a contact's name or any other subgroup). Propagates the new group info
to the new group members and deletes old group and data from groupID's
devices.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data prefix</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data id</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>toUnshareGroupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">id with which to unshare data</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1803">line 1803</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="updateData"><span class="type-signature">(private) </span>updateData<span class="signature">(key, value)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Stores data value at data key (where data value has group information).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">data key</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">data value</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line1576">line 1576</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="updateGroup"><span class="type-signature">(private) </span>updateGroup<span class="signature">(groupID, value)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Updates group with new value.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">group ID</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">group value</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line648">line 648</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="updateList"><span class="type-signature">(private) </span>updateList<span class="signature">(key, groupID, memberID, callback)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Helper function for updating the specified list of an existing group.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">list key</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>groupID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of group to modify</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>memberID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">ID of list member to add/remove</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">callback</span>


            </td>

            
            <td class="description last">operation to perform on the list</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line926">line 926</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="validate"><span class="type-signature">(private) </span>validate<span class="signature">(payload)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Validates a message via the validateCallback, which can either be:
defined by the application (through setValidateCallback()), or
the default callback (defaultValidateCallback).
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>payload</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">the decrypted message contents</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="index.js.html">index.js</a>, <a href="index.js.html#line2047">line 2047</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#addAdmin">addAdmin</a></li><li><a href="global.html#addAdminHelper">addAdminHelper</a></li><li><a href="global.html#addAdminInMem">addAdminInMem</a></li><li><a href="global.html#addChild">addChild</a></li><li><a href="global.html#addChildHelper">addChildHelper</a></li><li><a href="global.html#addContact">addContact</a></li><li><a href="global.html#addParent">addParent</a></li><li><a href="global.html#addParentHelper">addParentHelper</a></li><li><a href="global.html#addWriter">addWriter</a></li><li><a href="global.html#addWriterHelper">addWriterHelper</a></li><li><a href="global.html#checkPermissions">checkPermissions</a></li><li><a href="global.html#confirmContact">confirmContact</a></li><li><a href="global.html#confirmUpdateLinked">confirmUpdateLinked</a></li><li><a href="global.html#connectDevice">connectDevice</a></li><li><a href="global.html#createDevice">createDevice</a></li><li><a href="global.html#createGroup">createGroup</a></li><li><a href="global.html#createKey">createKey</a></li><li><a href="global.html#createLinkedDevice">createLinkedDevice</a></li><li><a href="global.html#deleteAllLinkedDevices">deleteAllLinkedDevices</a></li><li><a href="global.html#deleteData">deleteData</a></li><li><a href="global.html#deleteDevice">deleteDevice</a></li><li><a href="global.html#deleteGroup">deleteGroup</a></li><li><a href="global.html#deleteLinkedDevice">deleteLinkedDevice</a></li><li><a href="global.html#disconnectDevice">disconnectDevice</a></li><li><a href="global.html#getAdmins">getAdmins</a></li><li><a href="global.html#getAdminsMem">getAdminsMem</a></li><li><a href="global.html#getAllGroups">getAllGroups</a></li><li><a href="global.html#getAllSubgroups">getAllSubgroups</a></li><li><a href="global.html#getChildren">getChildren</a></li><li><a href="global.html#getContacts">getContacts</a></li><li><a href="global.html#getData">getData</a></li><li><a href="global.html#getDataKey">getDataKey</a></li><li><a href="global.html#getDataPrefix">getDataPrefix</a></li><li><a href="global.html#getGroup">getGroup</a></li><li><a href="global.html#getLinkedDevices">getLinkedDevices</a></li><li><a href="global.html#getLinkedName">getLinkedName</a></li><li><a href="global.html#getNewGroupID">getNewGroupID</a></li><li><a href="global.html#getOutstandingLinkPubkey">getOutstandingLinkPubkey</a></li><li><a href="global.html#getParents">getParents</a></li><li><a href="global.html#getPendingContacts">getPendingContacts</a></li><li><a href="global.html#getPrivkey">getPrivkey</a></li><li><a href="global.html#getPubkey">getPubkey</a></li><li><a href="global.html#getWriters">getWriters</a></li><li><a href="global.html#grantAdminPrivs">grantAdminPrivs</a></li><li><a href="global.html#grantReaderPrivs">grantReaderPrivs</a></li><li><a href="global.html#grantWriterPrivs">grantWriterPrivs</a></li><li><a href="global.html#groupReplace">groupReplace</a></li><li><a href="global.html#groupReplaceHelper">groupReplaceHelper</a></li><li><a href="global.html#hasAdminPriv">hasAdminPriv</a></li><li><a href="global.html#hasWriterPriv">hasWriterPriv</a></li><li><a href="global.html#init">init</a></li><li><a href="global.html#initDevice">initDevice</a></li><li><a href="global.html#isKey">isKey</a></li><li><a href="global.html#isMember">isMember</a></li><li><a href="global.html#linkGroups">linkGroups</a></li><li><a href="global.html#listIntersect">listIntersect</a></li><li><a href="global.html#newGroupHelper">newGroupHelper</a></li><li><a href="global.html#onMessage">onMessage</a></li><li><a href="global.html#parseContactInfo">parseContactInfo</a></li><li><a href="global.html#processRequestContact">processRequestContact</a></li><li><a href="global.html#processUpdateLinkedRequest">processUpdateLinkedRequest</a></li><li><a href="global.html#removeAdmin">removeAdmin</a></li><li><a href="global.html#removeAdminHelper">removeAdminHelper</a></li><li><a href="global.html#removeChild">removeChild</a></li><li><a href="global.html#removeContact">removeContact</a></li><li><a href="global.html#removeData">removeData</a></li><li><a href="global.html#removeDataHelper">removeDataHelper</a></li><li><a href="global.html#removeGroup">removeGroup</a></li><li><a href="global.html#removeOutstandingLinkPubkey">removeOutstandingLinkPubkey</a></li><li><a href="global.html#removeParent">removeParent</a></li><li><a href="global.html#removeWriter">removeWriter</a></li><li><a href="global.html#removeWriterHelper">removeWriterHelper</a></li><li><a href="global.html#resolveIDs">resolveIDs</a></li><li><a href="global.html#revokeAdminPrivs">revokeAdminPrivs</a></li><li><a href="global.html#revokeAllPrivs">revokeAllPrivs</a></li><li><a href="global.html#revokeWriterPrivs">revokeWriterPrivs</a></li><li><a href="global.html#sendMessage">sendMessage</a></li><li><a href="global.html#setData">setData</a></li><li><a href="global.html#setDataHelper">setDataHelper</a></li><li><a href="global.html#setGroup">setGroup</a></li><li><a href="global.html#setOutstandingLinkPubkey">setOutstandingLinkPubkey</a></li><li><a href="global.html#setPrivkey">setPrivkey</a></li><li><a href="global.html#setPubkey">setPubkey</a></li><li><a href="global.html#setValidateCallback">setValidateCallback</a></li><li><a href="global.html#shareData">shareData</a></li><li><a href="global.html#unlinkAndDeleteGroupHelper">unlinkAndDeleteGroupHelper</a></li><li><a href="global.html#unshareChecks">unshareChecks</a></li><li><a href="global.html#unshareData">unshareData</a></li><li><a href="global.html#updateData">updateData</a></li><li><a href="global.html#updateGroup">updateGroup</a></li><li><a href="global.html#updateList">updateList</a></li><li><a href="global.html#validate">validate</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Oct 03 2022 22:20:52 GMT-0400 (Eastern Daylight Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>