You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Send an identify call containing user property operations to Amplitude servers.
347
-
See <ahref="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.
347
+
See <ahref="https://github.com/amplitude/Amplitude-Javascript#user-properties-and-user-property-operations">Readme</a>
348
+
for more information on the Identify API and user property operations.
348
349
</div>
349
350
350
351
@@ -419,7 +420,8 @@ <h5>Parameters:</h5>
419
420
420
421
421
422
422
-
<tdclass="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>
423
+
<tdclass="description last">(optional) callback function to run when the identify event has been sent.
424
+
Note: the server response code and response body from the identify event upload are passed to the callback function.</td>
<tdclass="description last">(optional) Configuration options. See <ahref="https://github.com/amplitude/Amplitude-Javascript#configuration-options">Readme</a> for list of options and default values.</td>
<tdclass="description last">(optional) a callback function to run after the event is logged. Note: the server response code and response body from the identify event upload are passed to the callback function.</td>
918
+
<tdclass="description last">(optional) a callback function to run after the event is logged.
919
+
Note: the server response code and response body from the identify event upload are passed to the callback function.</td>
Send unsent events. Note: this is called automatically after events are logged if option batchEvents is false. If batchEvents is true, then events are only sent when batch criterias are met.
1268
+
Send unsent events. Note: this is called automatically after events are logged if option batchEvents is false.
1269
+
If batchEvents is true, then events are only sent when batch criterias are met.
1265
1270
</div>
1266
1271
1267
1272
@@ -1313,7 +1318,8 @@ <h5>Parameters:</h5>
1313
1318
1314
1319
1315
1320
1316
-
<tdclass="description last">(optional) callback to run after events are sent. Note the server response code and response body are passed to the callback as input arguments.</td>
1321
+
<tdclass="description last">(optional) callback to run after events are sent.
1322
+
Note the server response code and response body are passed to the callback as input arguments.</td>
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.
1401
+
Sets a custom deviceId for current user. Note: this is not recommended unless you know what you are doing
1402
+
(like if you have your own system for managing deviceIds). Make sure the deviceId you set is sufficiently unique
1403
+
(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.
<tdclass="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>
2101
+
<tdclass="description last">DEPRECATED opt_replace: in earlier versions of the JS SDK the user properties object was kept in
2102
+
memory and replace = true would replace the object in memory. Now the properties are no longer stored in memory, so replace is deprecated.</td>
Increment a user property by a given value (can also be negative to decrement). If the user property does not have a value set yet, it will be initialized to 0 before being incremented.
161
+
Increment a user property by a given value (can also be negative to decrement).
162
+
If the user property does not have a value set yet, it will be initialized to 0 before being incremented.
@@ -923,7 +932,8 @@ <h4 class="name" id="setOnce"><span class="type-signature"></span>setOnce<span c
923
932
924
933
925
934
<divclass="description">
926
-
Sets the value of a given user property only once. Subsequent setOnce operations on that user property will be ignored; however, that user property can still be modified through any of the other operations.
935
+
Sets the value of a given user property only once. Subsequent setOnce operations on that user property will be ignored;
936
+
however, that user property can still be modified through any of the other operations.
927
937
Useful for capturing properties such as 'initial_signup_date', 'initial_referrer', etc.
928
938
</div>
929
939
@@ -1008,7 +1018,8 @@ <h5>Parameters:</h5>
1008
1018
1009
1019
1010
1020
1011
-
<tdclass="description last">A value or values to set once. Values can be numbers, strings, lists, or object (key:value dict will be flattened).</td>
1021
+
<tdclass="description last">A value or values to set once.
1022
+
Values can be numbers, strings, lists, or object (key:value dict will be flattened).</td>
0 commit comments