From d9fe31b6461e76f51dfd3d83046180a89ab2fc54 Mon Sep 17 00:00:00 2001 From: Jukka Oikarinen Date: Mon, 28 Feb 2022 10:51:33 +0200 Subject: [PATCH] Android docs: Prepare for the 3.2.9 release --- .../html/com/polar/sdk/api/PolarBleApi.html | 34 +++++++++---------- .../html/com/polar/sdk/impl/BDBleApiImpl.html | 32 ++++++++--------- polar-sdk-android/docs/html/deprecated.html | 25 ++++++++++++++ .../docs/html/index-files/index-15.html | 18 +++++----- .../docs/html/index-files/index-3.html | 4 +-- .../docs/html/index-files/index-4.html | 6 ++-- .../docs/html/index-files/index-6.html | 4 +-- 7 files changed, 74 insertions(+), 49 deletions(-) diff --git a/polar-sdk-android/docs/html/com/polar/sdk/api/PolarBleApi.html b/polar-sdk-android/docs/html/com/polar/sdk/api/PolarBleApi.html index e014732b..db8af31f 100644 --- a/polar-sdk-android/docs/html/com/polar/sdk/api/PolarBleApi.html +++ b/polar-sdk-android/docs/html/com/polar/sdk/api/PolarBleApi.html @@ -281,7 +281,7 @@

Method Summary

setPolarFilter(boolean enable) - + When enabled only Polar devices are found by the searchForDevice, if set to falseany BLE devices with HR services are returned by the searchForDevice. @@ -305,7 +305,7 @@

Method Summary

foregroundEntered() - disables scan filter while on foreground + Optionally call when application enters to the foreground. @@ -329,7 +329,7 @@

Method Summary

setAutomaticReconnection(boolean enable) - Enable or disable automatic reconnection feature + When enabled the reconnection is attempted if device connection is lost. @@ -377,7 +377,7 @@

Method Summary

connectToDevice(@NonNull() String identifier) - Request a connection to a Polar device. + Request a connection to a BLE device. @@ -385,7 +385,7 @@

Method Summary

disconnectFromDevice(@NonNull() String identifier) - Request disconnecting from a Polar device. + Request disconnecting from a BLE device. @@ -441,7 +441,7 @@

Method Summary

searchForDevice() - Start searching for device(s) + Starts searching for BLE devices when subscribed. @@ -449,7 +449,7 @@

Method Summary

startListenForPolarHrBroadcasts(@Nullable() Set<String> deviceIds) - Start listening to heart rate broadcasts from one or more Polar devices + Start listening the heart rate from Polar devices when subscribed. @@ -612,13 +612,13 @@

