Skip to content

Commit

Permalink
Release 5.0.0-beta3
Browse files Browse the repository at this point in the history
  • Loading branch information
@JOikarinen
JOikarinen committed Feb 20, 2023
1 parent 3cebc65 commit a5865e1
Show file tree
Hide file tree
Showing 73 changed files with 820 additions and 542 deletions.
2 changes: 1 addition & 1 deletion polar-sdk-android/docs/com/polar/sdk/api/PolarBleApi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -855,7 +855,7 @@ <h4>setLocalTime</h4>
<li class="blockList">
<h4>getLocalTime</h4>
<pre class="methodSignature"> abstract Single&lt;<a href=https://developer.android.com/reference/kotlin/java/util/Calendar.html>Calendar</a>&gt; <a href=PolarBleApi.html#getLocalTime(String)>getLocalTime</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> identifier)</pre>
<div class="block"><p>Get current time in device. Requires feature <a href=PolarBleApi.PolarBleSdkFeature.html#FEATURE_POLAR_DEVICE_TIME_SETUP>PolarBleSdkFeature.FEATURE_POLAR_DEVICE_TIME_SETUP</a></p></div>
<div class="block"><p>Get current time in device. Requires feature <a href=PolarBleApi.PolarBleSdkFeature.html#FEATURE_POLAR_DEVICE_TIME_SETUP>PolarBleSdkFeature.FEATURE_POLAR_DEVICE_TIME_SETUP</a>. Note, the H10 is not supporting time read.</p></div>

<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
Expand Down
8 changes: 4 additions & 4 deletions polar-sdk-android/docs/com/polar/sdk/api/PolarOfflineRecordingApi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -314,15 +314,15 @@ <h3>Method Summary</h3>
</td>
<th class="colSecond" scope="row"><code><a href=PolarOfflineRecordingApi.html#setOfflineRecordingTrigger(String,PolarOfflineRecordingTrigger,PolarRecordingSecret)>setOfflineRecordingTrigger</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> identifier, <a href=model/PolarOfflineRecordingTrigger.html>PolarOfflineRecordingTrigger</a> trigger, <a href=model/PolarRecordingSecret.html>PolarRecordingSecret</a> secret) </code>
</th>
<td class="colLast">Set the offline recording triggers.</td>
<td class="colLast">Sets the offline recording triggers for a given Polar device.</td>
</tr>

<tr id="i10" class="altColor">
<td class="colFirst"><code>abstract Single&lt;<a href=model/PolarOfflineRecordingTrigger.html>PolarOfflineRecordingTrigger</a>&gt;</code>
</td>
<th class="colSecond" scope="row"><code><a href=PolarOfflineRecordingApi.html#getOfflineRecordingTriggerSetup(String)>getOfflineRecordingTriggerSetup</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> identifier) </code>
</th>
<td class="colLast">Get the setup of offline recording triggers in the device.</td>
<td class="colLast">Retrieves the current offline recording trigger setup in the device.</td>
</tr>

</tbody>
Expand Down Expand Up @@ -630,7 +630,7 @@ <h4>stopOfflineRecording</h4>
<li class="blockList">
<h4>setOfflineRecordingTrigger</h4>
<pre class="methodSignature"> abstract Completable <a href=PolarOfflineRecordingApi.html#setOfflineRecordingTrigger(String,PolarOfflineRecordingTrigger,PolarRecordingSecret)>setOfflineRecordingTrigger</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> identifier, <a href=model/PolarOfflineRecordingTrigger.html>PolarOfflineRecordingTrigger</a> trigger, <a href=model/PolarRecordingSecret.html>PolarRecordingSecret</a> secret)</pre>
<div class="block"><p>Set the offline recording triggers. The offline recording can be started automatically by the device if the <a href=model/PolarOfflineRecordingTriggerMode.html>PolarOfflineRecordingTriggerMode</a> is set enabled. If offline recordings is already recoding the <a href=model/PolarOfflineRecordingTriggerMode.html>PolarOfflineRecordingTriggerMode</a> won't have affect on running recordings. Change of trigger settings will take effect on next device start up.</p><p>Automatically started offline recording can be stopped by <a href=PolarOfflineRecordingApi.html#stopOfflineRecording(String,PolarBleApi.PolarDeviceDataType)>stopOfflineRecording</a>. If user switches off the device power the offline recording is stopped, but starts again once power in device is switched on and the trigger event happens. Trigger functionality can be disabled by <a href=model/PolarOfflineRecordingTriggerMode.html#TRIGGER_DISABLED>PolarOfflineRecordingTriggerMode.TRIGGER_DISABLED</a>, however the already running offline recording is not stopped by disable.</p></div>
<div class="block"><p>Sets the offline recording triggers for a given Polar device. The offline recording can be started automatically in the device by setting the triggers. The changes to the trigger settings will take effect on the next device startup.</p><p>Automatically started offline recording can be stopped by <a href=PolarOfflineRecordingApi.html#stopOfflineRecording(String,PolarBleApi.PolarDeviceDataType)>stopOfflineRecording</a>. Also if user switches off the device power, the offline recording is stopped but starts again once power is switched on and the trigger event happens.</p><p>Trigger functionality can be disabled by setting <a href=model/PolarOfflineRecordingTriggerMode.html#TRIGGER_DISABLED>PolarOfflineRecordingTriggerMode.TRIGGER_DISABLED</a>, the already running offline recording is not stopped by disable.</p></div>

