Skip to content

Commit

Permalink
Android docs: Prepare for the 3.2.9 release
Browse files Browse the repository at this point in the history
  • Loading branch information
@JOikarinen
JOikarinen committed Feb 28, 2022
1 parent d843121 commit d9fe31b
Show file tree
Hide file tree
Showing 7 changed files with 74 additions and 49 deletions.
34 changes: 17 additions & 17 deletions polar-sdk-android/docs/html/com/polar/sdk/api/PolarBleApi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ <h3>Method Summary</h3>
</td>
<th class="colSecond" scope="row"><code><a href=PolarBleApi.html#setPolarFilter(boolean)>setPolarFilter</a>(boolean enable) </code>
</th>
<td class="colLast"></td>
<td class="colLast">When enabled only Polar devices are found by the <a href=PolarBleApi.html#searchForDevice()>searchForDevice</a>, if set to falseany BLE devices with HR services are returned by the <a href=PolarBleApi.html#searchForDevice()>searchForDevice</a>.</td>
</tr>

<tr id="i4" class="altColor">
Expand All @@ -305,7 +305,7 @@ <h3>Method Summary</h3>
</td>
<th class="colSecond" scope="row"><code><a href=PolarBleApi.html#foregroundEntered()>foregroundEntered</a>() </code>
</th>
<td class="colLast">disables scan filter while on foreground</td>
<td class="colLast">Optionally call when application enters to the foreground.</td>
</tr>

<tr id="i7" class="rowColor">
Expand All @@ -329,7 +329,7 @@ <h3>Method Summary</h3>
</td>
<th class="colSecond" scope="row"><code><a href=PolarBleApi.html#setAutomaticReconnection(boolean)>setAutomaticReconnection</a>(boolean enable) </code>
</th>
<td class="colLast">Enable or disable automatic reconnection feature</td>
<td class="colLast">When enabled the reconnection is attempted if device connection is lost.</td>
</tr>

<tr id="i10" class="altColor">
Expand Down Expand Up @@ -377,15 +377,15 @@ <h3>Method Summary</h3>
</td>
<th class="colSecond" scope="row"><code><a href=PolarBleApi.html#connectToDevice(String)>connectToDevice</a>(@<a href=https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html>NonNull</a>() <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> identifier) </code>
</th>
<td class="colLast">Request a connection to a Polar device.</td>
<td class="colLast">Request a connection to a BLE device.</td>
</tr>

<tr id="i16" class="altColor">
<td class="colFirst"><code>abstract void</code>
</td>
<th class="colSecond" scope="row"><code><a href=PolarBleApi.html#disconnectFromDevice(String)>disconnectFromDevice</a>(@<a href=https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html>NonNull</a>() <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> identifier) </code>
</th>
<td class="colLast">Request disconnecting from a Polar device.</td>
<td class="colLast">Request disconnecting from a BLE device.</td>
</tr>

<tr id="i17" class="rowColor">
Expand Down Expand Up @@ -441,15 +441,15 @@ <h3>Method Summary</h3>
</td>
<th class="colSecond" scope="row"><code><a href=PolarBleApi.html#searchForDevice()>searchForDevice</a>() </code>
</th>
<td class="colLast">Start searching for device(s)</td>
<td class="colLast">Starts searching for BLE devices when subscribed.</td>
</tr>

<tr id="i24" class="altColor">
<td class="colFirst"><code>abstract Flowable&lt;<a href=model/PolarHrBroadcastData.html>PolarHrBroadcastData</a>&gt;</code>
</td>
<th class="colSecond" scope="row"><code><a href=PolarBleApi.html#startListenForPolarHrBroadcasts(Set)>startListenForPolarHrBroadcasts</a>(@<a href=https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html>Nullable</a>() <a href=https://developer.android.com/reference/kotlin/java/util/Set.html>Set</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; deviceIds) </code>
</th>
<td class="colLast">Start listening to heart rate broadcasts from one or more Polar devices</td>
<td class="colLast">Start listening the heart rate from Polar devices when subscribed.</td>
</tr>

<tr id="i25" class="rowColor">
Expand Down Expand Up @@ -612,13 +612,13 @@ <h4>cleanup</h4>
<li class="blockList">
<h4>setPolarFilter</h4>
<pre class="methodSignature"> abstract void <a href=PolarBleApi.html#setPolarFilter(boolean)>setPolarFilter</a>(boolean enable)</pre>
<div class="block"></div>
<div class="block"><p>When enabled only Polar devices are found by the <a href=PolarBleApi.html#searchForDevice()>searchForDevice</a>, if set to falseany BLE devices with HR services are returned by the <a href=PolarBleApi.html#searchForDevice()>searchForDevice</a>. The default setting forPolar filter is true.</p></div>

<dl>
<dt><span class="paramLabel">Parameters:</span></dt>


<dd><code>enable</code> - false disable polar filter which means in all apis identifier can be bt address too</dd>
<dd><code>enable</code> - false disables polar filter</dd>


</dl>
Expand Down Expand Up @@ -663,7 +663,7 @@ <h4>isFeatureReady</h4>
>
<li class="blockList">
<h4>backgroundEntered</h4>
<pre class="methodSignature"> abstract void <a href=PolarBleApi.html#backgroundEntered()>backgroundEntered</a>()</pre>
<pre class="methodSignature">@<a href=https://developer.android.com/reference/kotlin/java/lang/Deprecated.html>Deprecated</a>() abstract void <a href=PolarBleApi.html#backgroundEntered()>backgroundEntered</a>()</pre>
<div class="block"><p>enables scan filter while on background</p></div>

