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
Native
Skip to main content
Facilitates updating an application’s login status.

Extends

  • KeplerTurboModule

Properties

setupAccountLoginServer

setupAccountLoginServer: () => Promise<Object>
Sets up the native AccountLoginServer.

Returns

Promise<Object> Promise<Object> A promise that resolves with the setup result.

updateStatus

updateStatus: (loginStatus: number, additionalData: string) => Promise<Object>
Update Login Status.

Parameters

loginStatus
number Specifies the login status. When set to 1, indicates logged in; when set to 0, indicates logged out.
additionalData
string Specifies additional data to include with the status update.

Returns

Promise<Object> Promise<Object> A promise that resolves with the update result.

setHandlerForComponent

setHandlerForComponent: (readStatusHandler: (onSuccess: (loginStatus: number, additionalData: string) => void, onError: (msg: string) => void) => void, getSetupPinHandler: (accountId: string, onSuccess: (pin: string) => void, onError: (msg: string) => void) => void, loginHandler: (accountId: string, pin: string, onSuccess: () => void, onError: (msg: string) => void) => void, logoutHandler: (onSuccess: () => void, onError: (msg: string) => void) => void, componentInstance: Object) => Promise<Object>
Registers handlers for a specific component to execute when provider requests are received. Each handler receives HostCallbacks from native to respond directly.

Parameters

readStatusHandler
(onSuccess: (loginStatus: number, additionalData: string) => void, onError: (msg: string) => void) => void Invoked on login status reads.
getSetupPinHandler
(accountId: string, onSuccess: (pin: string) => void, onError: (msg: string) => void) => void Invoked on get setup pin requests.
loginHandler
(accountId: string, pin: string, onSuccess: () => void, onError: (msg: string) => void) => void Invoked on login requests.
logoutHandler
(onSuccess: () => void, onError: (msg: string) => void) => void Invoked on logout requests.
componentInstance
Object The component instance to register to.

Returns

Promise<Object> Promise<Object> A promise that resolves with the registration result.

setHandler

setHandler: (readStatusHandler: (onSuccess: (loginStatus: number, additionalData: string) => void, onError: (msg: string) => void) => void, getSetupPinHandler: (accountId: string, onSuccess: (pin: string) => void, onError: (msg: string) => void) => void, loginHandler: (accountId: string, pin: string, onSuccess: () => void, onError: (msg: string) => void) => void, logoutHandler: (onSuccess: () => void, onError: (msg: string) => void) => void) => Promise<Object>
Registers handlers for provider requests without a component instance (legacy path).

Parameters

readStatusHandler
(onSuccess: (loginStatus: number, additionalData: string) => void, onError: (msg: string) => void) => void
getSetupPinHandler
(accountId: string, onSuccess: (pin: string) => void, onError: (msg: string) => void) => void
loginHandler
(accountId: string, pin: string, onSuccess: () => void, onError: (msg: string) => void) => void
logoutHandler
(onSuccess: () => void, onError: (msg: string) => void) => void

Returns

Promise<Object>

getMajorVersion

getMajorVersion: () => number
Gets the major version number.

Returns

number number The major version number.

getMinorVersion

getMinorVersion: () => number
Gets the minor version number.

Returns

number number The minor version number.

getPatchVersion

getPatchVersion: () => number
Gets the patch version number.

Returns

number number The patch version number.
Last modified on August 25, 2026