Amazon Developer

Console

as

Settings
Sign out
Notifications
Alexa
Amazonアプリストア
AWS
ドキュメント
Support
Contact Us
My Cases

Console

as

開発
設計と開発
公開
リファレンス
サポート

@amazon-devices/kepler-amazon-device-messaging

@amazon-devices/kepler-amazon-device-messaging

このライブラリを使用すると、Kepler向けReact NativeアプリのAmazon Device Messagingサービス機能を有効にできます。Amazon Device Messaging（ADM）を使用すると、アプリを実行しているAmazonデバイスにメッセージを送信し、クラウドサービスから、Amazonデバイスにインストールされているアプリにメッセージを配信できます。

開始の手順

セットアップ

  1. package.jsonファイルのdependenciesセクションに、以下のライブラリ依存関係を追加します。

    クリップボードにコピーしました。

       "@amazon-devices/kepler-amazon-device-messaging": "~1.0.0",
   "@amazon-devices/headless-task-manager": "~0.1.0",

  2. ADMにアクセスするには、manifest.tomlに以下の権限とサービスを追加します。

    クリップボードにコピーしました。

     [needs]

 [[needs.privilege]]
 id = "com.amazon.device-messaging.privilege.access"

 [wants]

 [[wants.module]]
 id = "/com.amazon.ace.messaging.service@IDeviceMessaging"

 [[wants.service]]
 id = "com.amazon.ace.messaging.service"

使用方法

Amazon Device Messagingサービスを使用するには、次のことを行う必要があります。

  • manifest.tomlファイルでコンポーネントとプロセスを宣言します。
  • App.tsファイル内のサービスにアプリを登録します。
  • タスクの実行を処理するコードを追加します。
  • ADMメッセージを登録して処理するコードを追加します。

  1. manifest.tomlで、ADMメッセージを受信するヘッドレスタスクを宣言します。コンポーネントIDとして、<packageId>.amazon-device-messaging-receiverを使用します。

    重要： <packageId>を特定のパッケージIDに置き換えてください。

    クリップボードにコピーしました。

     [components]

 [[components.task]]
   id = "<packageId>.amazon-device-messaging-receiver"
   runtime-module = "/com.amazon.kepler.keplerscript.runtime.loader_2@IKeplerScript_2_0"

 [processes]

 [[processes.group]]
 component-ids = ["<packageId>.amazon-device-messaging-receiver"]

  2. App.tsで、アプリをデバイスメッセージングサービスに登録し、登録IDを受け取ります。

    クリップボードにコピーしました。

     import {
   AmazonDeviceMessagingMessage,
   AmazonDeviceMessagingServer,
   AmazonDeviceMessagingHandler,
 } from '@amazon-devices/kepler-amazon-device-messaging';

 export const App = () => {
 const register = async () => {
     try {
       console.log('registerAsyncの呼び出し');
       const registrationId: string =
         await AmazonDeviceMessagingServer.registerAsync();
       console.log('登録ID：' + registrationId);
     } catch (error) {
       console.error('登録に失敗しました：', error);
     }
   }
 };

  3. task.jsを作成し、HeadlessTaskをHeadlessEntryPointRegistryに登録します。

    クリップボードにコピーしました。

     import { HeadlessEntryPointRegistry } from "@amazon-devices/headless-task-manager";

 import { doTask } from "./src/AdmHeadlessTask";

 HeadlessEntryPointRegistry.registerHeadlessEntryPoint("com.amazon.device_messaging.sample.amazon-device-messaging-receiver::doTask",
   () => doTask);

  4. AdmHeadlessTask.tsファイルを作成します。このファイルの基本構造は次のような形式になります。

    クリップボードにコピーしました。

     class AdmHeadlessTask {

   async doTask(): Promise<void> {
     console.log('ヘッドレスタスクを開始しました');
     return Promise.resolve();
   }
 }

 const AdmHeadlessTaskInstance = new AdmHeadlessTask();

 export const doTask = (): Promise<void> => {
   return AdmHeadlessTaskInstance.doTask();
 };

  5. AdmHeadlessTask.tsで、ヘッドレスタスクに、ADMメッセージを処理するためのAmazonDeviceMessagingHandlerインターフェイスを実装します。

    クリップボードにコピーしました。

     import {
     AmazonDeviceMessagingServer,
     AmazonDeviceMessagingHandler,
     AmazonDeviceMessagingMessage,
   } from '@amazon-devices/kepler-amazon-device-messaging';
   .
   .
   .
   const handler: AmazonDeviceMessagingHandler = {
     handleOnMessage(message: AmazonDeviceMessagingMessage): Promise<void> {
       // メッセージを処理します
       console.log(
         'アプリが受信したADMメッセージ = ' + JSON.stringify(message.data),
       );
       console.log(
         'アプリが受信したADM通知 = ' + JSON.stringify(message.notification),
       );
       return Promise.resolve();
     },
   };

  6. ハンドラーを引数としてAdmHeadlessTaskに渡します。

    クリップボードにコピーしました。

     class AdmHeadlessTask {
   private handler: AmazonDeviceMessagingHandler;
   constructor(handler: AmazonDeviceMessagingHandler) {
     this.handler = handler;
   }
   .
   .
   .
 }

  7. AmazonDeviceMessagingServer.registerHandler()を呼び出して、handlerと名付けたAmazonDeviceMessagingHandlerの実装を登録します。

    クリップボードにコピーしました。

     class AdmHeadlessTask {
   .
   .
   .
   async doTask(): Promise<void> {
     console.log('ヘッドレスタスクを開始しました');
     AmazonDeviceMessagingServer.registerHandler(handler);
     return Promise.resolve();
   }
   .
   .
   .
 }

  8. registerHandlerメソッドを呼び出した後、waitForMessageHandlerCompletionAsyncを呼び出します。

    クリップボードにコピーしました。

     class AdmHeadlessTask {
   .
   .
   .
   async doTask(): Promise<void> {
     console.log('ヘッドレスタスクを開始しました');
     AmazonDeviceMessagingServer.registerHandler(handler);
     try {
       // メッセージ処理の完了を待機する最大時間を渡します。
       // waitパラメーターは現在より先のタイムスタンプであり、この例では
       // 現在の時刻から5000ミリ秒後です。
       await AmazonDeviceMessagingServer.waitForMessageHandlerCompletionAsync(
         new Date(Date.now() + 5 * 1000),
       );
     } catch (error) {
         console.error('エラー：', error);
     }
     return Promise.resolve();
   }
   .
   .
   .
 }

  9. waitForMessageHandlerCompletionAsyncの完了を待機します。メソッドがエラーをスローしない場合、メッセージが正常に処理されたことを示します。メッセージの処理中に問題が発生した場合、ADMはメッセージの配信を再試行しません。

