HTML 5+仕様:Push(プッシュメッセージ管理機能)
8016 ワード
Pushモジュールはプッシュメッセージ機能を管理し、plusを通じてオンライン、オフラインのメッセージプッシュを実現することができる.Pushは、プッシュメッセージ管理オブジェクトを取得することができる.
1、方法
1.1.addEventListener:Push Message Event Listenerの追加
void plus.push.addEventListener( event, listener, Boolean );
説明:Pushメッセージイベントリスナーを追加し、Pushイベントの発行を指定するとトリガーされます.
パラメータ:
type:(String)必須イベントタイプ、サポートイベントタイプ:「click」-システムメッセージセンターからメッセージをクリックしてアプリケーションイベントを起動します.「receive」-アプリケーションは、プッシュサーバからプッシュメッセージイベントを受信します.
Listener:(PushReceiveCallback)必須イベントリスナーコールバック関数、プッシュメッセージ受信時に呼び出す
Capture:(Boolean)オプションでイベントをキャプチャするかどうか、ここでは無視できます.
戻り値:void:なし
プラットフォームサポート:Android-2.2+(サポート)、iOS-4.3+(サポート):クライアントが実行時にプッシュメッセージを受信してreceiveイベントをトリガーし、オフラインで受信したプッシュメッセージはすべてシステムメッセージセンターに入ります.
例:
1.2、clear:すべてのプッシュメッセージをクリアする
void plus.push.clear();
説明:システムメッセージセンターのすべてのプッシュメッセージを空にします.
戻り値:void:なし
1.3、createMessage:ローカルメッセージの作成
void plus.push.createMessage( content, payload, option );
説明:ローカルで直接プッシュメッセージを作成し、システムメッセージセンターに追加します.
パラメータ:
content:(String)メッセージ表示の内容、システム通知センターに表示されるテキスト内容を選択します.
payload:(String)オプションのメッセージベアラのデータで、ビジネスロジックに基づいてデータフォーマットをカスタマイズできます.
option:(MessageOptions)メッセージの追加パラメータを作成する場合は、MessageOptionsを参照してください.
戻り値:void:なし
1.4、getAllMessage:すべてのプッシュメッセージを取得する
PushMessage[] plus.push.getAllMessage();
説明:クライアントが受信したすべてのプッシュメッセージを取得します.システム・メッセージ・センターに表示されるプッシュ・メッセージのみを含み、settAutoNotification(false)メソッドを呼び出してプッシュ・メッセージを表示しないで受信したメッセージを設定することは含まれません.
戻り値:PushMessage:Array[PushMessage]オブジェクト、PushMessage配列をプッシュします.
プラットフォームサポート:Android-2.2+(サポート)、iOS-4.3+(サポートされていません):システムメッセージセンターのメッセージリストを取得できません.このメソッドを呼び出して空の配列を返します.
1.5.getClientInfo:クライアントプッシュ識別情報を取得する
ClientInfo plus.push.getClientInfo();
説明:クライアント識別情報は、業務サーバがプッシュメッセージを送信する際にプッシュサーバに送信するデータに用いられ、プッシュメッセージを送信する受信者(クライアント)を説明するために用いられる.クライアントは、最初の実行時にビジネスサーバに送信して保存する必要があります.
戻り値:ClientInfo:クライアントが識別情報オブジェクトをプッシュする
例:
1.6、settAutoNotification:セットアッププログラムがメッセージをシステムメッセージセンターに表示するかどうか
void plus.push.setAutoNotification( notify );
説明:デフォルトでは、プログラムはプッシュメッセージを受信するとシステムメッセージセンターに表示され、この方法でデフォルトの動作を閉じることができ、プッシュメッセージを受信した後、システムメッセージセンターに表示されず、addEventListenerメソッドの「receive」イベントで受信したメッセージを傍受処理します.このモードでは、システムメッセージセンターに表示されるメッセージをcreateMessageメソッドによって作成することができる.
パラメータ:
notify:(Boolean)メッセージを自動的にプッシュするかどうかを選択する必要があります.値trueまたはfalseを取ることができ、trueはプッシュメッセージを自動的に表示し、falseは表示しません.デフォルトはtrueです.
戻り値:void:なし
プラットフォームサポート:Android-2.2+(サポート):プログラムが実行されていないときにプッシュメッセージを受信した場合、プログラムが起動した後にaddEventListenerメソッドを呼び出してreceiveイベントをリスニングしたときに受信したメッセージを返します.注:この機能は、プッシュプラットフォームがメッセージを透過するだけでサポートされ、他のメッセージはシステムメッセージセンターに表示されます.
iOS-4.3+(サポートされていません):オフラインプッシュメッセージを表示するかどうかを変更することはできません.プログラムがフロントで実行されている間にメッセージを受信した場合、システムメッセージセンターには追加されません.プログラムがフロントで実行されていない場合、システムメッセージに追加されます.
例:
1.7.remove:プッシュメッセージの削除
void plus.push.remove( message )
説明:システムメッセージセンターが指定したプッシュメッセージを削除し、getAllMessageメソッドですべてのメッセージを取得して操作できます.
パラメータ:message:(PushMessage)削除するメッセージオブジェクトを必ず選択し、getAllMessage()メソッドでメッセージを取得できます.
戻り値:void:なし
プラットフォームのサポート:Android-2.2+(サポート)、iOS-4.3+(サポートされていません):単一のメッセージを削除できません.clear()メソッドを呼び出してすべてのメッセージを空にします.
2、対象
2.1.ClientInfo:JSONオブジェクト、取得したクライアント識別情報
属性:
(1)、token:(Stringタイプ)デバイストークン(iOSデバイス一意識別)は、APNSサービスプッシュ中にデバイスのアイデンティティを識別するために使用される.プラットフォームはAndroid-2.2+(サポート):デバイスの一意の識別番号であり、通常clientid値と一致します.iOS-4.5+(サポート):デバイスのDeviceToken値をAPNSサーバに送信する場合に使用します.
(2)、clientid:(Stringタイプ)プッシュ情報受信者の識別のためのサービストークン(デバイス固有識別)を送信する.サードパーティがサーバ管理をプッシュするデバイスの一意のIDです.iOSプラットフォームでは、この値は通常tokenとは異なります.他のプラットフォームでは、この値は通常token値と一致します.
(3)、appid:(Stringタイプ)サードパーティプッシュサービスのアプリケーションID.サードパーティプッシュサーバ管理のアプリケーションIDは、通常、サードパーティプッシュサーバプラットフォームで登録取得する必要があります.
(4)、appkey:(Stringタイプ)サードパーティがサーバのアプリケーションキー値をプッシュする.サードパーティプッシュサーバ管理のアプリケーションキー値は、通常、サードパーティプッシュサーバプラットフォームで登録取得する必要があります.
2.1、PushMessage:JSONオブジェクト、メッセージオブジェクトをプッシュする
属性:
(1)、title:(Stringタイプ)メッセージ表示のタイトルをプッシュする.プラットフォームはAndroid-2.2+(サポート)iOS-ALL(サポート):をサポートします.
(2)、content:(Stringタイプ)メッセージ表示の内容をプッシュする.
(3)、payload:(JSONタイプ)メッセージベアラのデータをプッシュする.プッシュメッセージで送信されたデータがJSON形式に該当しない場合は、Stringタイプのデータとして保存されます.
(4)、aps:(JSONタイプ)Apple APNSがプロトコルデータをプッシュする.プラットフォームはAndroid-2.2+(サポートされていません):このデータはサポートされておらず、undefinedが返されます.iOS-5.0+(サポート):標準APNSプロトコルのデータのみをカプセル化し、その他のデータはpayloadにカプセル化します.ローカルAPIで作成されたメッセージの場合、このプロパティ値はundefinedです.
2.1、MessageOptions:JSONオブジェクト、クライアントがローカルメッセージを作成するパラメータを取得する
属性:
(1)、title:(Stringタイプ)メッセージのタイトルをプッシュする.システム・メッセージ・センターに表示される通知メッセージ・タイトルのデフォルト値は、プログラムの名前です.プラットフォームはAndroid-ALL(サポート)、iOS-5.0+(サポートなし):メッセージのタイトルの設定はサポートされず、プログラム名に固定されています.
(2)、sound:(Stringタイプ)メッセージをプッシュするプロンプト音、メッセージを表示するときの再生するプロンプト音、取値:「system」-システム通知プロンプト音を使用することを示す;「none」-プロンプト音を使用しないことを示します.デフォルトはシステムです.プラットフォームはAndroid-2.3+(サポート)、iOS-5.1+(サポート):プログラムがフロントで実行されている場合、プロンプト音は有効ではありません.注意:通常、ローカルプッシュメッセージを作成する前に、プログラムがバックグラウンドに切り替えられたときに有効になる遅延時間を設定します.
(3)、cover:(Booleanタイプ)前回のプロンプトのメッセージを上書きするかどうか.値trueまたはfalse、trueは上書き、falseは上書きせず、デフォルトはpermissionで設定されたcover値です.プラットフォームのサポート
Android-ALL(サポート).iOS-5.0+(サポートされていません):上書きメッセージはサポートされておらず、新しいメッセージしか作成できません.
(4)、when:(Dateタイプ)メッセージに表示されるプロンプト時間.デフォルトでは現在時刻ですが、遅延表示の場合は遅延後にメッセージが表示される時刻が使用されます.プラットフォームはAndroid-ALL(サポート)、iOS-5.0+(サポートなし):メッセージの表示時間の設定はサポートされず、システムがメッセージの作成時間を自動的に管理します.
(5)、delay:(Numberタイプ)メッセージの表示遅延を促す時間.デバイスがプッシュメッセージを受信すると、すぐに表示するのではなく、時間表示を遅延することができ、遅延時間単位はsであり、デフォルトは0 sであり、すぐに表示される.プラットフォームのサポート:Android-2.2+(サポート)、iOS-4.3+(サポート):title、cover、whenプロパティはサポートされず、プロパティ値は無視されます.
3、コールバック方法
3.1.PushReceiveCallback:クライアントがプッシュメッセージを受信したコールバック関数
void onReceive( msg ) {
//Recieved push message code.
}
パラメータ:msg:(String)必ず受信したプッシュ情報msg
戻り値:void:なし
3.2.PushClickCallback:ユーザーがプッシュメッセージイベントのコールバック関数をクリックする
void onClick( msg ) {
//Clicked push message code.
}
パラメータ:msg:(String)必須ユーザクリックのプッシュ情報msg
戻り値:void:なし
1、方法
1.1.addEventListener:Push Message Event Listenerの追加
void plus.push.addEventListener( event, listener, Boolean );
説明:Pushメッセージイベントリスナーを追加し、Pushイベントの発行を指定するとトリガーされます.
パラメータ:
type:(String)必須イベントタイプ、サポートイベントタイプ:「click」-システムメッセージセンターからメッセージをクリックしてアプリケーションイベントを起動します.「receive」-アプリケーションは、プッシュサーバからプッシュメッセージイベントを受信します.
Listener:(PushReceiveCallback)必須イベントリスナーコールバック関数、プッシュメッセージ受信時に呼び出す
Capture:(Boolean)オプションでイベントをキャプチャするかどうか、ここでは無視できます.
戻り値:void:なし
プラットフォームサポート:Android-2.2+(サポート)、iOS-4.3+(サポート):クライアントが実行時にプッシュメッセージを受信してreceiveイベントをトリガーし、オフラインで受信したプッシュメッセージはすべてシステムメッセージセンターに入ります.
例:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Push Example</title>
<script type="text/javascript">
// plusready
document.addEventListener( "plusready", function(){
// API ， API
//
plus.push.addEventListener( "click", function ( msg ) {
// msg.payload
alert( "You clicked: " + msg.content );
}, false );
}, false );
</script>
</head>
<body>
</body>
</html>1.2、clear:すべてのプッシュメッセージをクリアする
void plus.push.clear();
説明:システムメッセージセンターのすべてのプッシュメッセージを空にします.
戻り値:void:なし
1.3、createMessage:ローカルメッセージの作成
void plus.push.createMessage( content, payload, option );
説明:ローカルで直接プッシュメッセージを作成し、システムメッセージセンターに追加します.
パラメータ:
content:(String)メッセージ表示の内容、システム通知センターに表示されるテキスト内容を選択します.
payload:(String)オプションのメッセージベアラのデータで、ビジネスロジックに基づいてデータフォーマットをカスタマイズできます.
option:(MessageOptions)メッセージの追加パラメータを作成する場合は、MessageOptionsを参照してください.
戻り値:void:なし
1.4、getAllMessage:すべてのプッシュメッセージを取得する
PushMessage[] plus.push.getAllMessage();
説明:クライアントが受信したすべてのプッシュメッセージを取得します.システム・メッセージ・センターに表示されるプッシュ・メッセージのみを含み、settAutoNotification(false)メソッドを呼び出してプッシュ・メッセージを表示しないで受信したメッセージを設定することは含まれません.
戻り値:PushMessage:Array[PushMessage]オブジェクト、PushMessage配列をプッシュします.
プラットフォームサポート:Android-2.2+(サポート)、iOS-4.3+(サポートされていません):システムメッセージセンターのメッセージリストを取得できません.このメソッドを呼び出して空の配列を返します.
1.5.getClientInfo:クライアントプッシュ識別情報を取得する
ClientInfo plus.push.getClientInfo();
説明:クライアント識別情報は、業務サーバがプッシュメッセージを送信する際にプッシュサーバに送信するデータに用いられ、プッシュメッセージを送信する受信者(クライアント)を説明するために用いられる.クライアントは、最初の実行時にビジネスサーバに送信して保存する必要があります.
戻り値:ClientInfo:クライアントが識別情報オブジェクトをプッシュする
例:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Push Example</title>
<script type="text/javascript">
// plusready
document.addEventListener( "plusready", function(){
// API ， API
//
var info = plus.push.getClientInfo();
alert( JSON.stringify( info ) );
//
plus.push.addEventListener( "click", function ( msg ) {
// msg.payload
alert( "You clicked: " + msg.content );
}, false );
</script>
</head>
<body>
</body>
</html>1.6、settAutoNotification:セットアッププログラムがメッセージをシステムメッセージセンターに表示するかどうか
void plus.push.setAutoNotification( notify );
説明:デフォルトでは、プログラムはプッシュメッセージを受信するとシステムメッセージセンターに表示され、この方法でデフォルトの動作を閉じることができ、プッシュメッセージを受信した後、システムメッセージセンターに表示されず、addEventListenerメソッドの「receive」イベントで受信したメッセージを傍受処理します.このモードでは、システムメッセージセンターに表示されるメッセージをcreateMessageメソッドによって作成することができる.
パラメータ:
notify:(Boolean)メッセージを自動的にプッシュするかどうかを選択する必要があります.値trueまたはfalseを取ることができ、trueはプッシュメッセージを自動的に表示し、falseは表示しません.デフォルトはtrueです.
戻り値:void:なし
プラットフォームサポート:Android-2.2+(サポート):プログラムが実行されていないときにプッシュメッセージを受信した場合、プログラムが起動した後にaddEventListenerメソッドを呼び出してreceiveイベントをリスニングしたときに受信したメッセージを返します.注:この機能は、プッシュプラットフォームがメッセージを透過するだけでサポートされ、他のメッセージはシステムメッセージセンターに表示されます.
iOS-4.3+(サポートされていません):オフラインプッシュメッセージを表示するかどうかを変更することはできません.プログラムがフロントで実行されている間にメッセージを受信した場合、システムメッセージセンターには追加されません.プログラムがフロントで実行されていない場合、システムメッセージに追加されます.
例:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Push Example</title>
<script type="text/javascript">
// plusready
document.addEventListener( "plusready", function(){
// API ， API
//
plus.push.setAutoNotification( false );
}, false );
</script>
</head>
<body>
</body>
</html>1.7.remove:プッシュメッセージの削除
void plus.push.remove( message )
説明:システムメッセージセンターが指定したプッシュメッセージを削除し、getAllMessageメソッドですべてのメッセージを取得して操作できます.
パラメータ:message:(PushMessage)削除するメッセージオブジェクトを必ず選択し、getAllMessage()メソッドでメッセージを取得できます.
戻り値:void:なし
プラットフォームのサポート:Android-2.2+(サポート)、iOS-4.3+(サポートされていません):単一のメッセージを削除できません.clear()メソッドを呼び出してすべてのメッセージを空にします.
2、対象
2.1.ClientInfo:JSONオブジェクト、取得したクライアント識別情報
属性:
(1)、token:(Stringタイプ)デバイストークン(iOSデバイス一意識別)は、APNSサービスプッシュ中にデバイスのアイデンティティを識別するために使用される.プラットフォームはAndroid-2.2+(サポート):デバイスの一意の識別番号であり、通常clientid値と一致します.iOS-4.5+(サポート):デバイスのDeviceToken値をAPNSサーバに送信する場合に使用します.
(2)、clientid:(Stringタイプ)プッシュ情報受信者の識別のためのサービストークン(デバイス固有識別)を送信する.サードパーティがサーバ管理をプッシュするデバイスの一意のIDです.iOSプラットフォームでは、この値は通常tokenとは異なります.他のプラットフォームでは、この値は通常token値と一致します.
(3)、appid:(Stringタイプ)サードパーティプッシュサービスのアプリケーションID.サードパーティプッシュサーバ管理のアプリケーションIDは、通常、サードパーティプッシュサーバプラットフォームで登録取得する必要があります.
(4)、appkey:(Stringタイプ)サードパーティがサーバのアプリケーションキー値をプッシュする.サードパーティプッシュサーバ管理のアプリケーションキー値は、通常、サードパーティプッシュサーバプラットフォームで登録取得する必要があります.
2.1、PushMessage:JSONオブジェクト、メッセージオブジェクトをプッシュする
属性:
(1)、title:(Stringタイプ)メッセージ表示のタイトルをプッシュする.プラットフォームはAndroid-2.2+(サポート)iOS-ALL(サポート):をサポートします.
(2)、content:(Stringタイプ)メッセージ表示の内容をプッシュする.
(3)、payload:(JSONタイプ)メッセージベアラのデータをプッシュする.プッシュメッセージで送信されたデータがJSON形式に該当しない場合は、Stringタイプのデータとして保存されます.
(4)、aps:(JSONタイプ)Apple APNSがプロトコルデータをプッシュする.プラットフォームはAndroid-2.2+(サポートされていません):このデータはサポートされておらず、undefinedが返されます.iOS-5.0+(サポート):標準APNSプロトコルのデータのみをカプセル化し、その他のデータはpayloadにカプセル化します.ローカルAPIで作成されたメッセージの場合、このプロパティ値はundefinedです.
2.1、MessageOptions:JSONオブジェクト、クライアントがローカルメッセージを作成するパラメータを取得する
属性:
(1)、title:(Stringタイプ)メッセージのタイトルをプッシュする.システム・メッセージ・センターに表示される通知メッセージ・タイトルのデフォルト値は、プログラムの名前です.プラットフォームはAndroid-ALL(サポート)、iOS-5.0+(サポートなし):メッセージのタイトルの設定はサポートされず、プログラム名に固定されています.
(2)、sound:(Stringタイプ)メッセージをプッシュするプロンプト音、メッセージを表示するときの再生するプロンプト音、取値:「system」-システム通知プロンプト音を使用することを示す;「none」-プロンプト音を使用しないことを示します.デフォルトはシステムです.プラットフォームはAndroid-2.3+(サポート)、iOS-5.1+(サポート):プログラムがフロントで実行されている場合、プロンプト音は有効ではありません.注意:通常、ローカルプッシュメッセージを作成する前に、プログラムがバックグラウンドに切り替えられたときに有効になる遅延時間を設定します.
(3)、cover:(Booleanタイプ)前回のプロンプトのメッセージを上書きするかどうか.値trueまたはfalse、trueは上書き、falseは上書きせず、デフォルトはpermissionで設定されたcover値です.プラットフォームのサポート
Android-ALL(サポート).iOS-5.0+(サポートされていません):上書きメッセージはサポートされておらず、新しいメッセージしか作成できません.
(4)、when:(Dateタイプ)メッセージに表示されるプロンプト時間.デフォルトでは現在時刻ですが、遅延表示の場合は遅延後にメッセージが表示される時刻が使用されます.プラットフォームはAndroid-ALL(サポート)、iOS-5.0+(サポートなし):メッセージの表示時間の設定はサポートされず、システムがメッセージの作成時間を自動的に管理します.
(5)、delay:(Numberタイプ)メッセージの表示遅延を促す時間.デバイスがプッシュメッセージを受信すると、すぐに表示するのではなく、時間表示を遅延することができ、遅延時間単位はsであり、デフォルトは0 sであり、すぐに表示される.プラットフォームのサポート:Android-2.2+(サポート)、iOS-4.3+(サポート):title、cover、whenプロパティはサポートされず、プロパティ値は無視されます.
3、コールバック方法
3.1.PushReceiveCallback:クライアントがプッシュメッセージを受信したコールバック関数
void onReceive( msg ) {
//Recieved push message code.
}
パラメータ:msg:(String)必ず受信したプッシュ情報msg
戻り値:void:なし
3.2.PushClickCallback:ユーザーがプッシュメッセージイベントのコールバック関数をクリックする
void onClick( msg ) {
//Clicked push message code.
}
パラメータ:msg:(String)必須ユーザクリックのプッシュ情報msg
戻り値:void:なし