documentation/AmplitudeClient.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: AmplitudeClient</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">Class: AmplitudeClient</h1>

    
<section>

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

<article>
    <div class="container-overview">
    
        
    <h4 class="name" id="AmplitudeClient"><span class="type-signature"></span>new AmplitudeClient<span class="signature">()</span><span class="type-signature"></span></h4>

    
<div class="description">
    AmplitudeClient SDK API - instance constructor.
The Amplitude class handles creation of client instances, all you need to do is call amplitude.getInstance()
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line18">line 18</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>var amplitudeClient = new AmplitudeClient();</code></pre>


    </div>

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

        
<h4 class="name" id="__VERSION__"><span class="type-signature"></span>__VERSION__<span class="type-signature"></span></h4>


<div class="description">
    Get the current version of Amplitude's Javascript SDK.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line1186">line 1186</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>var amplitudeVersion = amplitude.__VERSION__;</code></pre>


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

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

    
<div class="description">
    Clear all of the user properties for the current user. Note: clearing user properties is irreversible!
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line713">line 713</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>amplitudeClient.clearUserProperties();</code></pre>


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

    
<div class="description">
    Returns the id of the current session.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line253">line 253</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Id of the current session.
</div>


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


    </dd>
</dl>

    
    <h4 class="name" id="identify"><span class="type-signature"></span>identify<span class="signature">(identify_obj, opt_callback)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Send an identify call containing user property operations to Amplitude servers.
See <a href="https://github.com/amplitude/Amplitude-Javascript#user-properties-and-user-property-operations">Readme</a>
for more information on the Identify API and user property operations.
</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>identify_obj</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Identify.html">Identify</a></span>


            </td>

            
            <td class="description last">the Identify object containing the user property operations to send.</td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type"><a href="Amplitude.html#~eventCallback">Amplitude~eventCallback</a></span>


            </td>

            
            <td class="description last">(optional) callback function to run when the identify event has been sent.
Note: the server response code and response body from the identify event upload are passed to the callback function.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line749">line 749</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>var identify = new amplitude.Identify().set('colors', ['rose', 'gold']).add('karma', 1).setOnce('sign_up_date', '2016-03-31');
amplitude.identify(identify);</code></pre>


    <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(apiKey, opt_userId, opt_config, opt_callback)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Initializes the Amplitude Javascript SDK with your apiKey and any optional configurations.
This is required before any other methods can be called.
</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>apiKey</code></td>
            

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


            </td>

            
            <td class="description last">The API key for your app.</td>
        </tr>

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

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


            </td>

            
            <td class="description last">(optional) An identifier for this user.</td>
        </tr>

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

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


            </td>

            
            <td class="description last">(optional) Configuration options.
See <a href="https://github.com/amplitude/Amplitude-Javascript#configuration-options">Readme</a> for list of options and default values.</td>
        </tr>

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

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


            </td>

            
            <td class="description last">(optional) Provide a callback function to run after initialization is complete.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line62">line 62</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>amplitudeClient.init('API_KEY', 'USER_ID', {includeReferrer: true, includeUtm: true}, function() { alert('init complete'); });</code></pre>


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

    
<div class="description">
    Returns true if a new session was created during initialization, otherwise false.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line244">line 244</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Whether a new session was created during initialization.
</div>


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


    </dd>
</dl>

    
    <h4 class="name" id="logEvent"><span class="type-signature"></span>logEvent<span class="signature">(eventType, eventProperties, opt_callback)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Log an event with eventType and eventProperties
</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>eventType</code></td>
            

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


            </td>

            
            <td class="description last">name of event</td>
        </tr>

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

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


            </td>

            
            <td class="description last">(optional) an object with string keys and values for the event properties.</td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type"><a href="Amplitude.html#~eventCallback">Amplitude~eventCallback</a></span>


            </td>

            
            <td class="description last">(optional) a callback function to run after the event is logged.
