Skip to content

Commit

Permalink
SDK release 5.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
Samuli Määttä committed Mar 30, 2023
1 parent 4dfda0e commit 49e65b0
Show file tree
Hide file tree
Showing 76 changed files with 8,606 additions and 1,844 deletions.
54 changes: 34 additions & 20 deletions polar-sdk-ios/docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (0% documented)</p>
<p><a href="index.html"> Docs</a> (100% documented)</p>
<div class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -46,6 +46,9 @@
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/OhrDataType.html">OhrDataType</a>
</li>
<li class="nav-group-task">
<a href="Enums/PolarBleSdkFeature.html">PolarBleSdkFeature</a>
</li>
Expand Down Expand Up @@ -76,7 +79,7 @@
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Extensions.html#/PolarBleApiImpl">PolarBleApiImpl</a>
<a href="Extensions.html#/c:@M@PolarBleSdk@objc(cs)PolarBleApiImpl">PolarBleApiImpl</a>
</li>
<li class="nav-group-task">
<a href="Extensions/PrimitiveSequence.html">PrimitiveSequence</a>
Expand All @@ -93,7 +96,7 @@
<a href="Protocols/PolarBleApiDeviceFeaturesObserver.html">PolarBleApiDeviceFeaturesObserver</a>
</li>
<li class="nav-group-task">
<a href="Protocols.html#/PolarBleApiDeviceHrObserver">PolarBleApiDeviceHrObserver</a>
<a href="Protocols/PolarBleApiDeviceHrObserver.html">PolarBleApiDeviceHrObserver</a>
</li>
<li class="nav-group-task">
<a href="Protocols/PolarBleApiDeviceInfoObserver.html">PolarBleApiDeviceInfoObserver</a>
Expand All @@ -108,7 +111,7 @@
<a href="Protocols/PolarBleApiPowerStateObserver.html">PolarBleApiPowerStateObserver</a>
</li>
<li class="nav-group-task">
<a href="Protocols.html#/PolarBleApiSdkModeFeatureObserver">PolarBleApiSdkModeFeatureObserver</a>
<a href="Protocols/PolarBleApiSdkModeFeatureObserver.html">PolarBleApiSdkModeFeatureObserver</a>
</li>
<li class="nav-group-task">
<a href="Protocols/PolarH10OfflineExerciseApi.html">PolarH10OfflineExerciseApi</a>
Expand Down Expand Up @@ -148,40 +151,43 @@
<a href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Typealiases.html#/PolarAccData">PolarAccData</a>
<a href="Typealiases.html#/s:11PolarBleSdk0A7AccDataa">PolarAccData</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/s:11PolarBleSdk0A10DeviceInfoa">PolarDeviceInfo</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/PolarDeviceInfo">PolarDeviceInfo</a>
<a href="Typealiases.html#/s:11PolarBleSdk0A7EcgDataa">PolarEcgData</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/PolarEcgData">PolarEcgData</a>
<a href="Typealiases.html#/s:11PolarBleSdk0A12ExerciseDataa">PolarExerciseData</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/PolarExerciseData">PolarExerciseData</a>
<a href="Typealiases.html#/s:11PolarBleSdk0A13ExerciseEntrya">PolarExerciseEntry</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/PolarExerciseEntry">PolarExerciseEntry</a>
<a href="Typealiases.html#/s:11PolarBleSdk0A8GyroDataa">PolarGyroData</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/PolarGyroData">PolarGyroData</a>
<a href="Typealiases.html#/s:11PolarBleSdk0A15HrBroadcastDataa">PolarHrBroadcastData</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/PolarHrBroadcastData">PolarHrBroadcastData</a>
<a href="Typealiases.html#/s:11PolarBleSdk0A6HrDataa">PolarHrData</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/PolarHrData">PolarHrData</a>
<a href="Typealiases.html#/s:11PolarBleSdk0A16MagnetometerDataa">PolarMagnetometerData</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/PolarMagnetometerData">PolarMagnetometerData</a>
<a href="Typealiases.html#/s:11PolarBleSdk0A7OhrDataa">PolarOhrData</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/PolarPpgData">PolarPpgData</a>
<a href="Typealiases.html#/s:11PolarBleSdk0A7PpgDataa">PolarPpgData</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/PolarPpiData">PolarPpiData</a>
<a href="Typealiases.html#/s:11PolarBleSdk0A7PpiDataa">PolarPpiData</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/PolarRecordingStatus">PolarRecordingStatus</a>
<a href="Typealiases.html#/s:11PolarBleSdk0A15RecordingStatusa">PolarRecordingStatus</a>
</li>
</ul>
</li>
Expand All @@ -200,9 +206,9 @@ <h1>Classes</h1>
<li class="item">
<div>
<code>
<a name="/"></a>
<a name="/s:11PolarBleSdk0aB14ApiDefaultImplC"></a>
<a name="//apple_ref/swift/Class/PolarBleApiDefaultImpl" class="dashAnchor"></a>
<a class="token" href="#/">PolarBleApiDefaultImpl</a>
<a class="token" href="#/s:11PolarBleSdk0aB14ApiDefaultImplC">PolarBleApiDefaultImpl</a>
</code>
</div>
<div class="height-container">
Expand All @@ -214,6 +220,14 @@ <h1>Classes</h1>