<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
Expand Down Expand Up @@ -662,7 +662,7 @@ <h4>setOfflineRecordingTrigger</h4>
<li class="blockList">
<h4>getOfflineRecordingTriggerSetup</h4>
<pre class="methodSignature"> abstract Single&lt;<a href=model/PolarOfflineRecordingTrigger.html>PolarOfflineRecordingTrigger</a>&gt; <a href=PolarOfflineRecordingApi.html#getOfflineRecordingTriggerSetup(String)>getOfflineRecordingTriggerSetup</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> identifier)</pre>
<div class="block"><p>Get the setup of offline recording triggers in the device.</p><p>The setup is the current offline recording trigger setup in the device. To know which offline recordings are currently recording use the <a href=PolarOfflineRecordingApi.html#getOfflineRecordingStatus(String)>getOfflineRecordingStatus</a></p></div>
<div class="block"><p>Retrieves the current offline recording trigger setup in the device.</p></div>

<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
Expand Down
4 changes: 2 additions & 2 deletions polar-sdk-android/docs/index-files/index-14.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ <h2 class="title">S</h2>


</dt>
<dd>Set the offline recording triggers.</dd>
<dd>Sets the offline recording triggers for a given Polar device.</dd>


<dt>
Expand All @@ -272,7 +272,7 @@ <h2 class="title">S</h2>


</dt>
<dd>Set the offline recording triggers.</dd>
<dd>Sets the offline recording triggers for a given Polar device.</dd>


<dt>
Expand Down
4 changes: 2 additions & 2 deletions polar-sdk-android/docs/index-files/index-7.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1078,7 +1078,7 @@ <h2 class="title">G</h2>


</dt>
<dd>Get the setup of offline recording triggers in the device.</dd>
<dd>Retrieves the current offline recording trigger setup in the device.</dd>


<dt>
Expand All @@ -1091,7 +1091,7 @@ <h2 class="title">G</h2>


</dt>
<dd>Get the setup of offline recording triggers in the device.</dd>
<dd>Retrieves the current offline recording trigger setup in the device.</dd>


