Merge pull request #12 from kissmetrics/record-per-id

Adds an optional RecordCondition parameter to the ```record()``` method. RecordConditions include ```RECORD_ALWAYS``` (default), ```RECORD_ONCE_PER_INSTALL``` and ```RECORD_ONCE_PER_IDENTITY```. Deprecates ```recordOnce()```, which was the equivalent to using ```RECORD_ONCE_PER_IDENTITY```.
kissmetrics · Aug 5, 2014 · bee35d6 · bee35d6
2 parents d4a5855 + b06b578
commit bee35d6
Show file tree

Hide file tree

Showing 64 changed files with 10,000 additions and 265 deletions.
diff --git a/KISSmetricsAPI/doc/allclasses-frame.html b/KISSmetricsAPI/doc/allclasses-frame.html
@@ -2,16 +2,30 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_40) on Thu Apr 24 17:01:40 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_40) on Tue Jul 22 13:26:47 PDT 2014 -->
 <title>All Classes</title>
-<meta name="date" content="2014-04-24">
+<meta name="date" content="2014-07-22">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>
 <h1 class="bar">All Classes</h1>
 <div class="indexContainer">
 <ul>
 <li><a href="com/kissmetrics/sdk/Archiver.html" title="interface in com.kissmetrics.sdk" target="classFrame"><i>Archiver</i></a></li>
+<li><a href="com/kissmetrics/sdk/ArchiverImpl.html" title="class in com.kissmetrics.sdk" target="classFrame">ArchiverImpl</a></li>
+<li><a href="com/kissmetrics/sdk/ConnectionDelegate.html" title="interface in com.kissmetrics.sdk" target="classFrame"><i>ConnectionDelegate</i></a></li>
+<li><a href="com/kissmetrics/sdk/ConnectionImpl.html" title="class in com.kissmetrics.sdk" target="classFrame">ConnectionImpl</a></li>
+<li><a href="com/kissmetrics/sdk/KISSmetricsAPI.html" title="class in com.kissmetrics.sdk" target="classFrame">KISSmetricsAPI</a></li>
+<li><a href="com/kissmetrics/sdk/KISSmetricsAPI.RecordCondition.html" title="enum in com.kissmetrics.sdk" target="classFrame">KISSmetricsAPI.RecordCondition</a></li>
+<li><a href="com/kissmetrics/sdk/QueryEncoder.html" title="class in com.kissmetrics.sdk" target="classFrame">QueryEncoder</a></li>
+<li><a href="com/kissmetrics/sdk/Sender.html" title="class in com.kissmetrics.sdk" target="classFrame">Sender</a></li>
+<li><a href="com/kissmetrics/sdk/SenderDisabledState.html" title="class in com.kissmetrics.sdk" target="classFrame">SenderDisabledState</a></li>
+<li><a href="com/kissmetrics/sdk/SenderReadyState.html" title="class in com.kissmetrics.sdk" target="classFrame">SenderReadyState</a></li>
+<li><a href="com/kissmetrics/sdk/SenderSendingState.html" title="class in com.kissmetrics.sdk" target="classFrame">SenderSendingState</a></li>
+<li><a href="com/kissmetrics/sdk/SenderState.html" title="interface in com.kissmetrics.sdk" target="classFrame"><i>SenderState</i></a></li>
+<li><a href="com/kissmetrics/sdk/TrackingRunnables.html" title="interface in com.kissmetrics.sdk" target="classFrame"><i>TrackingRunnables</i></a></li>
+<li><a href="com/kissmetrics/sdk/TrackingRunnablesNonTrackingState.html" title="class in com.kissmetrics.sdk" target="classFrame">TrackingRunnablesNonTrackingState</a></li>
+<li><a href="com/kissmetrics/sdk/TrackingRunnablesTrackingState.html" title="class in com.kissmetrics.sdk" target="classFrame">TrackingRunnablesTrackingState</a></li>
 </ul>
 </div>
 </body>

diff --git a/KISSmetricsAPI/doc/allclasses-noframe.html b/KISSmetricsAPI/doc/allclasses-noframe.html
@@ -2,16 +2,30 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_40) on Thu Apr 24 17:01:40 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_40) on Tue Jul 22 13:26:47 PDT 2014 -->
 <title>All Classes</title>
-<meta name="date" content="2014-04-24">
+<meta name="date" content="2014-07-22">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 </head>
 <body>
 <h1 class="bar">All Classes</h1>
 <div class="indexContainer">
 <ul>
 <li><a href="com/kissmetrics/sdk/Archiver.html" title="interface in com.kissmetrics.sdk"><i>Archiver</i></a></li>