Note: the server response code and response body from the event upload are passed to the callback function.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

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

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>amplitudeClient.logEvent('Clicked Homepage Button', {'finished_flow': false, 'clicks': 15});</code></pre>


    <h4 class="name" id="logEventWithGroups"><span class="type-signature"></span>logEventWithGroups<span class="signature">(eventType, eventProperties, groups, opt_callback)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Log an event with eventType, eventProperties, and groups. Use this to set event-level groups.
Note: the group(s) set only apply for the specific event type being logged and does not persist on the user
(unless you explicitly set it with setGroup).
See the <a href="https://github.com/amplitude/Amplitude-Javascript#setting-groups">SDK Readme</a> for more information
about groups and Count by Distinct on the Amplitude platform.
</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>eventType</code></td>
            

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


            </td>

            
            <td class="description last">name of event</td>
        </tr>

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

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


            </td>

            
            <td class="description last">(optional) an object with string keys and values for the event properties.</td>
        </tr>

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

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


            </td>

            
            <td class="description last">(optional) an object with string groupType: groupName values for the event being logged.
groupName can be a string or an array of strings.</td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type"><a href="Amplitude.html#~eventCallback">Amplitude~eventCallback</a></span>


            </td>

            
            <td class="description last">(optional) a callback function to run after the event is logged.
Note: the server response code and response body from the event upload are passed to the callback function.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line939">line 939</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>amplitudeClient.logEventWithGroups('Clicked Button', null, {'orgId': 24});</code></pre>


    <h4 class="name" id="logEventWithTimestamp"><span class="type-signature"></span>logEventWithTimestamp<span class="signature">(eventType, eventProperties, timesatmp, opt_callback)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Log an event with eventType and eventProperties and a custom timestamp
</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>eventType</code></td>
            

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


            </td>

            
            <td class="description last">name of event</td>
        </tr>

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

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


            </td>

            
            <td class="description last">(optional) an object with string keys and values for the event properties.</td>
        </tr>

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

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


            </td>

            
            <td class="description last">(optional) the custom timestamp as milliseconds since epoch.</td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type"><a href="Amplitude.html#~eventCallback">Amplitude~eventCallback</a></span>


            </td>

            
            <td class="description last">(optional) a callback function to run after the event is logged.
Note: the server response code and response body from the event upload are passed to the callback function.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line913">line 913</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>amplitudeClient.logEvent('Clicked Homepage Button', {'finished_flow': false, 'clicks': 15});</code></pre>


    <h4 class="name" id="logRevenue"><span class="type-signature"></span>logRevenue<span class="signature">(price, quantity, product)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Log revenue event with a price, quantity, and product identifier. DEPRECATED - use logRevenueV2
</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>price</code></td>
            

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


            </td>

            
            <td class="description last">price of revenue event</td>
        </tr>

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

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


            </td>

            
            <td class="description last">(optional) quantity of products in revenue event. If no quantity specified default to 1.</td>
        </tr>

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

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


            </td>

            
            <td class="description last">(optional) product identifier</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line997">line 997</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>amplitudeClient.logRevenue(3.99, 1, 'product_1234');</code></pre>


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

    
<div class="description">
    Log revenue with Revenue interface. The new revenue interface allows for more revenue fields like
revenueType and event properties.
See <a href="https://github.com/amplitude/Amplitude-Javascript#tracking-revenue">Readme</a>
for more information on the Revenue interface and logging revenue.
</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>revenue_obj</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Revenue.html">Revenue</a></span>


            </td>

            
            <td class="description last">the revenue object containing the revenue data being logged.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line968">line 968</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>var revenue = new amplitude.Revenue().setProductId('productIdentifier').setPrice(10.99);
amplitude.logRevenueV2(revenue);</code></pre>


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

    
<div class="description">
    Regenerates a new random deviceId for current user. Note: this is not recommended unless you know what you
are doing. This can be used in conjunction with `setUserId(null)` to anonymize users after they log out.
With a null userId and a completely new deviceId, the current user would appear as a brand new user in dashboard.
This uses src/uuid.js to regenerate the deviceId.
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line653">line 653</a>
    </li></ul></dd>
    

