Constructors
new AmazonDeviceMessagingServer()
new AmazonDeviceMessagingServer(): AmazonDeviceMessagingServer
Returns
AmazonDeviceMessagingServerMethods
getMajorVersion()
staticgetMajorVersion():number
Returns
number
getMinorVersion()
staticgetMinorVersion():number
Returns
number
getPatchVersion()
staticgetPatchVersion():number
Returns
number
registerAsync()
Register the client app with the ADM cloud, allowing the app to receive ADM messages. A Promise from which the app’s registration ID can be retrieved.staticregisterAsync():Promise<string>
Throws
AmazonDeviceMessagingError. Default exception with an error message.
Returns
Promise<string>
registerHandler()
Register a message handler with the AmazonDeviceMessagingServer. This handler will be invoked to handle incoming ADM messages.staticregisterHandler(handler: AmazonDeviceMessagingHandler):void
Parameters
handler
AmazonDeviceMessagingHandler The client app’s message handler.subscribeToTopicAsync()
Subscribe the client app to a topic for topic-based messaging. The app will receive ADM messages sent to this topic.staticsubscribeToTopicAsync(topic:string):Promise<void>
Parameters
topic
string
The topic to subscribe to.
Throws
AmazonDeviceMessagingError. Default exception with an error message.InvalidArgumentError. If topic name doesn’t follow the pattern [a-zA-Z0-9-_.~%]{1,100}
Returns
Promise<void>
unregisterAsync()
Unregister the client app from the ADM cloud. The app will no longer receive ADM messages. A Promise from which the previous (now unregistered) registration ID can be retrieved.staticunregisterAsync():Promise<string>
Throws
AmazonDeviceMessagingError. Default exception with an error message.
Returns
Promise<string>
unsubscribeFromTopicAsync()
Unsubscribe the client app from a topic for topic-based messaging. The app will stop receiving ADM messages sent to this topic.staticunsubscribeFromTopicAsync(topic:string):Promise<void>
Parameters
topic
string
The topic to unsubscribe from.
Returns
Promise<void>
waitForMessageHandlerCompletionAsync()
Method used to wait for the completion of message handling.staticwaitForMessageHandlerCompletionAsync(timestamp:Date):Promise<Object>
Parameters
timestamp
Date
Returns
Promise<Object>
wrapHandleOnMessage()
A wrapper method that waits for the client applications’ message handler to handle the ADM message, and resolves/rejects the promise correlated to the message based on the response from the handler.staticwrapHandleOnMessage(handler: AmazonDeviceMessagingHandler, message: AmazonDeviceMessagingMessage, id:number):Promise<void>
Parameters
handler
AmazonDeviceMessagingHandlermessage
AmazonDeviceMessagingMessageid
number
Returns
Promise<void>
