Class ScanSettings

Settings when scanning for Bluetooth devices via BluetoothCentralModule.startScan.

Hierarchy (View Summary)

ScriptObject
- ScanSettings

Index

Constructors

Properties

scanMode timeoutSeconds uniqueDevices

Methods

getTypeName isOfType isSame

Constructors

constructor

new ScanSettings(): ScanSettings
Returns ScanSettings
Overrides ScriptObject.constructor

Properties

`Experimental`scanMode

scanMode: ScanMode

Set the scanning method.

Snap OS

`Experimental`timeoutSeconds

timeoutSeconds: number

Set the scanning timeout duration in seconds. After the timeout period the scan will stop and the promise will resolve.

Snap OS

`Experimental`uniqueDevices

uniqueDevices: boolean

Specify whether to call the predicate function only for unique devices or not.

Snap OS

Methods

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from ScriptObject.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from ScriptObject.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from ScriptObject.isSame