<a href="Classes/PolarBleApiDefaultImpl.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">PolarBleApiDefaultImpl</span></code></pre>

</div>
</div>
</section>
</div>
</li>
Expand All @@ -222,8 +236,8 @@ <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-03-28)</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>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-03-30)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
112 changes: 90 additions & 22 deletions polar-sdk-ios/docs/Classes/PolarBleApiDefaultImpl.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="PolarBleApiDefaultImpl Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (0% documented)</p>
<p><a href="../index.html"> Docs</a> (100% documented)</p>
<div class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -46,6 +46,9 @@
<li class="nav-group-name">
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/OhrDataType.html">OhrDataType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/PolarBleSdkFeature.html">PolarBleSdkFeature</a>
</li>
Expand Down Expand Up @@ -76,7 +79,7 @@
<a href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Extensions.html#/PolarBleApiImpl">PolarBleApiImpl</a>
<a href="../Extensions.html#/c:@M@PolarBleSdk@objc(cs)PolarBleApiImpl">PolarBleApiImpl</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/PrimitiveSequence.html">PrimitiveSequence</a>
Expand All @@ -93,7 +96,7 @@
<a href="../Protocols/PolarBleApiDeviceFeaturesObserver.html">PolarBleApiDeviceFeaturesObserver</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/PolarBleApiDeviceHrObserver">PolarBleApiDeviceHrObserver</a>
<a href="../Protocols/PolarBleApiDeviceHrObserver.html">PolarBleApiDeviceHrObserver</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/PolarBleApiDeviceInfoObserver.html">PolarBleApiDeviceInfoObserver</a>
Expand All @@ -108,7 +111,7 @@
<a href="../Protocols/PolarBleApiPowerStateObserver.html">PolarBleApiPowerStateObserver</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/PolarBleApiSdkModeFeatureObserver">PolarBleApiSdkModeFeatureObserver</a>
<a href="../Protocols/PolarBleApiSdkModeFeatureObserver.html">PolarBleApiSdkModeFeatureObserver</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/PolarH10OfflineExerciseApi.html">PolarH10OfflineExerciseApi</a>
Expand Down Expand Up @@ -148,40 +151,43 @@
<a href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Typealiases.html#/PolarAccData">PolarAccData</a>
<a href="../Typealiases.html#/s:11PolarBleSdk0A7AccDataa">PolarAccData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11PolarBleSdk0A10DeviceInfoa">PolarDeviceInfo</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/PolarDeviceInfo">PolarDeviceInfo</a>
<a href="../Typealiases.html#/s:11PolarBleSdk0A7EcgDataa">PolarEcgData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/PolarEcgData">PolarEcgData</a>
<a href="../Typealiases.html#/s:11PolarBleSdk0A12ExerciseDataa">PolarExerciseData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/PolarExerciseData">PolarExerciseData</a>
<a href="../Typealiases.html#/s:11PolarBleSdk0A13ExerciseEntrya">PolarExerciseEntry</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/PolarExerciseEntry">PolarExerciseEntry</a>
<a href="../Typealiases.html#/s:11PolarBleSdk0A8GyroDataa">PolarGyroData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/PolarGyroData">PolarGyroData</a>
<a href="../Typealiases.html#/s:11PolarBleSdk0A15HrBroadcastDataa">PolarHrBroadcastData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/PolarHrBroadcastData">PolarHrBroadcastData</a>
<a href="../Typealiases.html#/s:11PolarBleSdk0A6HrDataa">PolarHrData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/PolarHrData">PolarHrData</a>
<a href="../Typealiases.html#/s:11PolarBleSdk0A16MagnetometerDataa">PolarMagnetometerData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/PolarMagnetometerData">PolarMagnetometerData</a>
<a href="../Typealiases.html#/s:11PolarBleSdk0A7OhrDataa">PolarOhrData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/PolarPpgData">PolarPpgData</a>
<a href="../Typealiases.html#/s:11PolarBleSdk0A7PpgDataa">PolarPpgData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/PolarPpiData">PolarPpiData</a>
<a href="../Typealiases.html#/s:11PolarBleSdk0A7PpiDataa">PolarPpiData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/PolarRecordingStatus">PolarRecordingStatus</a>
<a href="../Typealiases.html#/s:11PolarBleSdk0A15RecordingStatusa">PolarRecordingStatus</a>
</li>
</ul>
</li>
Expand All @@ -191,6 +197,13 @@
<section>
<section class="section">
<h1>PolarBleApiDefaultImpl</h1>
<div class="declaration">
<div class="language">

