Notificationsインターフェース
このインターフェースでは、Alexaドメインまたは有効なAlexaスキルから新しいコンテンツが提供されていることを、ガジェットからユーザーに通知できます。このインターフェースは、ユーザーへの視覚および音声インジケーターを設定および消去するようガジェットに指示する2つのディレクティブを提供します。
このインターフェースでは、通知の内容は指定しません。新しいコンテンツが利用可能であることをユーザーに通知するためにガジェットで使用できる、視覚および音声インジケーターとしてのみ機能します。たとえば、ユーザーが「アレクサ、何か通知はある?」と言って保留中の通知を取得する場合、ガジェットは黄色のLEDを点滅させ、音声ファイルを再生します。
このインターフェースのサポート
このインターフェースをサポートするには、Capabilities
の配列に以下のエントリを含むDiscover.Response
イベントを使用して、EchoデバイスのDiscover
ディレクティブにガジェットから応答を返す必要があります。
{
"type": "AlexaInterface",
"interface": "Notifications",
"version": "1.0"
}
ディレクティブ
このインターフェースには、以下に説明する2つのディレクティブ (SetIndicator
とClearIndicator
)が含まれます。
SetIndicatorディレクティブ
通知がある場合に視覚および音声インジケーターを出力するよう、ガジェットに指示するディレクティブです。.protoファイルの記述は次のとおりです。
message SetIndicatorDirectiveProto {
Directive directive = 1;
message Directive {
notifications.SetIndicatorDirectivePayloadProto payload = 2;
header.DirectiveHeaderProto header = 1;
}
}
message DirectiveHeaderProto {
string namespace = 1;
string name = 2;
string messageId = 3;
string dialogRequestId = 4;
}
message SetIndicatorDirectivePayloadProto {
bool persistVisualIndicator = 1;
bool playAudioIndicator = 2;
Asset asset = 3;
message Asset {
string assetId = 1;
string url = 2;
}
}
SetIndicatorDirectiveProto
このメッセージのフィールドは次のとおりです。
フィールド | 説明 | 型 |
---|---|---|
directive |
完全なSetIndicator ディレクティブが含まれます。 |
Directive |
Directive
このメッセージのフィールドは次のとおりです。
フィールド | 説明 | 型 |
---|---|---|
header |
このディレクティブのヘッダーが含まれます。 | DirectiveHeaderProto |
payload |
このディレクティブのペイロードが含まれます。 | SetIndicatorDirectivePayloadProto |
DirectiveHeaderProto
このメッセージのフィールドは次のとおりです。
フィールド | 説明 | 型 |
---|---|---|
namespace |
このディレクティブの名前空間で、Notifications が入ります。 |
文字列 |
name |
このディレクティブの名前で、SetIndicator が入ります。 |
文字列 |
messageId |
このディレクティブのインスタンスを一意に定義するIDです。文字列は空の場合があります。 | 文字列 |
dialogRequestId |
このディレクティブをユーザーからの特定の音声対話に関連付ける一意のIDです。このフィールドは省略可能です。 | 文字列 |
SetIndicatorDirectivePayloadProto
このメッセージのフィールドは次のとおりです。
フィールド | 説明 | 型 |
---|---|---|
persistVisualIndicator |
視覚インジケーターを継続して点灯するようガジェットに指示します。 | ブール値 |
playAudioIndicator |
音声インジケーターを再生するようガジェットに指示します。 | ブール値 |
asset |
playAudioIndicator がtrueの場合、ガジェットが再生する音声アセットに関する情報が含まれます。 |
Asset |
Asset
このメッセージのフィールドは次のとおりです。
フィールド | 説明 | 型 |
---|---|---|
assetId |
ダウンロードされる音声アセットです。現在は空の文字列です。 | 文字列 |
url |
ダウンロード対象のアセットのURLです。現在は空の文字列です。 | 文字列 |
ClearIndicatorディレクティブ
有効な視覚および音声インジケーターをすべて消去するよう、ガジェットに指示するディレクティブです。.protoファイルの記述は次のとおりです。
message ClearIndicatorDirectiveProto {
Directive directive = 1;
message Directive {
notifications.ClearIndicatorDirectivePayloadProto payload = 2;
header.DirectiveHeaderProto header = 1;
}
}
message DirectiveHeaderProto {
string namespace = 1;
string name = 2;
string messageId = 3;
string dialogRequestId = 4;
}
message ClearindicatorDirectivePayloadProto {
}
ClearindicatorDirectiveProto
このメッセージのフィールドは次のとおりです。
フィールド | 説明 | 型 |
---|---|---|
directive |
完全なClearIndicator ディレクティブが含まれます。 |
Directive |
Directive
このメッセージのフィールドは次のとおりです。
フィールド | 説明 | 型 |
---|---|---|
header |
このディレクティブのヘッダーが含まれます。 | DirectiveHeaderProto |
payload |
このディレクティブのペイロードが含まれます。 | ClearindicatorDirectivePayloadProto |
DirectiveHeaderProto
このメッセージのフィールドは次のとおりです。
フィールド | 説明 | 型 |
---|---|---|
namespace |
このディレクティブの名前空間で、Notifications が入ります。 |
文字列 |
name |
このディレクティブの名前で、ClearIndicator が入ります。 |
文字列 |
messageId |
このディレクティブのインスタンスを一意に定義するIDです。文字列は空の場合があります。 | 文字列 |
dialogRequestId |
このディレクティブをユーザーからの特定の音声対話に関連付ける一意のIDです。このフィールドは省略可能です。 | 文字列 |
ClearindicatorDirectivePayloadProto
このメッセージにはフィールドがありません。