Skip to content

Commit ae572dd

Browse files
djihdjih
committed
hide saveEvents and sendEvents from docs
1 parent b9dbacd commit ae572dd

7 files changed

Lines changed: 16 additions & 232 deletions

File tree

‎amplitude.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -605,7 +605,7 @@ Amplitude.prototype._saveReferrer = function _saveReferrer(referrer) {
605605
/**
606606
* Saves unsent events and identifies to localStorage. JSON stringifies event queues before saving.
607607
* Note: this is called automatically every time events are logged, unless you explicitly set option saveEvents to false.
608-
* @public
608+
* @private
609609
*/
610610
Amplitude.prototype.saveEvents = function saveEvents() {
611611
if (!this._apiKeySet('saveEvents()')) {
@@ -746,7 +746,7 @@ Amplitude.prototype.clearUserProperties = function clearUserProperties(){
746746
* Send an identify call containing user property operations to Amplitude servers.
747747
* See [Readme]{@link https://github.com/amplitude/Amplitude-Javascript#user-properties-and-user-property-operations}
748748
* for more information on the Identify API and user property operations.
749-
* @param {Identify_object} identify_obj - the Identify object containing the user property operations to send.
749+
* @param {Identify} identify_obj - the Identify object containing the user property operations to send.
750750
* @param {function} opt_callback - (optional) callback function to run when the identify event has been sent.
751751
* Note: the server response code and response body from the identify event upload are passed to the callback function.
752752
* @example
@@ -894,7 +894,7 @@ Amplitude.prototype._limitEventsQueued = function _limitEventsQueued(queue) {
894894
* @param {string} eventType - name of event
895895
* @param {object} eventProperties - (optional) an object with string keys and values for the event properties.
896896
* @param {function} opt_callback - (optional) a callback function to run after the event is logged.
897-
* Note: the server response code and response body from the identify event upload are passed to the callback function.
897+
* Note: the server response code and response body from the event upload are passed to the callback function.
898898
* @example amplitude.logEvent('Clicked Homepage Button', {'finished_flow': false, 'clicks': 15});
899899
*/
900900
Amplitude.prototype.logEvent = function logEvent(eventType, eventProperties, opt_callback) {
@@ -970,7 +970,7 @@ var _removeEvents = function _removeEvents(scope, eventQueue, maxId) {
970970
/**
971971
* Send unsent events. Note: this is called automatically after events are logged if option batchEvents is false.
972972
* If batchEvents is true, then events are only sent when batch criterias are met.
973-
* @public
973+
* @private
974974
* @param {function} callback - (optional) callback to run after events are sent.
975975
* Note the server response code and response body are passed to the callback as input arguments.
976976
*/

‎documentation/Amplitude.html‎

Lines changed: 2 additions & 218 deletions
Original file line numberDiff line numberDiff line change
@@ -987,7 +987,7 @@ <h5>Parameters:</h5>
987987

988988

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

993993

@@ -1245,222 +1245,6 @@ <h5>Example</h5>
12451245

12461246

12471247

1248-
1249-
<h4 class="name" id="saveEvents"><span class="type-signature"></span>saveEvents<span class="signature">()</span><span class="type-signature"></span></h4>
1250-
1251-
1252-
1253-
1254-
1255-
<div class="description">
1256-
Saves unsent events and identifies to localStorage. JSON stringifies event queues before saving.
1257-
Note: this is called automatically every time events are logged, unless you explicitly set option saveEvents to false.
1258-
</div>
1259-
1260-
1261-
1262-
1263-
1264-
1265-
1266-
1267-
1268-
1269-
1270-
1271-
1272-
<dl class="details">
1273-
1274-
1275-
1276-
1277-
1278-
1279-
1280-
1281-
1282-
1283-
1284-
1285-
1286-
1287-
1288-
1289-
1290-
1291-
1292-
1293-
1294-
1295-
1296-
1297-
1298-
1299-
<dt class="tag-source">Source:</dt>
1300-
<dd class="tag-source"><ul class="dummy"><li>
1301-
<a href="amplitude.js.html">amplitude.js</a>, <a href="amplitude.js.html#line504">line 504</a>
1302-
</li></ul></dd>
1303-
1304-
1305-
1306-
1307-
1308-
1309-
1310-
</dl>
1311-
1312-
1313-
1314-
1315-
1316-
1317-
1318-
1319-
1320-
1321-
1322-
1323-
1324-
1325-
1326-
1327-
1328-
1329-
1330-
1331-
1332-
<h4 class="name" id="sendEvents"><span class="type-signature"></span>sendEvents<span class="signature">(callback)</span><span class="type-signature"></span></h4>
1333-
1334-
1335-
1336-
1337-
1338-
<div class="description">
1339-
Send unsent events. Note: this is called automatically after events are logged if option batchEvents is false.
1340-
If batchEvents is true, then events are only sent when batch criterias are met.
1341-
</div>
1342-
1343-
1344-
1345-
1346-
1347-
1348-
1349-
1350-
1351-
<h5>Parameters:</h5>
1352-
1353-
1354-
<table class="params">
1355-
<thead>
1356-
<tr>
1357-
1358-
<th>Name</th>
1359-
1360-
1361-
<th>Type</th>
1362-
1363-
1364-
1365-
1366-
1367-
<th class="last">Description</th>
1368-
</tr>
1369-
</thead>
1370-
1371-
<tbody>
1372-
1373-
1374-
<tr>
1375-
1376-
<td class="name"><code>callback</code></td>
1377-
1378-
1379-
<td class="type">
1380-
1381-
1382-
<span class="param-type">function</span>
1383-
1384-
1385-
1386-
</td>
1387-
1388-
1389-
1390-
1391-
1392-
<td class="description last">(optional) callback to run after events are sent.
1393-
Note the server response code and response body are passed to the callback as input arguments.</td>
1394-
</tr>
1395-
1396-
1397-
</tbody>
1398-
</table>
1399-
1400-
1401-
1402-
1403-
1404-
1405-
<dl class="details">
1406-
1407-
1408-
1409-
1410-
1411-
1412-
1413-
1414-
1415-
1416-
1417-
1418-
1419-
1420-
1421-
1422-
1423-
1424-
1425-
1426-
1427-
1428-
1429-
1430-
1431-
1432-
<dt class="tag-source">Source:</dt>
1433-
<dd class="tag-source"><ul class="dummy"><li>
1434-
<a href="amplitude.js.html">amplitude.js</a>, <a href="amplitude.js.html#line871">line 871</a>
1435-
</li></ul></dd>
1436-
1437-
1438-
1439-
1440-
1441-
1442-
1443-
</dl>
1444-
1445-
1446-
1447-
1448-
1449-
1450-
1451-
1452-
1453-
1454-
1455-
1456-
1457-
1458-
1459-
1460-
1461-
1462-
1463-
14641248

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

@@ -2400,7 +2184,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
24002184
<br class="clear">
24012185

24022186
<footer>
2403-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 04 2016 16:26:40 GMT-0700 (PDT)
2187+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 04 2016 16:51:56 GMT-0700 (PDT)
24042188
</footer>
24052189

24062190
<script> prettyPrint(); </script>

‎documentation/Identify.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1295,7 +1295,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
12951295
<br class="clear">
12961296

12971297
<footer>
1298-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 04 2016 16:26:40 GMT-0700 (PDT)
1298+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 04 2016 16:51:57 GMT-0700 (PDT)
12991299
</footer>
13001300

13011301
<script> prettyPrint(); </script>

‎documentation/amplitude.js.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ <h1 class="page-title">Source: amplitude.js</h1>
527527
/**
528528
* Saves unsent events and identifies to localStorage. JSON stringifies event queues before saving.
529529
* Note: this is called automatically every time events are logged, unless you explicitly set option saveEvents to false.
530-
* @public
530+
* @private
531531
*/
532532
Amplitude.prototype.saveEvents = function saveEvents() {
533533
if (!this._apiKeySet('saveEvents()')) {
@@ -816,7 +816,7 @@ <h1 class="page-title">Source: amplitude.js</h1>
816816
* @param {string} eventType - name of event
817817
* @param {object} eventProperties - (optional) an object with string keys and values for the event properties.
818818
* @param {function} opt_callback - (optional) a callback function to run after the event is logged.
819-
* Note: the server response code and response body from the identify event upload are passed to the callback function.
819+
* Note: the server response code and response body from the event upload are passed to the callback function.
820820
* @example amplitude.logEvent('Clicked Homepage Button', {'finished_flow': false, 'clicks': 15});
821821
*/
822822
Amplitude.prototype.logEvent = function logEvent(eventType, eventProperties, opt_callback) {
@@ -892,7 +892,7 @@ <h1 class="page-title">Source: amplitude.js</h1>
892892
/**
893893
* Send unsent events. Note: this is called automatically after events are logged if option batchEvents is false.
894894
* If batchEvents is true, then events are only sent when batch criterias are met.
895-
* @public
895+
* @private
896896
* @param {function} callback - (optional) callback to run after events are sent.
897897
* Note the server response code and response body are passed to the callback as input arguments.
898898
*/
@@ -1053,7 +1053,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
10531053
<br class="clear">
10541054

10551055
<footer>
1056-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 04 2016 16:26:40 GMT-0700 (PDT)
1056+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 04 2016 16:51:56 GMT-0700 (PDT)
10571057
</footer>
10581058

10591059
<script> prettyPrint(); </script>

‎documentation/identify.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
226226
<br class="clear">
227227

228228
<footer>
229-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 04 2016 16:26:40 GMT-0700 (PDT)
229+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 04 2016 16:51:56 GMT-0700 (PDT)
230230
</footer>
231231

232232
<script> prettyPrint(); </script>

‎documentation/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
5656
<br class="clear">
5757

5858
<footer>
59-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 04 2016 16:26:40 GMT-0700 (PDT)
59+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Apr 04 2016 16:51:56 GMT-0700 (PDT)
6060
</footer>
6161

6262
<script> prettyPrint(); </script>

‎src/amplitude.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@ Amplitude.prototype._saveReferrer = function _saveReferrer(referrer) {
499499
/**
500500
* Saves unsent events and identifies to localStorage. JSON stringifies event queues before saving.
501501
* Note: this is called automatically every time events are logged, unless you explicitly set option saveEvents to false.
502-
* @public
502+
* @private
503503
*/
504504
Amplitude.prototype.saveEvents = function saveEvents() {
505505
if (!this._apiKeySet('saveEvents()')) {
@@ -788,7 +788,7 @@ Amplitude.prototype._limitEventsQueued = function _limitEventsQueued(queue) {
788788
* @param {string} eventType - name of event
789789
* @param {object} eventProperties - (optional) an object with string keys and values for the event properties.
790790
* @param {function} opt_callback - (optional) a callback function to run after the event is logged.
791-
* Note: the server response code and response body from the identify event upload are passed to the callback function.
791+
* Note: the server response code and response body from the event upload are passed to the callback function.
792792
* @example amplitude.logEvent('Clicked Homepage Button', {'finished_flow': false, 'clicks': 15});
793793
*/
794794
Amplitude.prototype.logEvent = function logEvent(eventType, eventProperties, opt_callback) {
@@ -864,7 +864,7 @@ var _removeEvents = function _removeEvents(scope, eventQueue, maxId) {
864864
/**
865865
* Send unsent events. Note: this is called automatically after events are logged if option batchEvents is false.
866866
* If batchEvents is true, then events are only sent when batch criterias are met.
867-
* @public
867+
* @private
868868
* @param {function} callback - (optional) callback to run after events are sent.
869869
* Note the server response code and response body are passed to the callback as input arguments.
870870
*/

0 commit comments

Comments
 (0)