@react-native-ohos/react-native-ble-plx 3.2.1-rc.1 → 3.2.1

package/src/TypeDefinition.js

@@ -1,360 +1,360 @@
-// @flow
-'use strict'
-
-import type { Device } from './Device'
-import { BleErrorCode } from './BleError'
-
-/**
- * Bluetooth device id.
- */
-export type DeviceId = string
-
-/**
- * Unique identifier for BLE objects.
- */
-export type Identifier = number
-
-/**
- * Bluetooth UUID
- */
-export type UUID = string
-
-/**
- * Base64 value
- */
-export type Base64 = string
-
-/**
- * Transaction identifier. All transaction identifiers in numeric form are reserved for internal use.
- */
-export type TransactionId = string
-
-/**
- * [Android only] ConnectionOptions parameter to describe when to call BluetoothGatt.refresh()
- */
-export type RefreshGattMoment = 'OnConnected'
-
-/**
- * Subscription
- * @interface
- */
-export interface Subscription {
-  /**
-   * Removes subscription
-   * @memberof Subscription
-   * @ignore
-   */
-  remove(): void;
-}
-
-/**
- * Type of error code mapping table
- */
-export type BleErrorCodeMessageMapping = { [$Values < typeof BleErrorCode >]: string }
-
-/**
- * Options which can be passed to when creating BLE Manager
- */
-export interface BleManagerOptions {
-  /**
-   * BLE State restoration identifier used to restore state.
-   * @memberof BleManagerOptions
-   * @instance
-   */
-  restoreStateIdentifier?: string;
-
-  /**
-   * Optional function which is used to properly restore state of your BLE Manager. Callback
-   * is emitted in the beginning of BleManager creation and optional {@link BleRestoreState}
-   * is passed. When value is `null` application is launching for the first time, otherwise
-   * it contains saved state which may be used by developer to continue working with
-   * connected peripherals.
-   * @memberof BleManagerOptions
-   * @instance
-   */
-  restoreStateFunction?: (restoredState: ?BleRestoredState) => void;
-
-  /**
-   * Optional mapping of error codes to error messages. Uses {@link BleErrorCodeMessage}
-   * by default.
-   *
-   * To override logging UUIDs or MAC adresses in error messages copy the original object
-   * and overwrite values of interest to you.
-   *
-   * @memberof BleManagerOptions
-   * @instance
-   */
-  errorCodesToMessagesMapping?: BleErrorCodeMessageMapping;
-}
-
-/**
- * Object representing information about restored BLE state after application relaunch.
- */
-export interface BleRestoredState {
-  /**
-   * List of connected devices after state restoration.
-   * @type {Array<Device>}
-   * @instance
-   * @memberof BleRestoredState
-   */
-  connectedPeripherals: Array<Device>;
-}
-
-/**
- * Scan mode for Bluetooth LE scan.
- */
-export const ScanMode = {
-  /**
-   * A special Bluetooth LE scan mode. Applications using this scan mode will passively listen for
-   * other scan results without starting BLE scans themselves. [Android only]
-   */
-  Opportunistic: -1,
-
-  /**
-   * Perform Bluetooth LE scan in low power mode. This is the default scan mode as it consumes the
-   * least power. [Android and Harmony] [default value]
-   */
-  LowPower: 0,
-
-  /**
-   * Perform Bluetooth LE scan in balanced power mode. Scan results are returned at a rate that
-   * provides a good trade-off between scan frequency and power consumption. [Android and Harmony]
-   */
-  Balanced: 1,
-
-  /**
-   * Scan using highest duty cycle. It's recommended to only use this mode when the application is
-   * running in the foreground. [Android and Harmony]
-   */
-  LowLatency: 2
-}
-
-/**
- * The enum of BLE match mode.
- */
-export const MatchMode = {
-  /**
-   * Aggressive mode
-   */
-  Aggressive: 1,
-
-  /**
-   * Sticky mode
-   */
-  Sticky: 2
-}
-
-/**
- * Phy type used during scan.
- */
-export const PhyType = {
-  /**
-   * Use 1M phy for scanning.
-   */
-  LE_1M: 1,
-
-  /**
-   * Use all supported Phys for scanning.
-   */
-  LE_All_Supported: 255
-}
-
-/**
- * Scan callback type for Bluetooth LE scan.
- * @name ScanCallbackType
- */
-export const ScanCallbackType = {
-  /**
-   * Trigger a callback for every Bluetooth advertisement found that matches the filter criteria.
-   * If no filter is active, all advertisement packets are reported. [default value]
-   */
-  AllMatches: 1,
-
-  /**
-   * A result callback is only triggered for the first advertisement packet received that matches
-   * the filter criteria.
-   */
-  FirstMatch: 2,
-
-  /**
-   * Receive a callback when advertisements are no longer received from a device that has been
-   * previously reported by a first match callback.
-   */
-  MatchLost: 4
-}
-
-/**
- * Options which can be passed to scanning function
- * @name ScanOptions
- */
-export interface ScanOptions {
-  /**
-   * By allowing duplicates scanning records are received more frequently [iOS only]
-   * @memberof ScanOptions
-   * @instance
-   */
-  allowDuplicates?: boolean;
-
-  /**
-   * Scan mode for Bluetooth LE scan [Android and Harmony]
-   * @memberof ScanOptions
-   * @instance
-   */
-  scanMode?: $Values<typeof ScanMode>;
-
-  /**
-   * Scan callback type for Bluetooth LE scan [Android only]
-   * @memberof ScanOptions
-   * @instance
-   */
-  callbackType?: $Values<typeof ScanCallbackType>;
-  /**
-   * Use legacyScan (default true) [Android only]
-   * https://developer.android.com/reference/android/bluetooth/le/ScanSettings.Builder#setLegacy(boolean)
-   * @memberof ScanOptions
-   * @instance
-   */
-  legacyScan?: boolean;
-
-  /**
-   * Time of delay for reporting the scan result [Harmony only]
-   * @memberof ScanOptions
-   * @instance
-   */
-  interval?: number;
-
-  /**
-   * Match mode for Bluetooth LE scan filters hardware match [Harmony only]
-   * @memberof ScanOptions
-   * @instance
-   */
-  matchMode?: $Values<typeof MatchMode>;
-
-  /**
-   * Physical Layer used during scan [Harmony only]
-   * @memberof ScanOptions
-   * @instance
-   */
-  phyType?: $Values<typeof PhyType>;
-}
-
-/**
- * Connection specific options to be passed before connection happen. [Not used]
- */
-export interface ConnectionOptions {
-  /**
-   * Whether to directly connect to the remote device (false) or to automatically connect as soon as the remote device
-   * becomes available (true). [Android only]
-   * @memberof ConnectionOptions
-   * @instance
-   */
-  autoConnect?: boolean;
-
-  /**
-   * Whether MTU size will be negotiated to this value. It is not guaranteed to get it after connection is successful.
-   *
-   * @memberof ConnectionOptions
-   * @instance
-   */
-  requestMTU?: number;
-
-  /**
-   * Whether action will be taken to reset services cache. This option may be useful when a peripheral's firmware was
-   * updated and it's services/characteristics were added/removed/altered. [Android only]
-   * {@link https://stackoverflow.com/questions/22596951/how-to-programmatically-force-bluetooth-low-energy-service-discovery-on-android}
-   * @memberof ConnectionOptions
-   * @instance
-   */
-  refreshGatt?: RefreshGattMoment;
-
-  /**
-   * Number of milliseconds after connection is automatically timed out. In case of race condition were connection is
-   * established right after timeout event, device will be disconnected immediately. Time out may happen earlier then
-   * specified due to OS specific behavior.
-   *
-   * @memberof ConnectionOptions
-   * @instance
-   */
-  timeout?: number;
-}
-
-/**
- * Device Bluetooth Low Energy state. It's keys are used to check {@link #blemanagerstate} values
- * received by {@link BleManager}
- */
-export const State = {
-  /**
-   * The current state of the manager is unknown; an update is imminent.
-   */
-  Unknown: 'Unknown',
-  /**
-   * The connection with the system service was momentarily lost; an update is imminent.
-   */
-  Resetting: 'Resetting',
-  /**
-   * The platform does not support Bluetooth low energy.
-   */
-  Unsupported: 'Unsupported',
-  /**
-   * The app is not authorized to use Bluetooth low energy.
-   */
-  Unauthorized: 'Unauthorized',
-  /**
-   * Bluetooth is currently powered off.
-   */
-  PoweredOff: 'PoweredOff',
-  /**
-   * Bluetooth is currently powered on and available to use.
-   */
-  PoweredOn: 'PoweredOn'
-}
-
-/**
- * Native module logging log level. By default it is set to None.
- * @name LogLevel
- */
-export const LogLevel = {
-  /**
-   * Logging in native module is disabled
-   */
-  None: 'None',
-  /**
-   * All logs in native module are shown
-   */
-  Verbose: 'Verbose',
-  /**
-   * Only debug logs and of higher importance are shown in native module.
-   */
-  Debug: 'Debug',
-  /**
-   * Only info logs and of higher importance are shown in native module.
-   */
-  Info: 'Info',
-  /**
-   * Only warning logs and of higher importance are shown in native module.
-   */
-  Warning: 'Warning',
-  /**
-   * Only error logs and of higher importance are shown in native module.
-   */
-  Error: 'Error'
-}
-
-/**
- * Connection priority of BLE link determining the balance between power consumption and data throughput.
- * @name ConnectionPriority
- */
-export const ConnectionPriority = {
-  /**
-   * Default, recommended option balanced between power consumption and data throughput.
-   */
-  Balanced: 0,
-  /**
-   * High priority, low latency connection, which increases transfer speed at the expense of power consumption.
-   */
-  High: 1,
-  /**
-   * Low power, reduced data rate connection setup.
-   */
-  LowPower: 2
-}
+// @flow
+'use strict'
+
+import type { Device } from './Device'
+import { BleErrorCode } from './BleError'
+
+/**
+ * Bluetooth device id.
+ */
+export type DeviceId = string
+
+/**
+ * Unique identifier for BLE objects.
+ */
+export type Identifier = number
+
+/**
+ * Bluetooth UUID
+ */
+export type UUID = string
+
+/**
+ * Base64 value
+ */
+export type Base64 = string
+
+/**
+ * Transaction identifier. All transaction identifiers in numeric form are reserved for internal use.
+ */
+export type TransactionId = string
+
+/**
+ * [Android only] ConnectionOptions parameter to describe when to call BluetoothGatt.refresh()
+ */
+export type RefreshGattMoment = 'OnConnected'
+
+/**
+ * Subscription
+ * @interface
+ */
+export interface Subscription {
+  /**
+   * Removes subscription
+   * @memberof Subscription
+   * @ignore
+   */
+  remove(): void;
+}
+
+/**
+ * Type of error code mapping table
+ */
+export type BleErrorCodeMessageMapping = { [$Values < typeof BleErrorCode >]: string }
+
+/**
+ * Options which can be passed to when creating BLE Manager
+ */
+export interface BleManagerOptions {
+  /**
+   * BLE State restoration identifier used to restore state.
+   * @memberof BleManagerOptions
+   * @instance
+   */
+  restoreStateIdentifier?: string;
+
+  /**
+   * Optional function which is used to properly restore state of your BLE Manager. Callback
+   * is emitted in the beginning of BleManager creation and optional {@link BleRestoreState}
+   * is passed. When value is `null` application is launching for the first time, otherwise
+   * it contains saved state which may be used by developer to continue working with
+   * connected peripherals.
+   * @memberof BleManagerOptions
+   * @instance
+   */
+  restoreStateFunction?: (restoredState: ?BleRestoredState) => void;
+
+  /**
+   * Optional mapping of error codes to error messages. Uses {@link BleErrorCodeMessage}
+   * by default.
+   *
+   * To override logging UUIDs or MAC adresses in error messages copy the original object
+   * and overwrite values of interest to you.
+   *
+   * @memberof BleManagerOptions
+   * @instance
+   */
+  errorCodesToMessagesMapping?: BleErrorCodeMessageMapping;
+}
+
+/**
+ * Object representing information about restored BLE state after application relaunch.
+ */
+export interface BleRestoredState {
+  /**
+   * List of connected devices after state restoration.
+   * @type {Array<Device>}
+   * @instance
+   * @memberof BleRestoredState
+   */
+  connectedPeripherals: Array<Device>;
+}
+
+/**
+ * Scan mode for Bluetooth LE scan.
+ */
+export const ScanMode = {
+  /**
+   * A special Bluetooth LE scan mode. Applications using this scan mode will passively listen for
+   * other scan results without starting BLE scans themselves. [Android only]
+   */
+  Opportunistic: -1,
+
+  /**
+   * Perform Bluetooth LE scan in low power mode. This is the default scan mode as it consumes the
+   * least power. [Android and Harmony] [default value]
+   */
+  LowPower: 0,
+
+  /**
+   * Perform Bluetooth LE scan in balanced power mode. Scan results are returned at a rate that
+   * provides a good trade-off between scan frequency and power consumption. [Android and Harmony]
+   */
+  Balanced: 1,
+
+  /**
+   * Scan using highest duty cycle. It's recommended to only use this mode when the application is
+   * running in the foreground. [Android and Harmony]
+   */
+  LowLatency: 2
+}
+
+/**
+ * The enum of BLE match mode.
+ */
+export const MatchMode = {
+  /**
+   * Aggressive mode
+   */
+  Aggressive: 1,
+
+  /**
+   * Sticky mode
+   */
+  Sticky: 2
+}
+
+/**
+ * Phy type used during scan.
+ */
+export const PhyType = {
+  /**
+   * Use 1M phy for scanning.
+   */
+  LE_1M: 1,
+
+  /**
+   * Use all supported Phys for scanning.
+   */
+  LE_All_Supported: 255
+}
+
+/**
+ * Scan callback type for Bluetooth LE scan.
+ * @name ScanCallbackType
+ */
+export const ScanCallbackType = {
+  /**
+   * Trigger a callback for every Bluetooth advertisement found that matches the filter criteria.
+   * If no filter is active, all advertisement packets are reported. [default value]
+   */
+  AllMatches: 1,
+
+  /**
+   * A result callback is only triggered for the first advertisement packet received that matches
+   * the filter criteria.
+   */
+  FirstMatch: 2,
+
+  /**
+   * Receive a callback when advertisements are no longer received from a device that has been
+   * previously reported by a first match callback.
+   */
+  MatchLost: 4
+}
+
+/**
+ * Options which can be passed to scanning function
+ * @name ScanOptions
+ */
+export interface ScanOptions {
+  /**
+   * By allowing duplicates scanning records are received more frequently [iOS only]
+   * @memberof ScanOptions
+   * @instance
+   */
+  allowDuplicates?: boolean;
+
+  /**
+   * Scan mode for Bluetooth LE scan [Android and Harmony]
+   * @memberof ScanOptions
+   * @instance
+   */
+  scanMode?: $Values<typeof ScanMode>;
+
+  /**
+   * Scan callback type for Bluetooth LE scan [Android only]
+   * @memberof ScanOptions
+   * @instance
+   */
+  callbackType?: $Values<typeof ScanCallbackType>;
+  /**
+   * Use legacyScan (default true) [Android only]
+   * https://developer.android.com/reference/android/bluetooth/le/ScanSettings.Builder#setLegacy(boolean)
+   * @memberof ScanOptions
+   * @instance
+   */
+  legacyScan?: boolean;
+
+  /**
+   * Time of delay for reporting the scan result [Harmony only]
+   * @memberof ScanOptions
+   * @instance
+   */
+  interval?: number;
+
+  /**
+   * Match mode for Bluetooth LE scan filters hardware match [Harmony only]
+   * @memberof ScanOptions
+   * @instance
+   */
+  matchMode?: $Values<typeof MatchMode>;
+
+  /**
+   * Physical Layer used during scan [Harmony only]
+   * @memberof ScanOptions
+   * @instance
+   */
+  phyType?: $Values<typeof PhyType>;
+}
+
+/**
+ * Connection specific options to be passed before connection happen. [Not used]
+ */
+export interface ConnectionOptions {
+  /**
+   * Whether to directly connect to the remote device (false) or to automatically connect as soon as the remote device
+   * becomes available (true). [Android only]
+   * @memberof ConnectionOptions
+   * @instance
+   */
+  autoConnect?: boolean;
+
+  /**
+   * Whether MTU size will be negotiated to this value. It is not guaranteed to get it after connection is successful.
+   *
+   * @memberof ConnectionOptions
+   * @instance
+   */
+  requestMTU?: number;
+
+  /**
+   * Whether action will be taken to reset services cache. This option may be useful when a peripheral's firmware was
+   * updated and it's services/characteristics were added/removed/altered. [Android only]
+   * {@link https://stackoverflow.com/questions/22596951/how-to-programmatically-force-bluetooth-low-energy-service-discovery-on-android}
+   * @memberof ConnectionOptions
+   * @instance
+   */
+  refreshGatt?: RefreshGattMoment;
+
+  /**
+   * Number of milliseconds after connection is automatically timed out. In case of race condition were connection is
+   * established right after timeout event, device will be disconnected immediately. Time out may happen earlier then
+   * specified due to OS specific behavior.
+   *
+   * @memberof ConnectionOptions
+   * @instance
+   */
+  timeout?: number;
+}
+
+/**
+ * Device Bluetooth Low Energy state. It's keys are used to check {@link #blemanagerstate} values
+ * received by {@link BleManager}
+ */
+export const State = {
+  /**
+   * The current state of the manager is unknown; an update is imminent.
+   */
+  Unknown: 'Unknown',
+  /**
+   * The connection with the system service was momentarily lost; an update is imminent.
+   */
+  Resetting: 'Resetting',
+  /**
+   * The platform does not support Bluetooth low energy.
+   */
+  Unsupported: 'Unsupported',
+  /**
+   * The app is not authorized to use Bluetooth low energy.
+   */
+  Unauthorized: 'Unauthorized',
+  /**
+   * Bluetooth is currently powered off.
+   */
+  PoweredOff: 'PoweredOff',
+  /**
+   * Bluetooth is currently powered on and available to use.
+   */
+  PoweredOn: 'PoweredOn'
+}
+
+/**
+ * Native module logging log level. By default it is set to None.
+ * @name LogLevel
+ */
+export const LogLevel = {
+  /**
+   * Logging in native module is disabled
+   */
+  None: 'None',
+  /**
+   * All logs in native module are shown
+   */
+  Verbose: 'Verbose',
+  /**
+   * Only debug logs and of higher importance are shown in native module.
+   */
+  Debug: 'Debug',
+  /**
+   * Only info logs and of higher importance are shown in native module.
+   */
+  Info: 'Info',
+  /**
+   * Only warning logs and of higher importance are shown in native module.
+   */
+  Warning: 'Warning',
+  /**
+   * Only error logs and of higher importance are shown in native module.
+   */
+  Error: 'Error'
+}
+
+/**
+ * Connection priority of BLE link determining the balance between power consumption and data throughput.
+ * @name ConnectionPriority
+ */
+export const ConnectionPriority = {
+  /**
+   * Default, recommended option balanced between power consumption and data throughput.
+   */
+  Balanced: 0,
+  /**
+   * High priority, low latency connection, which increases transfer speed at the expense of power consumption.
+   */
+  High: 1,
+  /**
+   * Low power, reduced data rate connection setup.
+   */
+  LowPower: 2
+}