AmazonDeviceMessagingServer

构造函数

new AmazonDeviceMessagingServer()

new AmazonDeviceMessagingServer(): AmazonDeviceMessagingServer

返回值

AmazonDeviceMessagingServer

方法

getMajorVersion()

static getMajorVersion(): number

返回值

number

---

getMinorVersion()

static getMinorVersion(): number

返回值

number

---

getPatchVersion()

static getPatchVersion(): number

返回值

number

---

registerAsync()

static registerAsync(): Promise<string>

在ADM云端上注册客户端应用，允许该应用接收ADM消息。

可检索应用注册ID的Promise。

抛出

• AmazonDeviceMessagingError.含有错误消息的默认异常。

返回值

Promise<string>

---

registerHandler()

static registerHandler(handler: AmazonDeviceMessagingHandler): void

在AmazonDeviceMessagingServer上注册消息处理器。该处理程序将用于处理传入的ADM消息。

param[in] handler 客户端应用的消息处理程序。

参数

handler

AmazonDeviceMessagingHandler

---

subscribeToTopicAsync()

static subscribeToTopicAsync(topic: string): Promise<void>

为客户端应用订阅主题，传递基于主题的消息。该应用将接收发送给此主题的ADM消息。

param[in] topic 要订阅的主题。

参数

topic

string

抛出

• AmazonDeviceMessagingError.含有错误消息的默认异常。
• InvalidArgumentError如果主题名称格式未遵循正则表达式模式[a-zA-Z0-9-_.~%]1,100

返回值

Promise<void>

---

unregisterAsync()

static unregisterAsync(): Promise<string>

注销ADM云端中注册的客户端应用。该应用将无法再接收ADM消息。

可检索之前注册（现已注销）的ID的Promise。

抛出

• AmazonDeviceMessagingError.含有错误消息的默认异常。

返回值

Promise<string>

---

unsubscribeFromTopicAsync()

static unsubscribeFromTopicAsync(topic: string): Promise<void>

取消客户端应用订阅的主题，不再接收相关消息。该应用将停止接收发送到该主题的ADM消息。

param[in] topic 要取消订阅的主题。

参数

topic

string

返回值

Promise<void>

---

waitForMessageHandlerCompletionAsync()

static waitForMessageHandlerCompletionAsync(timestamp: Date): Promise<Object>

用于等待消息处理完成的方法。

@param[in]时间戳。用于等待消息处理程序处理消息的未来时间戳。

参数

timestamp

Date

返回值

Promise<Object>

---

wrapHandleOnMessage()

static wrapHandleOnMessage(handler: AmazonDeviceMessagingHandler, message: AmazonDeviceMessagingMessage, id: number): Promise<void>

这是一种包装器方法，等待客户端应用程序的消息处理程序处理ADM消息，然后根据该处理程序的响应来解析/拒绝与消息相关的Promise。

param[in] handler。客户端应用程序的消息处理程序负责处理传入的消息。param[in] message。由客户端应用程序的消息处理程序处理的ADM消息。param[in] id。ADM消息专属标识符，用于标记处理完成的ADM消息。

参数

handler

AmazonDeviceMessagingHandler

message

AmazonDeviceMessagingMessage

id

数字

返回值

Promise<void>

示例

// 示例客户端应用程序的消息处理程序 const handler: AmazonDeviceMessagingHandler = handleOnMessage( message: AmazonDeviceMessagingMessage, ): Promise // 处理传入的消息 // 根据消息处理情况返回或抛出错误

// 使用消息处理程序的包装器方法 wrapHandleOnMessage(handler, md5: 'md5', data: 'key': 'value' , 'messageId');

---

Last updated: 2026年7月22日