Android docs: Update for release 3.3.3

polarofficial · Sep 23, 2022 · 7e75ade · 7e75ade
1 parent 39ca0d0
commit 7e75ade
Show file tree

Hide file tree

Showing 8 changed files with 250 additions and 17 deletions.
diff --git a/polar-sdk-android/docs/html/allclasses.html b/polar-sdk-android/docs/html/allclasses.html
@@ -49,12 +49,12 @@ <h1 class="bar">All Classes</h1>
 
             <li><a href=com/polar/sdk/api/model/PolarHrData.html>PolarHrData</a></li>
 
-            <li><a href=com/polar/sdk/api/model/PolarDeviceInfo.html>PolarDeviceInfo</a></li>
-
             <li><a href=com/polar/sdk/api/model/PolarOhrPPIData.html>PolarOhrPPIData</a></li>
 
             <li><a href=com/polar/sdk/api/model/PolarDataUtils.html>PolarDataUtils</a></li>
 
+            <li><a href=com/polar/sdk/api/model/PolarDeviceInfo.html>PolarDeviceInfo</a></li>
+
             <li><a href=com/polar/sdk/api/errors/PolarDeviceNotFound.html>PolarDeviceNotFound</a></li>
 
             <li><a href=com/polar/sdk/api/errors/PolarDeviceDisconnected.html>PolarDeviceDisconnected</a></li>

diff --git a/polar-sdk-android/docs/html/com/polar/sdk/api/model/PolarDeviceInfo.html b/polar-sdk-android/docs/html/com/polar/sdk/api/model/PolarDeviceInfo.html
diff --git a/polar-sdk-android/docs/html/com/polar/sdk/api/model/package-summary.html b/polar-sdk-android/docs/html/com/polar/sdk/api/model/package-summary.html
@@ -145,11 +145,11 @@ <h1 title="Package" class="title">Package com.polar.sdk.api.model </h1>
 
     <tr class="altColor"><th class="colFirst" scope="row"><a href=PolarHrData.html>PolarHrData</a></th><td class="colLast">For heart rate data.</td></tr>
 
-    <tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarDeviceInfo.html>PolarDeviceInfo</a></th><td class="colLast">Contains information about the current Device.</td></tr>
+    <tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOhrPPIData.PolarOhrPPISample.html>PolarOhrPPISample</a></th><td class="colLast"></td></tr>
 
-    <tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOhrPPIData.PolarOhrPPISample.html>PolarOhrPPISample</a></th><td class="colLast"></td></tr>
+    <tr class="altColor"><th class="colFirst" scope="row"><a href=PolarOhrPPIData.html>PolarOhrPPIData</a></th><td class="colLast">Class PolarOhrPPIData is used to output the peak-to-peak interval between heartbeats in milliseconds</td></tr>
 
-    <tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarOhrPPIData.html>PolarOhrPPIData</a></th><td class="colLast">Class PolarOhrPPIData is used to output the peak-to-peak interval between heartbeats in milliseconds</td></tr>
+    <tr class="rowColor"><th class="colFirst" scope="row"><a href=PolarDeviceInfo.html>PolarDeviceInfo</a></th><td class="colLast">Contains information about the current Device.</td></tr>
 </tbody>
 </table>
 

diff --git a/polar-sdk-android/docs/html/com/polar/sdk/impl/BDBleApiImpl.html b/polar-sdk-android/docs/html/com/polar/sdk/impl/BDBleApiImpl.html
@@ -702,7 +702,7 @@ <h4>requestFullStreamSettings</h4>
                                           >
                                     <li class="blockList">
                                         <h4>backgroundEntered</h4>
-                                        <pre class="methodSignature"> <a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>Unit</a> <a href=BDBleApiImpl.html#backgroundEntered()>backgroundEntered</a>()</pre>
+                                        <pre class="methodSignature">@<a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-deprecated/index.html>Deprecated</a>(message = in release 3.2.8. Move to the background is not relevant information for SDK starting from release 3.2.8) <a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>Unit</a> <a href=BDBleApiImpl.html#backgroundEntered()>backgroundEntered</a>()</pre>
                                         <div class="block"></div>
 
                                         <!-- TODO missing return annotation -->