<!-- TODO missing return annotation -->
Expand All @@ -679,7 +679,7 @@ <h4>backgroundEntered</h4>
<li class="blockList">
<h4>foregroundEntered</h4>
<pre class="methodSignature"> abstract void <a href=PolarBleApi.html#foregroundEntered()>foregroundEntered</a>()</pre>
<div class="block"><p>disables scan filter while on foreground</p></div>
<div class="block"><p>Optionally call when application enters to the foreground. By calling foregroundEntered() you makesure BLE scan is restarted. BLE scan start is not working when Android device display is off(related to Android power save). By calling foregroundEntered() helps in some rare situationse.g. if connection is lost to the device and <a href=PolarBleApi.html#setAutomaticReconnection(boolean)>setAutomaticReconnection</a> is enabled,reconnection is created when application is back in foreground.</p></div>

<!-- TODO missing return annotation -->
</li>
Expand Down Expand Up @@ -742,7 +742,7 @@ <h4>setApiLogger</h4>
<li class="blockList">
<h4>setAutomaticReconnection</h4>
<pre class="methodSignature"> abstract void <a href=PolarBleApi.html#setAutomaticReconnection(boolean)>setAutomaticReconnection</a>(boolean enable)</pre>
<div class="block"><p>Enable or disable automatic reconnection feature</p></div>
<div class="block"><p>When enabled the reconnection is attempted if device connection is lost. By default automatic reconnection is enabled.</p></div>

<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
Expand Down Expand Up @@ -905,7 +905,7 @@ <h4>autoConnectToDevice</h4>
<li class="blockList">
<h4>connectToDevice</h4>
<pre class="methodSignature"> abstract void <a href=PolarBleApi.html#connectToDevice(String)>connectToDevice</a>(@<a href=https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html>NonNull</a>() <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> identifier)</pre>
<div class="block"><p>Request a connection to a Polar device. Invokes <a href=PolarBleApiCallback.html#deviceConnected(PolarDeviceInfo)>deviceConnected</a> callback.</p></div>
<div class="block"><p>Request a connection to a BLE device. Invokes <a href=PolarBleApiCallback.html#deviceConnected(PolarDeviceInfo)>deviceConnected</a> callback.</p></div>

<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
Expand All @@ -929,13 +929,13 @@ <h4>connectToDevice</h4>
<li class="blockList">
<h4>disconnectFromDevice</h4>
<pre class="methodSignature"> abstract void <a href=PolarBleApi.html#disconnectFromDevice(String)>disconnectFromDevice</a>(@<a href=https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html>NonNull</a>() <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> identifier)</pre>
<div class="block"><p>Request disconnecting from a Polar device. Invokes <a href=PolarBleApiCallback.html#deviceDisconnected(PolarDeviceInfo)>deviceDisconnected</a> callback.</p></div>
<div class="block"><p>Request disconnecting from a BLE device. Invokes <a href=PolarBleApiCallback.html#deviceDisconnected(PolarDeviceInfo)>deviceDisconnected</a> callback.</p></div>

<dl>
<dt><span class="paramLabel">Parameters:</span></dt>


<dd><code>identifier</code> - Polar device id found printed on the sensor/device or bt address</dd>
<dd><code>identifier</code> - Polar device id found printed on the sensor/device or bt address (in format "00:11:22:33:44:55")</dd>


</dl>
Expand Down Expand Up @@ -1117,7 +1117,7 @@ <h4>removeExercise</h4>
<li class="blockList">
<h4>searchForDevice</h4>
<pre class="methodSignature">@<a href=https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html>NonNull</a>() abstract Flowable&lt;<a href=model/PolarDeviceInfo.html>PolarDeviceInfo</a>&gt; <a href=PolarBleApi.html#searchForDevice()>searchForDevice</a>()</pre>
<div class="block"><p>Start searching for device(s)</p></div>
<div class="block"><p>Starts searching for BLE devices when subscribed. Search continues as long as observable issubscribed or error. Each found device is emitted only once. By default searches only for Polar devices,but can be controlled by <a href=PolarBleApi.html#setPolarFilter(boolean)>setPolarFilter</a>. If <a href=PolarBleApi.html#setPolarFilter(boolean)>setPolarFilter</a> is falsethen searches for any BLE heart rate capable devices</p></div>

<!-- TODO missing return annotation -->
</li>
Expand All @@ -1132,7 +1132,7 @@ <h4>searchForDevice</h4>
<li class="blockList">
<h4>startListenForPolarHrBroadcasts</h4>
<pre class="methodSignature">@<a href=https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html>NonNull</a>() abstract Flowable&lt;<a href=model/PolarHrBroadcastData.html>PolarHrBroadcastData</a>&gt; <a href=PolarBleApi.html#startListenForPolarHrBroadcasts(Set)>startListenForPolarHrBroadcasts</a>(@<a href=https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html>Nullable</a>() <a href=https://developer.android.com/reference/kotlin/java/util/Set.html>Set</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; deviceIds)</pre>
<div class="block"><p>Start listening to heart rate broadcasts from one or more Polar devices</p></div>
<div class="block"><p>Start listening the heart rate from Polar devices when subscribed. This observable listens BLEbroadcast and parses heart rate from BLE broadcast. The BLE device is not connected whenusing this function.</p></div>

<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
Expand Down
Loading

0 comments on commit d9fe31b

Please sign in to comment.