default

コンストラクタ

new default()

new default(): default

戻り値

default

メソッド

getMajorVersion()

static getMajorVersion(): number

戻り値

number

getMinorVersion()

static getMinorVersion(): number

戻り値

number

getPatchVersion()

static getPatchVersion(): number

戻り値

number

registerAsync()

static registerAsync(): Promise<string>

クライアントアプリをADMクラウドに登録して、アプリがADMメッセージを受信できるようにします。

戻り値

Promise<string>

アプリの登録IDの取得元となるPromise。

スロー

.エラーメッセージ付きのデフォルト例外。

registerHandler()

static registerHandler(handler): void

メッセージハンドラーをAmazonDeviceMessagingServerに登録します。このハンドラーは、受信したADMメッセージを処理するために呼び出されます。

@param[in] handler：クライアントアプリのメッセージハンドラー。

パラメーター

handler

AmazonDeviceMessagingHandler

戻り値

void

subscribeToTopicAsync()

static subscribeToTopicAsync(topic): Promise<void>

トピックベースのメッセージングで、クライアントアプリがトピックをサブスクライブするようにします。アプリはこのトピックに送信されたADMメッセージを受信します。

@param[in] topic：サブスクライブ対象のトピック。

パラメーター

topic

string

戻り値

Promise<void>

スロー

.エラーメッセージ付きのデフォルト例外。

スロー

.トピック名がパターン（[a-zA-Z0-9-_.~%]{1,100}）に従っていない場合

unregisterAsync()

static unregisterAsync(): Promise<string>

ADMクラウドからクライアントアプリの登録を解除します。アプリはADMメッセージを受信しなくなります。

戻り値

Promise<string>

以前の（現在は未登録の）登録IDの取得元となるPromise。

スロー

.エラーメッセージ付きのデフォルト例外。

unsubscribeFromTopicAsync()

static unsubscribeFromTopicAsync(topic): Promise<void>

トピックベースのメッセージングで、クライアントアプリによるトピックのサブスクライブを解除します。アプリはこのトピックに送信されるADMメッセージの受信を停止します。

@param[in] topic：サブスクライブ解除対象のトピック。

パラメーター

topic

string

戻り値

Promise<void>

waitForMessageHandlerCompletionAsync()

static waitForMessageHandlerCompletionAsync(timestamp): Promise<Object>

メッセージ処理の完了を待つために使用されるメソッド。

@param[in] timestamp：メッセージハンドラーによるメッセージ処理を待機するための将来のタイムスタンプ。

パラメーター

timestamp

Date

戻り値

Promise<Object>

wrapHandleOnMessage()

static wrapHandleOnMessage(handler, message, id): 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 handler: AmazonDeviceMessagingHandler = {
  handleOnMessage(message: AmazonDeviceMessagingMessage): Promise<void> {
    // 受信メッセージを処理する
    // メッセージ処理に基づいてエラーを返すかスローする
  },
};

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

Last updated: 2025年10月2日