Alexa.Gadget.StateListenerインターフェース



Alexa.Gadget.StateListenerインターフェース

このインターフェースは、ガジェットに以下のEchoデバイスレベルの機能を提供します。

  • アラート(アラーム、タイマー、リマインダー)の設定と消去。
  • ウェイクワードの検出。Echoデバイスの「トーク」またはマイクボタンを押しても、ウェイクワードの検出は行われないことに注意してください。
  • (ベータ)Echoデバイスからの時刻情報。これは30分ごとに送信されます。

このインターフェースのサポート

このインターフェースをサポートするには、Capabilitiesの配列に以下のエントリを含むDiscover.Responseイベントを使用して、EchoデバイスのDiscoverディレクティブにガジェットから応答を返す必要があります。

{
   "type": "AlexaInterface",
   "interface": "Alexa.Gadget.StateListener",
   "version": "1.0",
   "configurations": {
      "supportedTypes":[
       {
          "name":"alarms"
       },
       {
          "name":"timers"
       },         
       {
          "name":"reminders"
       },        
       {
          "name":"wakeword"
       },    
       {
          "name":"timeinfo"
       }                
      ]
   }
 }

ディレクティブ

このインターフェースには、以下に説明する1つのディレクティブ (StateUpdate)が含まれます。

StateUpdateディレクティブ

このディレクティブは、通信を行うEchoデバイスのステータス情報をガジェットに提供します。.protoファイルの記述は次のとおりです。

message StateUpdateDirectiveProto {
   Directive directive = 1;
   message Directive {
      alexaGadgetStateListener.StateUpdateDirectivePayloadProto payload = 2;
      header.DirectiveHeaderProto header = 1;
   }
}

message DirectiveHeaderProto {
   string namespace = 1; 
   string name = 2; 
   string messageId = 3; 
   string dialogRequestId = 4;      
}

message StateUpdateDirectivePayloadProto {
   repeated States states = 1;
   message States {
      string name = 1;
      string value = 2;
   }
}

StateUpdateDirectiveProto

このメッセージのフィールドは次のとおりです。

フィールド 説明
directive StateUpdateディレクティブの全文が含まれます。 Directive

Directive

このメッセージのフィールドは次のとおりです。

フィールド 説明
header このディレクティブのヘッダーが含まれます。 DirectiveHeaderProto
payload このディレクティブのペイロードが含まれます。 StateUpdateDirectivePayloadProto

DirectiveHeaderProto

このメッセージのフィールドは次のとおりです。

フィールド 説明
namespace このディレクティブの名前空間で、Alexa.Gadget.StateListenerが入ります。 文字列
name このディレクティブの名前で、StateUpdateが入ります。 文字列
messageId このディレクティブのインスタンスを一意に定義するIDです。文字列は空の場合があります。 文字列
dialogRequestId このディレクティブをユーザーからの特定の音声対話に関連付ける一意のIDです。このフィールドは省略可能です。 文字列

StateUpdatePayloadProto

このメッセージのフィールドは次のとおりです。

フィールド 説明
states 状態のタイプと値を指定する名前と値のペアです。名前は、alarmsなどの状態のタイプです。値は、clearedなどの状態の値です。 States

States

このメッセージのフィールドは次のとおりです。

フィールド 説明
name 状態の型です。

有効な値は、alarmstimersreminderswakewordtimeinfo(ベータ)です。
文字列
value 状態の値です。これは、状態の型によって異なります。

namealarmstimersreminderswakewordの状態の場合、有効な値はactiveclearedになります。

timeinfoの状態の場合、値はISO 8601形式のEchoデバイスの時刻を含む文字列になります。
文字列