+<li><a href="com/kissmetrics/sdk/ArchiverImpl.html" title="class in com.kissmetrics.sdk">ArchiverImpl</a></li>
+<li><a href="com/kissmetrics/sdk/ConnectionDelegate.html" title="interface in com.kissmetrics.sdk"><i>ConnectionDelegate</i></a></li>
+<li><a href="com/kissmetrics/sdk/ConnectionImpl.html" title="class in com.kissmetrics.sdk">ConnectionImpl</a></li>
+<li><a href="com/kissmetrics/sdk/KISSmetricsAPI.html" title="class in com.kissmetrics.sdk">KISSmetricsAPI</a></li>
+<li><a href="com/kissmetrics/sdk/KISSmetricsAPI.RecordCondition.html" title="enum in com.kissmetrics.sdk">KISSmetricsAPI.RecordCondition</a></li>
+<li><a href="com/kissmetrics/sdk/QueryEncoder.html" title="class in com.kissmetrics.sdk">QueryEncoder</a></li>
+<li><a href="com/kissmetrics/sdk/Sender.html" title="class in com.kissmetrics.sdk">Sender</a></li>
+<li><a href="com/kissmetrics/sdk/SenderDisabledState.html" title="class in com.kissmetrics.sdk">SenderDisabledState</a></li>
+<li><a href="com/kissmetrics/sdk/SenderReadyState.html" title="class in com.kissmetrics.sdk">SenderReadyState</a></li>
+<li><a href="com/kissmetrics/sdk/SenderSendingState.html" title="class in com.kissmetrics.sdk">SenderSendingState</a></li>
+<li><a href="com/kissmetrics/sdk/SenderState.html" title="interface in com.kissmetrics.sdk"><i>SenderState</i></a></li>
+<li><a href="com/kissmetrics/sdk/TrackingRunnables.html" title="interface in com.kissmetrics.sdk"><i>TrackingRunnables</i></a></li>
+<li><a href="com/kissmetrics/sdk/TrackingRunnablesNonTrackingState.html" title="class in com.kissmetrics.sdk">TrackingRunnablesNonTrackingState</a></li>
+<li><a href="com/kissmetrics/sdk/TrackingRunnablesTrackingState.html" title="class in com.kissmetrics.sdk">TrackingRunnablesTrackingState</a></li>
 </ul>
 </div>
 </body>

diff --git a/KISSmetricsAPI/doc/com/kissmetrics/sdk/Archiver.html b/KISSmetricsAPI/doc/com/kissmetrics/sdk/Archiver.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_40) on Thu Apr 24 17:01:40 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_40) on Tue Jul 22 13:26:46 PDT 2014 -->
 <title>Archiver</title>
-<meta name="date" content="2014-04-24">
+<meta name="date" content="2014-07-22">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 </head>
 <body>
@@ -36,7 +36,7 @@
 <div class="subNav">
 <ul class="navList">
 <li>Prev Class</li>
-<li>Next Class</li>
+<li><a href="../../../com/kissmetrics/sdk/ArchiverImpl.html" title="class in com.kissmetrics.sdk"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../index.html?com/kissmetrics/sdk/Archiver.html" target="_top">Frames</a></li>
@@ -85,6 +85,10 @@ <h2 title="Interface Archiver" class="title">Interface Archiver</h2>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../com/kissmetrics/sdk/ArchiverImpl.html" title="class in com.kissmetrics.sdk">ArchiverImpl</a></dd>
+</dl>
 <hr>
 <br>
 <pre>public interface <span class="strong">Archiver</span></pre>