<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">PolarBleApiDefaultImpl</span></code></pre>

</div>
</div>
<p>Class to provide the default implementation of the Polar Ble API</p>

</section>
Expand All @@ -200,9 +213,9 @@ <h1>PolarBleApiDefaultImpl</h1>
<li class="item">
<div>
<code>
<a name="/"></a>
<a name="/s:11PolarBleSdk0aB14ApiDefaultImplC19polarImplementation_8featuresAA0abD0_pSo17OS_dispatch_queueC_ShyAA0abC7FeatureOGtFZ"></a>
<a name="//apple_ref/swift/Method/polarImplementation(_:features:)" class="dashAnchor"></a>
<a class="token" href="#/">polarImplementation(_:<wbr>features:<wbr>)</a>
<a class="token" href="#/s:11PolarBleSdk0aB14ApiDefaultImplC19polarImplementation_8featuresAA0abD0_pSo17OS_dispatch_queueC_ShyAA0abC7FeatureOGtFZ">polarImplementation(_:<wbr>features:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -213,15 +226,58 @@ <h1>PolarBleApiDefaultImpl</h1>
<p>New instance of Polar Ble API implementation</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">polarImplementation</span><span class="p">(</span><span class="n">_</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">,</span> <span class="nv">features</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Enums/PolarBleSdkFeature.html">PolarBleSdkFeature</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Protocols/PolarBleApi.html">PolarBleApi</a></span></code></pre>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>queue</em>
</code>
</td>
<td>
<div>
<p>context of where the API is used</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>features</em>
</code>
</td>
<td>
<div>
<p>bit mask with one or more items from enum <code>Features</code></p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>api instance</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/"></a>
<a name="/s:11PolarBleSdk0aB14ApiDefaultImplC11versionInfoSSyFZ"></a>
<a name="//apple_ref/swift/Method/versionInfo()" class="dashAnchor"></a>
<a class="token" href="#/">versionInfo()</a>
<a class="token" href="#/s:11PolarBleSdk0aB14ApiDefaultImplC11versionInfoSSyFZ">versionInfo()</a>
</code>
</div>
<div class="height-container">
Expand All @@ -232,6 +288,18 @@ <h1>PolarBleApiDefaultImpl</h1>
<p>Return current version</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">versionInfo</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>

</div>
</div>
<div>
<h4>Return Value</h4>
<p>version in format major.minor.patch</p>
</div>
</section>
</div>
</li>
Expand All @@ -240,8 +308,8 @@ <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-03-28)</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>
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2023-03-30)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
Loading

0 comments on commit 49e65b0

Please sign in to comment.