WNSから受信したメッセージは端末アプリケーション側のプッシュ部品で受信し、通知領域に表示されます。
本機能は直接通知方式を採用しているためプッシュ部品側で受信メッセージの解析を行います。
受信されるPayloadはxml形式です。
Payloadでサポートするタグ情報は以下のとおりです。
要素 | 意味 | 設定 | 概要 | |
---|---|---|---|---|
wns | 必須 | WNS Payloadであることを示す要素 | ||
toast | トースト通知 | 任意 | Microsoftが取り決めたWNSのtoast要素が指定されます。toast要素は1つのみ指定可能とする。 | |
badge | バッジ通知 | 任意 | Microsoftが取り決めたWNSのbadge要素が指定されます。badge要素は1つのみ指定可能とする。 | |
tile | タイル通知 | 任意 | Microsoftが取り決めたWNSのtile要素が指定されます。tile要素は1つのみ指定可能とする。 |
注意
toast、badge、tile要素の詳細は、Microsoftの公式サイト(https://msdn.microsoft.com/en-us/library/windows/apps/br212853.aspx)を参照してください。要素 | 属性 | 設定 | 概要 | ||||
---|---|---|---|---|---|---|---|
toast | - | - | トースト通知を示す要素。 | ||||
- | launch | 任意 | トースト通知をクリックしたときに関連するアプリケーションに渡される文字列。特定URLへのアクセスや、メール送信等を行う際に指定する文字列。 例: http(s)://xxx.abc.jp、mailto:abcd.ef@xx.com |
||||
duration | 任意 | トースト通知が表示される時間を示す文字列。long(25秒)もしくはshort(7秒)を指定する。デフォルトはlongである。 | |||||
visual | - | - | トースト通知の表示形式を示す要素。 | ||||
- | version | 任意 | トースト通知のXMLスキーマのバージョン。 | ||||
lang | 任意 | ロケールを示す文字列。 | |||||
addImageQuery | 任意 | trueの場合、現在の倍率、コントラスト設定、ロケール情報がimage要素のURIへのクエリパラメータに自動的に追加される。falseの場合はクエリパラメータが追加されない。デフォルトはfalseである。
例えば、http://www.abc.xyz」がimage要素のsrc属性に指定された場合、実際には「http://www.abc.xyz?ms-scale=80&ms-contrast=standard&ms-lang=en-US」のようにWebサーバに要求される。 |
|||||
baseUri | 任意 | ベースになるURIを示す文字列。baseUriで指定した文字列は、各image要素のURIから省略できる。デフォルトは「ms-appx:///」
例えば、baseUriで「http:」を設定すると、各image要素のURIでは「http://www.abc.xyz」でなく「//www.abc.xyz」 と指定できる。 |
|||||
branding | 任意 | 未使用。 | |||||
binding | - | - | トースト通知のテンプレートと表示内容を関連付けている要素。 | ||||
- | template | 必須 | トースト通知で使用するテンプレート。 | ||||
fallback | 任意 | template属性で指定したテンプレートが見つからない場合に指定するテンプレート。 | |||||
lang | 任意 | ロケールを示す文字列。 | |||||
addImageQuery | 任意 | trueの場合、現在の倍率、コントラスト設定、ロケール情報がimage要素のURIへのクエリパラメータに自動的に追加される。falseの場合はクエリパラメータが追加されない。デフォルトはfalseである。
例えば、http://www.abc.xyz」がimage要素のsrc属性に指定された場合、実際には「http://www.abc.xyz?ms-scale=80&ms-contrast=standard&ms-lang=en-US」のようにWebサーバに要求される。 |
|||||
baseUri | 任意 | ベースになるURIを示す文字列。baseUriで指定した文字列は、各image要素のURIから省略できる。デフォルトは「ms-appx:///」
例えば、baseUriで「http:」を設定すると、各image要素のURIでは「http://www.abc.xyz」でなく「//www.abc.xyz」 と指定できる。 |
|||||
branding | 任意 | 未使用。 | |||||
image | - | - | トースト通知のテンプレートで使用されるイメージ要素。 | ||||
- | id | 必須 | image要素に付与するID。1から順に指定する。templateで指定したテンプレートに応じて各IDの画像が配置される。 | ||||
src | 必須 | イメージを示すURI文字列。 | |||||
alt | 任意 | イメージの説明。 | |||||
addImageQuery | 任意 | trueの場合、現在の倍率、コントラスト設定、ロケール情報がimage要素のURIへのクエリパラメータに自動的に追加される。falseの場合はクエリパラメータが追加されない。デフォルトはfalseである。
例えば、http://www.abc.xyz」がimage要素のsrc属性に指定された場合、実際には「http://www.abc.xyz?ms-scale=80&ms-contrast=standard&ms-lang=en-US」のようにWebサーバに要求される。 |
|||||
text | - | - | トースト通知のテンプレートで使用されるテキスト要素。 | ||||
- | id | 必須 | text要素に付与するID。1から順に指定する。templateで指定したテンプレートに応じて各IDの画像が配置される。 | ||||
lang | 任意 | ロケールを示す文字列。 | |||||
audio | - | - | トースト通知に伴うサウンド表現に関する要素。 | ||||
- | src | 任意 | 通知音データのURI。 | ||||
loop | 任意 | trueの場合は通知音の鳴動を繰り返す。falseの場合は繰り返さない。デフォルトはfalse。 | |||||
silent | 任意 | trueの場合は通知音をミュートする。falseの場合はミュートしない。デフォルトはfalse。 | |||||
commands | - | - | commandを束ねる要素。 | ||||
- | scenario | 任意 | 通知の実行目的を表わす。 | ||||
command | - | - | commands要素のsenario属性と関連づいた命令を表す要素。 | ||||
- | id | 任意 | commands要素のsenario属性と関連づいた文字列を指定する。 指定パターンは以下の通り。 ・scenarioがalarmの場合 は、 snoozeまたはdismissを指定する。 ・scenarioがincomingCallの場合は、video、voice、declineのいずれかを指定する。 |
||||
arguments | 任意 | 連携アプリに渡す引数文字列。 |
要素 | 属性 | 設定 | 概要 | |
---|---|---|---|---|
badge | - | - | バッジ通知を示す要素。 | |
- | value | 必須 | バッジに表示する数値("1"、"2"等)またはグリフ("activity"、"playing"等) 。また、Windows8.1では100以上を指定した場合バッジには「99+」と表示される。一方、Windows10では100以上でも省略せずにバッジ表示されるが「9999」が上限である。 | |
version | 任意 | バッジ通知のXMLスキーマのバージョン。 |
要素 | 属性 | 設定 | 概要 | ||||
---|---|---|---|---|---|---|---|
tile | - | - | タイル通知を示す要素。 | ||||
visual | - | - | タイル通知の表示形式を示す要素。 | ||||
- | version | 任意 | タイル通知のXMLスキーマのバージョン | ||||
lang | 任意 | ロケールを示す文字列。 | |||||
addImageQuery | 任意 | trueの場合、現在の倍率、コントラスト設定、ロケール情報がimage要素のURIへのクエリパラメータに自動的に追加される。falseの場合はクエリパラメータが追加されない。デフォルトはfalseである。
例えば、http://www.abc.xyz」がimage要素のsrc属性に指定された場合、実際には「http://www.abc.xyz?ms-scale=80&ms-contrast=standard&ms-lang=en-US」のようにWebサーバに要求される。 |
|||||
baseUri | 任意 | ベースになるURIを示す文字列。baseUriで指定した文字列は、各image要素のURIから省略できる。デフォルトは「ms-appx:///」
例えば、baseUriで「http:」を設定すると、各image要素のURIでは「http://www.abc.xyz」でなく「//www.abc.xyz」 と指定できる。 |
|||||
branding | 任意 | アプリの商標を指定する場合は、「none」「logo」「name」のいずれかを指定する。 | |||||
contentId | 任意 | 通知するコンテンツを一意に識別するために送信者側で定義する文字列。 | |||||
binding | - | - | タイル通知のテンプレートと表示内容を関連付けている要素。 | ||||
- | template | 必須 | タイル通知で使用するテンプレート。 | ||||
fallback | 任意 | template属性で指定したテンプレートが見つからない場合に指定するテンプレート。 | |||||
lang | 任意 | ロケールを示す文字列。 | |||||
addImageQuery | 任意 | trueの場合、現在の倍率、コントラスト設定、ロケール情報がimage要素のURIへのクエリパラメータに自動的に追加される。falseの場合はクエリパラメータが追加されない。デフォルトはfalseである。
例えば、http://www.abc.xyz」がimage要素のsrc属性に指定された場合、実際には「http://www.abc.xyz?ms-scale=80&ms-contrast=standard&ms-lang=en-US」のようにWebサーバに要求される。 |
|||||
baseUri | 任意 | ベースになるURIを示す文字列。baseUriで指定した文字列は、各image要素のURIから省略できる。デフォルトは「ms-appx:///」
例えば、baseUriで「http:」を設定すると、各image要素のURIでは「http://www.abc.xyz」でなく「//www.abc.xyz」 と指定できる。 |
|||||
branding | 任意 | アプリの商標を指定する場合は、「none」「logo」「name」のいずれかを指定する。 | |||||
contentId | 任意 | 通知するコンテンツを一意に識別するために送信者側で定義する文字列。 | |||||
image | - | - | タイル通知のテンプレートで使用するイメージ要素。 | ||||
- | id | 必須 | image要素に付与するID。1から順に指定する。templateで指定したテンプレートに応じて各IDの画像が配置される。 | ||||
src | 必須 | イメージを示すURI文字列。 | |||||
alt | 任意 | イメージの説明。 | |||||
addImageQuery | 任意 | trueの場合、現在の倍率、コントラスト設定、ロケール情報がimage要素のURIへのクエリパラメータに自動的に追加される。falseの場合はクエリパラメータが追加されない。デフォルトはfalseである。
例えば、http://www.abc.xyz」がimage要素のsrc属性に指定された場合、実際には「http://www.abc.xyz?ms-scale=80&ms-contrast=standard&ms-lang=en-US」のようにWebサーバに要求される。 |
|||||
text | - | - | タイル通知のテンプレートで使用するテキスト要素。 | ||||
- | id | 必須 | text要素に付与するID。1から順に指定する。templateで指定したテンプレートに応じて各IDの画像が配置される。 | ||||
lang | 任意 | ロケール文字列。 |
<?xml version=”1.0” encoding=”utf-8”?> <wns> <toast launch=”http://www.fujitsu.com/jp/”> <visual> <binding template=”ToastText04”> <text id=”1”>Sample Messsage</text> </binding> </visual> </toast> </wns>