capacitor-nearby v3.2.1

@capacitor-community/capacitor-nearby

Uses Bluetooth LE to scan and advertise for nearby devices

Install

npm install @capacitor-community/capacitor-nearby
npx cap sync

API

• initialize(...)
• reset()
• publish(...)
• unpublish()
• subscribe(...)
• unsubscribe()
• status()
• addListener('onPermissionChanged', ...)
• addListener('onBluetoothStateChanged', ...)
• addListener('onFound', ...)
• addListener('onLost', ...)
• addListener('onPublishExpired', ...)
• addListener('onSubscribeExpired', ...)
• Interfaces
• Type Aliases
• Enums

initialize(...)

initialize(options: InitializeOptions) => Promise<void>

Initializes Bluetooth LE for advertising and scanning of nearby tokens.

Since: 1.0.0

reset()

reset() => Promise<void>

Stops and resets advertising and scanning of nearby tokens.

Since: 1.0.0

publish(...)

publish(options: PublishOptions) => Promise<void>

Start publishing nearby token.

Since: 1.0.0

unpublish()

unpublish() => Promise<void>

Stop publishing nearby token.

Since: 1.0.0

subscribe(...)

subscribe(options: SubscribeOptions) => Promise<void>

Start listening to nearby tokens.

Since: 1.0.0

unsubscribe()

unsubscribe() => Promise<void>

Stop listening to nearby tokens.

Since: 1.0.0

status()

status() => Promise<Status>

Returns status of operations and found tokens.

Returns: Promise<Status>

Since: 1.0.0

addListener('onPermissionChanged', ...)

addListener(eventName: 'onPermissionChanged', listenerFunc: (granted: boolean) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Called when permission is granted or revoked for this app to use Nearby.

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

addListener('onBluetoothStateChanged', ...)

addListener(eventName: 'onBluetoothStateChanged', listenerFunc: (state: BluetoothState) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Called when state of Bluetooth has changed.

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

addListener('onFound', ...)

addListener(eventName: 'onFound', listenerFunc: BeaconCallback) => Promise<PluginListenerHandle> & PluginListenerHandle

Called when beacons are found.

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.1.0

addListener('onLost', ...)

addListener(eventName: 'onLost', listenerFunc: BeaconCallback) => Promise<PluginListenerHandle> & PluginListenerHandle

Called when a beacon is no longer detectable nearby.

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.1.0

addListener('onPublishExpired', ...)

addListener(eventName: 'onPublishExpired', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle

The published token has expired.

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

addListener('onSubscribeExpired', ...)

addListener(eventName: 'onSubscribeExpired', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle

The subscription has expired.

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

Interfaces

InitializeOptions

PublishOptions

SubscribeOptions

PluginListenerHandle

Type Aliases

UUID

string

Status

{ isPublishing: boolean; isSubscribing: boolean; uuids: UUID[]; }

BeaconCallback

(uuid: string, rssi?: string | number): void

Enums

ScanMode

AdvertiseMode

TxPowerLevel

TTLSeconds

BluetoothState