diff --git a/polar-sdk-android/docs/html/deprecated.html b/polar-sdk-android/docs/html/deprecated.html
@@ -116,6 +116,13 @@ <h2 title="Contents">Contents</h2>
                                     <td class="colLast">enables scan filter while on background</td>
                                 </tr>
 
+                                <tr class="rowColor">
+                                    <th class="colDeprecatedItemName" scope="row">
+                                        <a href="com/polar/sdk/impl/BDBleApiImpl.html#backgroundEntered()">com.polar.sdk.impl.backgroundEntered()</a>
+                                    </th>
+                                    <td class="colLast"></td>
+                                </tr>
+
                         </table>
                     </div>
                 </li>

diff --git a/polar-sdk-android/docs/html/index-files/index-7.html b/polar-sdk-android/docs/html/index-files/index-7.html
@@ -134,6 +134,19 @@
         <h2 class="title">G</h2>
         <dl>
 
+            <dt>
+
+                <span class="memberNameLink">
+
+                    <a href="../com/polar/sdk/api/model/PolarDeviceInfo.html#getAddress()">getAddress()</a>
+
+                </span> - function in com.polar.sdk.api.model.<a href=../com/polar/sdk/api/model/PolarDeviceInfo.html>PolarDeviceInfo</a>
+
+
+            </dt>
+            <dd>Bt mac address</dd>
+
+
             <dt>
 
                 <span class="memberNameLink">
@@ -238,6 +251,19 @@ <h2 class="title">G</h2>
             <dd>&nbsp;</dd>
 
 
+            <dt>
+
+                <span class="memberNameLink">
+
+                    <a href="../com/polar/sdk/api/model/PolarDeviceInfo.html#getDeviceId()">getDeviceId()</a>
+
+                </span> - function in com.polar.sdk.api.model.<a href=../com/polar/sdk/api/model/PolarDeviceInfo.html>PolarDeviceInfo</a>
+
+
+            </dt>
+            <dd>Polar device id</dd>
+
+
             <dt>
 
                 <span class="memberNameLink">
@@ -251,6 +277,19 @@ <h2 class="title">G</h2>
             <dd>&nbsp;</dd>
 
 
+            <dt>
+
+                <span class="memberNameLink">
+
+                    <a href="../com/polar/sdk/api/model/PolarDeviceInfo.html#getIsConnectable()">getIsConnectable()</a>
+
+                </span> - function in com.polar.sdk.api.model.<a href=../com/polar/sdk/api/model/PolarDeviceInfo.html>PolarDeviceInfo</a>
+
+
+            </dt>
+            <dd>true adv type is connectable</dd>
+
+
             <dt>
 
                 <span class="memberNameLink">
@@ -459,6 +498,19 @@ <h2 class="title">G</h2>
             <dd>&nbsp;</dd>
 
 
+            <dt>
+
+                <span class="memberNameLink">
+
+                    <a href="../com/polar/sdk/api/model/PolarDeviceInfo.html#getName()">getName()</a>
+
+                </span> - function in com.polar.sdk.api.model.<a href=../com/polar/sdk/api/model/PolarDeviceInfo.html>PolarDeviceInfo</a>
+
+
+            </dt>
+            <dd>Device name.</dd>
+
+
             <dt>
 
                 <span class="memberNameLink">
@@ -472,6 +524,19 @@ <h2 class="title">G</h2>
             <dd>&nbsp;</dd>
 
 
+            <dt>
+
+                <span class="memberNameLink">
+
+                    <a href="../com/polar/sdk/api/model/PolarDeviceInfo.html#getRssi()">getRssi()</a>
+
+                </span> - function in com.polar.sdk.api.model.<a href=../com/polar/sdk/api/model/PolarDeviceInfo.html>PolarDeviceInfo</a>
+
+
+            </dt>
+            <dd>Received signal strength indication value in dBm.</dd>
+
+
             <dt>
 
                 <span class="memberNameLink">

diff --git a/polar-sdk-android/docs/html/member-search-index.js b/polar-sdk-android/docs/html/member-search-index.js
diff --git a/polar-sdk-android/docs/html/type-search-index.js b/polar-sdk-android/docs/html/type-search-index.js