<dt>
Expand Down
13 changes: 8 additions & 5 deletions polar-sdk-ios/docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,6 @@
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/Features.html">Features</a>
</li>
<li class="nav-group-task">
<a href="Enums/PolarBleSdkFeature.html">PolarBleSdkFeature</a>
</li>
Expand All @@ -61,6 +58,9 @@
<li class="nav-group-task">
<a href="Enums/PolarOfflineRecordingData.html">PolarOfflineRecordingData</a>
</li>
<li class="nav-group-task">
<a href="Enums/PolarOfflineRecordingTriggerMode.html">PolarOfflineRecordingTriggerMode</a>
</li>
<li class="nav-group-task">
<a href="Enums/PpgDataType.html">PpgDataType</a>
</li>
Expand Down Expand Up @@ -90,7 +90,7 @@
<a href="Protocols/PolarBleApi.html">PolarBleApi</a>
</li>
<li class="nav-group-task">
<a href="Protocols/PolarBleApiDeviceFeaturesObserver.html">PolarBleApiDeviceFeaturesObserver</a>
<a href="Protocols.html#/PolarBleApiDeviceFeaturesObserver">PolarBleApiDeviceFeaturesObserver</a>
</li>
<li class="nav-group-task">
<a href="Protocols.html#/PolarBleApiDeviceHrObserver">PolarBleApiDeviceHrObserver</a>
Expand Down Expand Up @@ -130,6 +130,9 @@
<li class="nav-group-task">
<a href="Structs/PolarOfflineRecordingEntry.html">PolarOfflineRecordingEntry</a>
</li>
<li class="nav-group-task">
<a href="Structs/PolarOfflineRecordingTrigger.html">PolarOfflineRecordingTrigger</a>
</li>
<li class="nav-group-task">
<a href="Structs/PolarRecordingSecret.html">PolarRecordingSecret</a>
</li>
Expand Down Expand Up @@ -219,7 +222,7 @@ <h1>Classes</h1>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-02-13)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-02-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
13 changes: 8 additions & 5 deletions polar-sdk-ios/docs/Classes/PolarBleApiDefaultImpl.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,6 @@
<li class="nav-group-name">
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/Features.html">Features</a>
</li>
<li class="nav-group-task">
<a href="../Enums/PolarBleSdkFeature.html">PolarBleSdkFeature</a>
</li>
Expand All @@ -61,6 +58,9 @@
<li class="nav-group-task">
<a href="../Enums/PolarOfflineRecordingData.html">PolarOfflineRecordingData</a>
</li>
<li class="nav-group-task">
<a href="../Enums/PolarOfflineRecordingTriggerMode.html">PolarOfflineRecordingTriggerMode</a>
</li>
<li class="nav-group-task">
<a href="../Enums/PpgDataType.html">PpgDataType</a>
</li>
Expand Down Expand Up @@ -90,7 +90,7 @@
<a href="../Protocols/PolarBleApi.html">PolarBleApi</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/PolarBleApiDeviceFeaturesObserver.html">PolarBleApiDeviceFeaturesObserver</a>
<a href="../Protocols.html#/PolarBleApiDeviceFeaturesObserver">PolarBleApiDeviceFeaturesObserver</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/PolarBleApiDeviceHrObserver">PolarBleApiDeviceHrObserver</a>
Expand Down Expand Up @@ -130,6 +130,9 @@
<li class="nav-group-task">
<a href="../Structs/PolarOfflineRecordingEntry.html">PolarOfflineRecordingEntry</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PolarOfflineRecordingTrigger.html">PolarOfflineRecordingTrigger</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PolarRecordingSecret.html">PolarRecordingSecret</a>
</li>
Expand Down Expand Up @@ -237,7 +240,7 @@ <h1>PolarBleApiDefaultImpl</h1>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-02-13)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-02-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
53 changes: 28 additions & 25 deletions polar-sdk-ios/docs/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,6 @@
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/Features.html">Features</a>
</li>
<li class="nav-group-task">
<a href="Enums/PolarBleSdkFeature.html">PolarBleSdkFeature</a>
</li>
Expand All @@ -61,6 +58,9 @@
<li class="nav-group-task">
<a href="Enums/PolarOfflineRecordingData.html">PolarOfflineRecordingData</a>
</li>
<li class="nav-group-task">
<a href="Enums/PolarOfflineRecordingTriggerMode.html">PolarOfflineRecordingTriggerMode</a>
</li>
<li class="nav-group-task">
<a href="Enums/PpgDataType.html">PpgDataType</a>
</li>
Expand Down Expand Up @@ -90,7 +90,7 @@
<a href="Protocols/PolarBleApi.html">PolarBleApi</a>
</li>
<li class="nav-group-task">
<a href="Protocols/PolarBleApiDeviceFeaturesObserver.html">PolarBleApiDeviceFeaturesObserver</a>
<a href="Protocols.html#/PolarBleApiDeviceFeaturesObserver">PolarBleApiDeviceFeaturesObserver</a>
</li>
<li class="nav-group-task">
<a href="Protocols.html#/PolarBleApiDeviceHrObserver">PolarBleApiDeviceHrObserver</a>
Expand Down Expand Up @@ -130,6 +130,9 @@
<li class="nav-group-task">
<a href="Structs/PolarOfflineRecordingEntry.html">PolarOfflineRecordingEntry</a>
</li>
<li class="nav-group-task">
<a href="Structs/PolarOfflineRecordingTrigger.html">PolarOfflineRecordingTrigger</a>
</li>
<li class="nav-group-task">
<a href="Structs/PolarRecordingSecret.html">PolarRecordingSecret</a>
</li>
Expand Down Expand Up @@ -214,26 +217,6 @@ <h1>Enumerations</h1>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/"></a>
<a name="//apple_ref/swift/Enum/Features" class="dashAnchor"></a>
<a class="token" href="#/">Features</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>features available</p>

<a href="Enums/Features.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -353,12 +336,32 @@ <h1>Enumerations</h1>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/"></a>
<a name="//apple_ref/swift/Enum/PolarOfflineRecordingTriggerMode" class="dashAnchor"></a>
<a class="token" href="#/">PolarOfflineRecordingTriggerMode</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Polar offline recording trigger mode. Offline recording trigger can be used to start the offline recording automatically in device, based on selected trigger mode.</p>

<a href="Enums/PolarOfflineRecordingTriggerMode.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-02-13)</p>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-02-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit a5865e1

Please sign in to comment.