Documentation

Class: PushSender

PushSender

new PushSender()

Push送信クラス

Since:
  • v4.0.0
Example
var push = new Nebula.PushSender();

Classes

ApnsFields
GcmFields
SseFields

Members

allowedReceivers :Array

受信可能なユーザ・グループの一覧

Type:
  • Array
Default Value:
  • null

apnsFields :PushSender.ApnsFields

APNs 固有パラメータ

Type:
Default Value:
  • null

clause :Clause

送信先条件

Type:
Default Value:
  • null

gcmFields :PushSender.GcmFields

GCM 固有パラメータ

Type:
Default Value:
  • null

message :String

送信メッセージ

Type:
  • String
Default Value:
  • null

sseFields :PushSender.SseFields

SSE 固有パラメータ

Type:
Default Value:
  • null

Methods

send(callbacks)

Push送信する。

Parameters:
Name Type Description
callbacks Callbacks

応答コールバック

・callbacks は、成功時と失敗時の応答コールバックを指定する。
    {
        success : function(result) {
            // 成功時の処理
        },
        error : function(error) {
            // 失敗時の処理
        }
    }
・処理が成功した場合、success の呼び出しにて通知する。
    success の書式は以下の通りとする。
        success(result)
            result : Pushリクエストの結果が JSON 形式で返る
              {
                  "result": "ok",
                  "installations": 条件に合致したインスタレーションの数
              }
・処理が失敗した場合は、error の呼び出しにて通知する。
    error の書式は以下の通りとする。
        error(error)
            error : エラー要因がJSON 形式で返る。
             {
                 "status"        : ステータスコード,
                 "statusText"    : エラーメッセージ,
                 "responseText"  : レスポンスメッセージ
             }
Returns:

callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。

Type
Promise