注記：ハンドラーがwaitDuration内でメッセージを処理しなかったり、メッセージの処理に失敗したりすると、waitForMessageHandlerCompletionAsyncがエラーをスローすることがあります。ライフサイクルマネージャーに報告された問題を処理するかどうかは、アプリに任されます。

AdmHeadlessTask.tsの例

クリップボードにコピーしました。

import {
  AmazonDeviceMessagingMessage,
  AmazonDeviceMessagingServer,
  AmazonDeviceMessagingHandler,
} from '@amazon-devices/kepler-amazon-device-messaging';

class AdmHeadlessTask {
  private handler: AmazonDeviceMessagingHandler;
  constructor(handler: AmazonDeviceMessagingHandler) {
    this.handler = handler;
  }

  async doTask(): Promise<void> {
    console.log('ヘッドレスタスクを開始しました');
    AmazonDeviceMessagingServer.registerHandler(handler);
    try {
      // メッセージ処理の完了を待機する最大時間を渡します
      await AmazonDeviceMessagingServer.waitForMessageHandlerCompletionAsync(
        new Date(Date.now() + 5 * 1000),
      );
    } catch (error) {
        console.error('エラー：', error);
    }
    console.log('ヘッドレスタスクを完了しました');
    return Promise.resolve();
  }
}

const handler: AmazonDeviceMessagingHandler = {
  handleOnMessage(message: AmazonDeviceMessagingMessage): Promise<void> {
    console.log(
      'サンプルアプリが受信したメッセージ = ' + JSON.stringify(message.data),
    );
    console.log(
      'Sample APP received Notification = ' +
        JSON.stringify(message.notification),
    );
    return Promise.resolve();
  }
};

const admHeadlessTaskInstance = new AdmHeadlessTask(handler);

export const doTask = (): Promise<void> => {
  return admHeadlessTaskInstance.doTask();
};

クラス

モジュール

Last updated: 2025年10月2日

フォローする

サポート対象デバイス

amazon_developer_logo

© 2010-2025, Amazon.com, Inc. or its affiliates. All Rights Reserved. 無断複写·転載を禁じます。

利用規約

Amazon開発者ブログ

お問い合わせ