cleanup

  • setPolarFilter

     abstract void setPolarFilter(boolean enable)
    -
    +

    When enabled only Polar devices are found by the searchForDevice, if set to falseany BLE devices with HR services are returned by the searchForDevice. The default setting forPolar filter is true.

    Parameters:
    -
    enable - false disable polar filter which means in all apis identifier can be bt address too
    +
    enable - false disables polar filter
    @@ -663,7 +663,7 @@

    isFeatureReady

    >

  • backgroundEntered

    - 
     abstract void backgroundEntered()
    + 
    @Deprecated() abstract void backgroundEntered()

    enables scan filter while on background

    @@ -679,7 +679,7 @@

    backgroundEntered

  • foregroundEntered

     abstract void foregroundEntered()
    -

    disables scan filter while on foreground

    +

    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 setAutomaticReconnection is enabled,reconnection is created when application is back in foreground.

    • @@ -742,7 +742,7 @@

    setApiLogger

  • setAutomaticReconnection

     abstract void setAutomaticReconnection(boolean enable)
    -

    Enable or disable automatic reconnection feature

    +

    When enabled the reconnection is attempted if device connection is lost. By default automatic reconnection is enabled.

    Parameters:
    @@ -905,7 +905,7 @@

    autoConnectToDevice

  • connectToDevice

     abstract void connectToDevice(@NonNull() String identifier)
    -

    Request a connection to a Polar device. Invokes deviceConnected callback.

    +

    Request a connection to a BLE device. Invokes deviceConnected callback.

    Parameters:
    @@ -929,13 +929,13 @@

    connectToDevice

  • disconnectFromDevice

     abstract void disconnectFromDevice(@NonNull() String identifier)
    -

    Request disconnecting from a Polar device. Invokes deviceDisconnected callback.

    +

    Request disconnecting from a BLE device. Invokes deviceDisconnected callback.

    Parameters:
    -
    identifier - Polar device id found printed on the sensor/device or bt address
    +
    identifier - Polar device id found printed on the sensor/device or bt address (in format "00:11:22:33:44:55")
    @@ -1117,7 +1117,7 @@

    removeExercise

  • searchForDevice

    @NonNull() abstract Flowable<PolarDeviceInfo> searchForDevice()
    -

    Start searching for device(s)

    +

    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 setPolarFilter. If setPolarFilter is falsethen searches for any BLE heart rate capable devices

    • @@ -1132,7 +1132,7 @@

    searchForDevice

  • startListenForPolarHrBroadcasts

    @NonNull() abstract Flowable<PolarHrBroadcastData> startListenForPolarHrBroadcasts(@Nullable() Set<String> deviceIds)
    -

    Start listening to heart rate broadcasts from one or more Polar devices

    +

    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.

    Parameters:
    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 index 6857ca03..17d46350 100644 --- a/polar-sdk-android/docs/html/com/polar/sdk/impl/BDBleApiImpl.html +++ b/polar-sdk-android/docs/html/com/polar/sdk/impl/BDBleApiImpl.html @@ -218,7 +218,7 @@

    Method Summary

    setPolarFilter(boolean enable) - + When enabled only Polar devices are found by the searchForDevice, if set to falseany BLE devices with HR services are returned by the searchForDevice. @@ -250,7 +250,7 @@

    Method Summary

    setAutomaticReconnection(boolean disable) - Enable or disable automatic reconnection feature + When enabled the reconnection is attempted if device connection is lost. @@ -290,7 +290,7 @@

    Method Summary

    foregroundEntered() - disables scan filter while on foreground + Optionally call when application enters to the foreground. @@ -314,7 +314,7 @@

    Method Summary

    connectToDevice(@NonNull() String identifier) - Request a connection to a Polar device. + Request a connection to a BLE device. @@ -322,7 +322,7 @@

    Method Summary

    disconnectFromDevice(@NonNull() String identifier) - Request disconnecting from a Polar device. + Request disconnecting from a BLE device. @@ -378,7 +378,7 @@

    Method Summary

    searchForDevice() - Start searching for device(s) + Starts searching for BLE devices when subscribed. @@ -386,7 +386,7 @@

    Method Summary

    startListenForPolarHrBroadcasts(@Nullable() Set<String> deviceIds) - Start listening to heart rate broadcasts from one or more Polar devices + Start listening the heart rate from Polar devices when subscribed. @@ -601,13 +601,13 @@

    cleanup

  • setPolarFilter

     void setPolarFilter(boolean enable)
    -
    +

    When enabled only Polar devices are found by the searchForDevice, if set to falseany BLE devices with HR services are returned by the searchForDevice. The default setting forPolar filter is true.

    Parameters:
    -
    enable - false disable polar filter which means in all apis identifier can be bt address too
    +
    enable - false disables polar filter
    @@ -701,7 +701,7 @@

    setApiLogger

  • setAutomaticReconnection

     void setAutomaticReconnection(boolean disable)
    -

    Enable or disable automatic reconnection feature

    +

    When enabled the reconnection is attempted if device connection is lost. By default automatic reconnection is enabled.

    • @@ -813,7 +813,7 @@

    backgroundEntered

  • foregroundEntered

     void foregroundEntered()
    -

    disables scan filter while on foreground

    +

    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 setAutomaticReconnection is enabled,reconnection is created when application is back in foreground.

    • @@ -883,7 +883,7 @@

    autoConnectToDevice

  • connectToDevice

     void connectToDevice(@NonNull() String identifier)
    -

    Request a connection to a Polar device. Invokes deviceConnected callback.

    +

    Request a connection to a BLE device. Invokes deviceConnected callback.

    Parameters:
    @@ -907,13 +907,13 @@

    connectToDevice

  • disconnectFromDevice

     void disconnectFromDevice(@NonNull() String identifier)
    -

    Request disconnecting from a Polar device. Invokes deviceDisconnected callback.

    +

    Request disconnecting from a BLE device. Invokes deviceDisconnected callback.

    Parameters:
    -
    identifier - Polar device id found printed on the sensor/device or bt address
    +
    identifier - Polar device id found printed on the sensor/device or bt address (in format "00:11:22:33:44:55")
    @@ -1095,7 +1095,7 @@

    removeExercise

  • searchForDevice

    @NonNull() Flowable<PolarDeviceInfo> searchForDevice()
    -

    Start searching for device(s)

    +

    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 setPolarFilter. If setPolarFilter is falsethen searches for any BLE heart rate capable devices

    • @@ -1110,7 +1110,7 @@

    searchForDevice

  • startListenForPolarHrBroadcasts

    @NonNull() Flowable<PolarHrBroadcastData> startListenForPolarHrBroadcasts(@Nullable() Set<String> deviceIds)
    -

    Start listening to heart rate broadcasts from one or more Polar devices

    +

    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.

    Parameters:
    diff --git a/polar-sdk-android/docs/html/deprecated.html b/polar-sdk-android/docs/html/deprecated.html index 3c151b27..40d9c9b6 100644 --- a/polar-sdk-android/docs/html/deprecated.html +++ b/polar-sdk-android/docs/html/deprecated.html @@ -92,10 +92,35 @@

    Deprecated API

    Contents

    + + +
    diff --git a/polar-sdk-android/docs/html/index-files/index-4.html b/polar-sdk-android/docs/html/index-files/index-4.html index 4e8ea463..31047aab 100644 --- a/polar-sdk-android/docs/html/index-files/index-4.html +++ b/polar-sdk-android/docs/html/index-files/index-4.html @@ -274,7 +274,7 @@

    D

    -
    Request disconnecting from a Polar device.
    +
    Request disconnecting from a BLE device.
    @@ -287,7 +287,7 @@

    D

    -
    Request disconnecting from a Polar device.
    +
    Request disconnecting from a BLE device.
    @@ -300,7 +300,7 @@

    D

    -
    Request disconnecting from a Polar device.
    +
    Request disconnecting from a BLE device.
    diff --git a/polar-sdk-android/docs/html/index-files/index-6.html b/polar-sdk-android/docs/html/index-files/index-6.html index bc7dfa64..1709b996 100644 --- a/polar-sdk-android/docs/html/index-files/index-6.html +++ b/polar-sdk-android/docs/html/index-files/index-6.html @@ -287,7 +287,7 @@

    F

    -
    disables scan filter while on foreground
    +
    Optionally call when application enters to the foreground.
    @@ -300,7 +300,7 @@

    F

    -
    disables scan filter while on foreground
    +
    Optionally call when application enters to the foreground.