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：メッセージハンドラーがメッセージを処理するのを待機する将来のタイムスタンプ。

パラメーター

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

number

戻り値

Promise<void>

例

// 例： クライアントアプリケーションのメッセージハンドラー。const ハンドラー： AmazonDeviceMessagingHandler = handleOnMessage( message: AmazonDeviceMessagingMessage, ): Promise // 受信メッセージを処理します。 // メッセージ処理に基づいてエラーを返すかスローします。

, ;

// メッセージハンドラーwrapHandleOnMessage(handler, md5: 'md5', data: 'key': 'value', 'messageId')でのラッパーメソッドの使用

Last updated: 2026年7月22日