</dl>


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

    
<div class="description">
    Sets a custom deviceId for current user. Note: this is not recommended unless you know what you are doing
(like if you have your own system for managing deviceIds). Make sure the deviceId you set is sufficiently unique
(we recommend something like a UUID - see src/uuid.js for an example of how to generate) to prevent conflicts with other devices in our system.
</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>deviceId</code></td>
            

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


            </td>

            
            <td class="description last">custom deviceId for current user.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line665">line 665</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>amplitudeClient.setDeviceId('45f0954f-eb79-4463-ac8a-233a6f45a8f0');</code></pre>


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

    
<div class="description">
    Sets a customer domain for the amplitude cookie. Specified domain will include all subdomains. If you want to disable tracking for subdomains specify an empty string `''`, this will set cookies for the current domain only.
</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>domain</code></td>
            

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


            </td>

            
            <td class="description last">to set.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line570">line 570</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>amplitudeClient.setDomain('amplitude.com');</code></pre>


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

    
<div class="description">
    Set global user properties. Note this is deprecated, and we recommend using setUserProperties
</div>


<dl class="details">

    
        <dt class="important tag-deprecated">Deprecated:</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line1176">line 1176</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="setGroup"><span class="type-signature"></span>setGroup<span class="signature">(groupType, groupName)</span><span class="type-signature"></span></h4>

    
<div class="description">
    Add user to a group or groups. You need to specify a groupType and groupName(s).
For example you can group people by their organization.
In that case groupType is "orgId" and groupName would be the actual ID(s).
groupName can be a string or an array of strings to indicate a user in multiple gruups.
You can also call setGroup multiple times with different groupTypes to track multiple types of groups (up to 5 per app).
Note: this will also set groupType: groupName as a user property.
See the <a href="https://github.com/amplitude/Amplitude-Javascript#setting-groups">SDK Readme</a> for more 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>groupType</code></td>
            

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


            </td>

            
            <td class="description last">the group type (ex: orgId)</td>
        </tr>

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

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

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


            </td>

            
            <td class="description last">the name of the group (ex: 15), or a list of names of the groups</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

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

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>amplitudeClient.setGroup('orgId', 15); // this adds the current user to orgId 15.</code></pre>


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

    
<div class="description">
    Sets whether to opt current user out of tracking.
</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>enable</code></td>
            

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


            </td>

            
            <td class="description last">if true then no events will be logged or sent.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line633">line 633</a>
    </li></ul></dd>
    

</dl>


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

    
<div class="description">
    Sets an identifier for the current user.
</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>userId</code></td>
            

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


            </td>

            
            <td class="description last">identifier to set. Can be null.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line593">line 593</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>amplitudeClient.setUserId('joe@gmail.com');</code></pre>


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

    
<div class="description">
    Sets user properties for the current user.
</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>userProperties</code></td>
            

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


            </td>

            
            <td class="description last">object with string keys and values for the user properties to set.</td>
        </tr>

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

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


            </td>

            
            <td class="description last">DEPRECATED opt_replace: in earlier versions of the JS SDK the user properties object was kept in
memory and replace = true would replace the object in memory. Now the properties are no longer stored in memory, so replace is deprecated.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line688">line 688</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>amplitudeClient.setUserProperties({'gender': 'female', 'sign_up_complete': true})</code></pre>


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

    
<div class="description">
    Set a versionName for your application.
</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>versionName</code></td>
            

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


            </td>

            
            <td class="description last">The version to set for your application.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="amplitude-client.js.html">amplitude-client.js</a>, <a href="amplitude-client.js.html#line784">line 784</a>
    </li></ul></dd>
    

</dl>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>amplitudeClient.setVersionName('1.12.3');</code></pre>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude.html">Amplitude</a></li><li><a href="AmplitudeClient.html">AmplitudeClient</a></li><li><a href="Identify.html">Identify</a></li><li><a href="Revenue.html">Revenue</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Nov 08 2016 18:11:38 GMT-0800 (PST)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>