7.2.1 IMAPSプッシュ

IMAPSプッシュでは、IMAPSサーバ側で指定したPayloadのフォーマットに従い、プッシュ部品がその内容を表示します。Payloadはプッシュクライアント設定ファイルでも設定できます。

Payloadのフォーマット

PayloadはJSON形式で指定します。

Payload仕様

Payloadでサポートするタグ情報は以下のとおりです。

タグ	意味		概要
title	通知領域に表示するタイトル部	任意	指定しない場合、push.NotificationAppNameで示されたリソースの定義値を表示する。指定する場合は、アプリにバンドルしたリソースの定義値とする。指定された定義値がアプリ内にみつからない場合は、指定内容をそのまま表示する。空文字の場合は空文字が表示される。
ticker	通知バーに表示するメッセージ部	任意	指定しない場合、プッシュクライアントが保持しているティッカー定義文(※)を表示する。指定する場合は、アプリにバンドルしたリソースの定義値とする。指定された定義値がアプリ内にみつからない場合は、指定内容をそのまま表示する。空文字の場合は空文字が表示される。
message	通知領域に表示するメッセージ部	必須	指定しない場合や空文字を指定した場合は、通知バーに表示されない。指定する場合は、アプリにバンドルしたリソースの定義値とする。指定された定義値がアプリ内にみつからない場合は、指定内容をそのまま表示する。
message_arg	メッセージに渡す引数	任意	messageに%sを指定した場合に、書式指定子の代わりに表示する変数文字列値を指定する。messageに書式指定子があり、message_argを省略した場合は、書式指定子がそのままメッセージ部に表示される。空文字を指定した場合は、空文字に置き換わる。
action	通知領域のタップ時のアクション	任意	指定しない場合、通知領域のタップ時に、通知を消去する。指定した場合、かつ、push.NotificationMainClassNameに有効値が指定されている場合は、通知を消去し、指定されたアクションを行う。
sound	通知音	任意	指定しない場合、かつ、push.RingtoneUriに有効値が指定されていない場合は、音を再生しない。指定する場合は、TYPE_ALARM／TYPE_NOTIFICATION／TYPE_RINGTONEのいずれかを指定するが、3種以外が指定されていた場合は、端末の通知音（TYPE_NOTIFICATION）を再生するいずれの場合も、繰り返しは行わず1度だけ再生する。また、マナーモード時は再生しない。
led_color	イルミネーション色	任意	指定しない場合、または定義値が無い場合は、イルミネーションは発光しない。指定する場合は、アプリにバンドルしたリソースの定義値とする。リソースにてARGB(ffff0000など)を定義する。ただし、実際の発光については、端末に依存する。
led_pattern	イルミネーションパターン	任意	指定しない場合、または定義値が無い場合は、イルミネーションは発光しない。指定する場合は、アプリにバンドルしたリソースの定義値とする。リソースにてパターンを定義する。（OnTime,OffTimeの順）ただし、実際の発光については、端末に依存する。
vib	バイブレーション	任意	指定しない、または定義値が無い場合は、振動しない。指定する場合は、アプリにバンドルしたリソースの定義値とする。

※ティッカー定義文：（日本語）「メッセージを受信しました。」（英語）「Received the Message.」

Payloadの指定例

{
  "title":"TITLE",
  "ticker":"TICKER",
  "message":"MES_01",
  "action":"http://jp.fujitsu.com/",
  "sound":"TYPE_ALARM",
  "led_color":"RED",
  "led_pattern":"LP_01",
  "vib":"VP_01"
}

アプリケーションにバンドルしたリソース
Value_ja/String.xml
<string name="TITLE">タイトル</string>
<string name="TICKER">メッセージがあります</string>
<string name="MES_01">次のサイトを確認してください。</string>
<string name="RED">#ffff0000</string>
<string name="LP_01">500,2000</sring><!-— on:500ms, off:2000ms -->
<string name="VP_01">3000,1000,2000,5000,3000,1000</string>
<!-- 3秒後に1秒間の振動、2秒後に5秒間の振動、3秒後に1秒間の振動 -->

プッシュクライアント設定ファイルで指定する場合は以下のとおりです。

・音

push.RingtoneUri = souduri

・LED

push.LedSet = true

push.LedColor = #7fffffff

push.LedOntime = 500

push.LedOfftime = 500

・バイブレーション

push.VibPattern = 1000,1000,1000,1000,1000,1000

鳴動する場合は、次の優先度となります。

プッシュクライアント設定ファイルでの指定(push.RingtoneUri) ＞ payloadで指定