Amazon Developer

as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
Ring
AWS
Documentation
Support
Contact Us
My Cases
Get Started
Design and Develop
Publish
Reference
Support
Skip to main content

Extends

  • KeplerTurboModule

Properties

addAdvertisingIdListener()

addAdvertisingIdListener: (callback) => Promise<number> Note: Currently, this method is not supported. Registers a callback function to be notified when the advertising ID changes.

Parameters

callback
(newId) => void A function that will be called with the new UUID when the advertising ID changes

Returns

Promise<number> A Promise that resolves to a subscription key (number) which can be used to unsubscribe

addFriendlyDeviceNameListener()

addFriendlyDeviceNameListener: (callback) => Promise<number> Note: Currently, this method is not supported. Registers a callback function to be notified when the friendly device name changes.

Parameters

callback
(newName) => void A function that will be called with the new name when the device name changes

Returns

Promise<number> A Promise that resolves to a subscription key (number) which can be used to unsubscribe

addVendorTrackingIdListener()

addVendorTrackingIdListener: (callback) => Promise<number> Note: Currently, this method is not supported. Registers a callback function to be notified when the vendor tracking ID changes.

Parameters

callback
(newId) => void A function that will be called with the new UUID when the vendor tracking ID changes

Returns

Promise<number> A Promise that resolves to a subscription key (number) which can be used to unsubscribe

disableAdvertisingId()

disableAdvertisingId: () => Promise<void> Note: Currently, this method is not supported.

Returns

Promise<void>

disableVendorTrackingId()

disableVendorTrackingId: () => Promise<void> Note: Currently, this method is not supported.

Returns

Promise<void>

enableAdvertisingId()

enableAdvertisingId: () => Promise<void> Note: Currently, this method is not supported.

Returns

Promise<void>

enableVendorTrackingId()

enableVendorTrackingId: () => Promise<void> Note: Currently, this method is not supported.

Returns

Promise<void>

generateUuidV4()

generateUuidV4: () => Uuid

Returns

Uuid

getAdvertisingId()

getAdvertisingId: () => Promise<Uuid> Note: Currently, this method is not supported.

Returns

Promise<Uuid>

getConstants()?

readonly optional getConstants: () => object

Returns

object

Inherited from

KeplerTurboModule.getConstants

getFriendlyDeviceName()

getFriendlyDeviceName: () => Promise<string>

Returns

Promise<string>

getMajorVersion()

readonly getMajorVersion: () => number

Returns

number

Inherited from

KeplerTurboModule.getMajorVersion

getMinorVersion()

readonly getMinorVersion: () => number

Returns

number

Inherited from

KeplerTurboModule.getMinorVersion

getPatchVersion()

readonly getPatchVersion: () => number

Returns

number

Inherited from

KeplerTurboModule.getPatchVersion

getUserAgent()

getUserAgent: () => Promise<string>

Returns

Promise<string>

getVendorTrackingId()

getVendorTrackingId: () => Promise<Uuid>

Returns

Promise<Uuid>

resetAdvertisingId()

resetAdvertisingId: () => Promise<void> Note: Currently, this method is not supported.

Returns

Promise<void>

resetVendorTrackingId()

resetVendorTrackingId: () => Promise<boolean> Currently the return type of boolean is a workaround due to unavailability of no argument acceptable datatype parameters in TMAPI promise->resolve. JIRA : PROJVEGA-240725

Returns

Promise<boolean>

setFriendlyDeviceName()

setFriendlyDeviceName: (name) => Promise<boolean> Currently the return type of boolean is a workaround due to unavailability of no argument acceptable datatype parameters in TMAPI promise->resolve. JIRA : PROJVEGA-240725

Parameters

name
string

Returns

Promise<boolean>

unsubscribe()

unsubscribe: (type, key) => void Unsubscribes from a listener previously registered. This method removes the callback and cleans up associated resources.

Parameters

type
number The type of listener to unsubscribe from.
key
number The subscription key returned when registering the listener.

Returns

void
Last modified on October 2, 2025