@@ -131,90 +135,87 @@ <h3>Method Summary</h3>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveEvent(java.lang.String, java.util.HashMap)">archiveEvent</a></strong>(java.lang.String&nbsp;name,
-            java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;properties)</code>&nbsp;</td>
+<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveEvent(java.lang.String, java.util.HashMap, com.kissmetrics.sdk.KISSmetricsAPI.RecordCondition)">archiveEvent</a></strong>(java.lang.String&nbsp;name,
+            java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;properties,
+            <a href="../../../com/kissmetrics/sdk/KISSmetricsAPI.RecordCondition.html" title="enum in com.kissmetrics.sdk">KISSmetricsAPI.RecordCondition</a>&nbsp;condition)</code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveEventOnce(java.lang.String)">archiveEventOnce</a></strong>(java.lang.String&nbsp;name)</code>&nbsp;</td>
+<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveFirstIdentity(java.lang.String)">archiveFirstIdentity</a></strong>(java.lang.String&nbsp;identity)</code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveFirstIdentity(java.lang.String)">archiveFirstIdentity</a></strong>(java.lang.String&nbsp;identity)</code>&nbsp;</td>
+<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveHasGenericIdentity(boolean)">archiveHasGenericIdentity</a></strong>(boolean&nbsp;hasGenericIdentity)</code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveHasGenericIdentity(boolean)">archiveHasGenericIdentity</a></strong>(boolean&nbsp;hasGenericIdentity)</code>&nbsp;</td>
+<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveIdentity(java.lang.String)">archiveIdentity</a></strong>(java.lang.String&nbsp;identity)</code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveIdentity(java.lang.String)">archiveIdentity</a></strong>(java.lang.String&nbsp;identity)</code>&nbsp;</td>
+<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveInstallUuid(java.lang.String)">archiveInstallUuid</a></strong>(java.lang.String&nbsp;installUuid)</code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveInstallUuid(java.lang.String)">archiveInstallUuid</a></strong>(java.lang.String&nbsp;installUuid)</code>&nbsp;</td>
+<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveProperties(java.util.HashMap)">archiveProperties</a></strong>(java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;properties)</code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveProperties(java.util.HashMap)">archiveProperties</a></strong>(java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;properties)</code>&nbsp;</td>
+<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveVerificationExpDate(long)">archiveVerificationExpDate</a></strong>(long&nbsp;expDate)</code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#archiveVerificationExpDate(long)">archiveVerificationExpDate</a></strong>(long&nbsp;expDate)</code>&nbsp;</td>
+<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#clearSavedIdEvents()">clearSavedIdEvents</a></strong>()</code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#clearSavedEvents()">clearSavedEvents</a></strong>()</code>&nbsp;</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#clearSavedProperties()">clearSavedProperties</a></strong>()</code>&nbsp;</td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#clearSendQueue()">clearSendQueue</a></strong>()</code>&nbsp;</td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#getAppVersion()">getAppVersion</a></strong>()</code>&nbsp;</td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#getBaseUrl()">getBaseUrl</a></strong>()</code>&nbsp;</td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#getDoSend()">getDoSend</a></strong>()</code>&nbsp;</td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#getDoTrack()">getDoTrack</a></strong>()</code>&nbsp;</td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#getIdentity()">getIdentity</a></strong>()</code>&nbsp;</td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#getInstallUuid()">getInstallUuid</a></strong>()</code>&nbsp;</td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#getQueryString(int)">getQueryString</a></strong>(int&nbsp;index)</code>&nbsp;</td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#getQueueCount()">getQueueCount</a></strong>()</code>&nbsp;</td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>long</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#getVerificationExpDate()">getVerificationExpDate</a></strong>()</code>&nbsp;</td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#hasGenericIdentity()">hasGenericIdentity</a></strong>()</code>&nbsp;</td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../com/kissmetrics/sdk/Archiver.html#removeQueryString(int)">removeQueryString</a></strong>(int&nbsp;index)</code>&nbsp;</td>
 </tr>
@@ -296,23 +297,15 @@ <h4>archiveFirstIdentity</h4>
 <pre>void&nbsp;archiveFirstIdentity(java.lang.String&nbsp;identity)</pre>
 </li>
 </ul>
-<a name="archiveEvent(java.lang.String, java.util.HashMap)">
+<a name="archiveEvent(java.lang.String, java.util.HashMap, com.kissmetrics.sdk.KISSmetricsAPI.RecordCondition)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>archiveEvent</h4>
 <pre>void&nbsp;archiveEvent(java.lang.String&nbsp;name,
-                java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;properties)</pre>
-</li>
-</ul>
-<a name="archiveEventOnce(java.lang.String)">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>archiveEventOnce</h4>
-<pre>void&nbsp;archiveEventOnce(java.lang.String&nbsp;name)</pre>
+                java.util.HashMap&lt;java.lang.String,java.lang.String&gt;&nbsp;properties,
+                <a href="../../../com/kissmetrics/sdk/KISSmetricsAPI.RecordCondition.html" title="enum in com.kissmetrics.sdk">KISSmetricsAPI.RecordCondition</a>&nbsp;condition)</pre>
 </li>
 </ul>
 <a name="archiveProperties(java.util.HashMap)">
@@ -362,13 +355,13 @@ <h4>clearSendQueue</h4>
 <pre>void&nbsp;clearSendQueue()</pre>
 </li>
 </ul>
-<a name="clearSavedEvents()">
+<a name="clearSavedIdEvents()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
-<h4>clearSavedEvents</h4>
-<pre>void&nbsp;clearSavedEvents()</pre>
+<h4>clearSavedIdEvents</h4>
+<pre>void&nbsp;clearSavedIdEvents()</pre>
 </li>
 </ul>
 <a name="clearSavedProperties()">
@@ -505,7 +498,7 @@ <h4>getDoTrack</h4>
 <div class="subNav">
 <ul class="navList">
 <li>Prev Class</li>
-<li>Next Class</li>
+<li><a href="../../../com/kissmetrics/sdk/ArchiverImpl.html" title="class in com.kissmetrics.sdk"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../index.html?com/kissmetrics/sdk/Archiver.html" target="_top">Frames</a></li>