Alertsインターフェース（ベータ）



このインターフェースは、特定の時刻または経過時間のタイマー、アラーム、リマインダーを設定したり、設定されたタイマーを削除するようガジェットに指示するディレクティブを提供します。

• このインターフェースのサポート
• ディレクティブ
  • SetAlertディレクティブ
    • メッセージ定義
    • フィールドの説明
  • DeleteAlertディレクティブ
    • メッセージ定義
    • フィールドの説明

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

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

{
   "type": "AlexaInterface",
   "interface": "Alerts",
   "version": "1.1"
}

ディレクティブ

このインターフェースには、以下に説明する2つのディレクティブ （SetAlertとDeleteAlert）が含まれます。

SetAlertディレクティブ

このディレクティブは、特定の時刻または経過時間のタイマー、アラーム、リマインダーを設定するようガジェットに指示します。ガジェットは、以前に設定されたアラートがAlexaアプリを使って再度有効化された場合や、一時停止されたタイマーがAlexaアプリで再開された場合に、アラートを設定する音声リクエストの結果として、このディレクティブを受け取ります。

メッセージ定義

このディレクティブは、.protoファイルによって次のように定義されています。

directiveHeader.proto

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

alertsSetAlertDirective.proto

message SetAlertDirectiveProto {
   Directive directive = 1;
   message Directive {
      alerts.SetAlertDirectivePayloadProto payload = 2;
      header.DirectiveHeaderProto header = 1;
   }
}

alertsSetAlertDirectivePayload.proto

message SetAlertDirectivePayloadProto {
   repeated string assetPlayOrder = 5;
   int32 loopPauseInMilliSeconds = 8;
   string scheduledTime = 3;
   repeated Assets assets = 4;
   message Assets {
      string assetId = 1;
      string url = 2;
   }
   int32 loopCount = 7;
   string backgroundAlertAsset = 6;
   string type = 2;
   string token = 1;
}

フィールドの説明

このディレクティブには以下のフィールドが含まれています。

ヘッダーフィールド

ペイロードフィールド

以下の表のフィールドのうち、ガジェットでは現在、scheduledTime、type、tokenのみを受取ります。

DeleteAlertディレクティブ

このディレクティブは、既存のアラートを削除するようガジェットに指示します。ガジェットは、以前に設定されたアラートがAlexaアプリを使って削除された場合や、タイマーがAlexaアプリで一時停止された場合に、タイマー、アラーム、リマインダーをキャンセルまたは削除する音声リクエストの結果として、このディレクティブを受け取ります。

メッセージ定義

このディレクティブは、.protoファイルによって次のように定義されています。

directiveHeader.proto

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

alertsDeleteAlertDirective.proto

message DeleteAlertDirectiveProto {
   Directive directive = 1;
   message Directive {
      alerts.DeleteAlertDirectivePayloadProto payload = 2;
      header.DirectiveHeaderProto header = 1;
   }
}

alertsDeleteAlertDirectivePayload.proto

message DeleteAlertDirectivePayloadProto {
   string token = 1;
}

フィールドの説明

このディレクティブには以下のフィールドが含まれています。

ヘッダーフィールド

ペイロードフィールド