push オブジェクト
目次を折りたたむ
目次を展開する

push オブジェクト

更新日: 2015年6月

JavaScript バックエンド モバイル サービス からアプリにプッシュ通知を送信するために使用されるオブジェクトへのアクセスを提供します。Mobile Services を Azure Notification Hubs と統合することで、テンプレート、複数のプラットフォーム、強化されたスケールなど、追加のプッシュ通知機能をサポートしています。詳細については、「プッシュ通知の使用」を参照してください。

 

名前 戻り値 説明

apns

apns オブジェクト

Apple Push Notification サービス (APNS) を使用して、iOS アプリにプッシュ通知を送信するために使用される apns objectを返します。

gcm

gcm オブジェクト

Google Cloud Messaging (GCM) サービスを使用して、Android アプリにプッシュ通知を送信するために使用される gcm objectを返します。

mpns

mpns オブジェクト

Microsoft プッシュ通知サービス (MPNS) を使用して、Windows Phone 8 または Window Phone Silverlight 8.1 アプリにプッシュ通知を送信するために使用される mpns オブジェクト を返します。

wns

wns オブジェクト

Windows 通知サービス (WNS) を使用して、Windows ストア アプリにプッシュ通知を送信するために使用される wns オブジェクトを返します。

createOrUpdateRegistration(registration, options, callback)
登録を作成または更新します。

パラメーター

名前 引数 説明

registration

string

更新する登録です。

options

オブジェクト

<省略可能>

要求オプションまたはコールバック関数。追加のプロパティが、ヘッダーとして渡されます。

プロパティ

名前 引数 説明

etag

オブジェクト

<省略可能>

etag です。

callback

オブジェクト

<省略可能>

success および error コールバック関数を指定する JSON オブジェクト。

createRegistrationId(callback)
登録識別子を作成します。

パラメーター

名前 引数 説明

callback

オブジェクト

<省略可能>

success および error コールバック関数を指定する JSON オブジェクト。

deleteRegistration(registrationId, options, callback)
登録を削除します。

パラメーター

名前 引数 説明

registrationId

string

削除する登録です。

options

オブジェクト

<省略可能>

要求オプションまたはコールバック関数。追加のプロパティが、ヘッダーとして渡されます。

プロパティ

名前 引数 説明

etag

オブジェクト

<省略可能>

etag です。

callback

オブジェクト

<省略可能>

success および error コールバック関数を指定する JSON オブジェクト。

getRegistration(registrationId, options, callback)
指定した registrationId を持つ既存の登録を取得します。

パラメーター

名前 引数 説明

registrationId

string

取得する登録です。

options

オブジェクト

<省略可能>

要求オプションまたはコールバック関数。追加のプロパティが、ヘッダーとして渡されます。

callback

オブジェクト

<省略可能>

success および error コールバック関数を指定する JSON オブジェクト。

listRegistrations(options, callback)
既存の登録をすべて返します。

パラメーター

名前 引数 説明

options

オブジェクト

<省略可能>

要求オプションまたはコールバック関数。追加のプロパティが、ヘッダーとして渡されます。

プロパティ

名前 引数 説明

top

オブジェクト

<省略可能>

呼び出しで取得する登録の最大数を指定します。

skip

オブジェクト

<省略可能>

呼び出しでスキップする登録の数を指定します。

callback

オブジェクト

<省略可能>

success および error コールバック関数を指定する JSON オブジェクト。

listRegistrationsByTag(tag, options, callback)
指定した tag を持つ既存の登録をすべて返します

パラメーター

名前 引数 説明

tag

string

登録タグです。

options

オブジェクト

<省略可能>

要求オプションまたはコールバック関数。追加のプロパティが、ヘッダーとして渡されます。

プロパティ

名前 引数 説明

top

オブジェクト

<省略可能>

呼び出しで取得する登録の最大数を指定します。

skip

オブジェクト

<省略可能>

呼び出しでスキップする登録の数を指定します。

callback

オブジェクト

<省略可能>

success および error コールバック関数を指定する JSON オブジェクト。

send(tags, payload, options, callback)
テンプレート メッセージを送信します。

パラメーター

名前 引数 説明

tags

string

単一のタグまたはタグ式。null の場合、すべてのテンプレート登録にメッセージが送信されます。

payload

オブジェクト | 文字列

テンプレート メッセージのペイロード

options

オブジェクト

<省略可能>

要求オプションまたはコールバック関数。追加のプロパティが、ヘッダーとして渡されます。

プロパティ

名前 引数 説明

headers

オブジェクト

<省略可能>

追加ヘッダーです。

callback

オブジェクト

<省略可能>

success および error コールバック関数を指定する JSON オブジェクト。

updateRegistration(registration, options, callback)
既存の登録を更新します。

パラメーター

名前 引数 説明

registration

オブジェクト

更新する登録です。

options

オブジェクト

<省略可能>

更新する登録です。登録オブジェクトの定義については、「解説」を参照してください。

callback

オブジェクト

<省略可能>

success および error コールバック関数を指定する JSON オブジェクト。

グローバルな push オブジェクトを使用して、通知ハブによるプッシュ通知に登録し、テンプレート登録にメッセージを送信します。プラットフォーム固有のプッシュ オブジェクトを使用して、ネイティブ登録にメッセージを送信します。Mobile Services バックエンドからプッシュ通知に登録することができますが、クライアント上で登録メソッドを呼び出すことで通知用のクライアント登録を行うことをお勧めします。詳細については、「Mobile Services アプリへのプッシュ通知の追加」を参照してください。

クライアントで開始された登録プロセスにビジネス ロジックを挿入することができます。詳細については、「Registration endpoint」を参照してください。

callback パラメーターに指定される callback オブジェクトは次のように定義されます。

callback オブジェクト

プロパティ 説明

success

関数

操作が成功したときに呼び出される関数です。関数には正常な応答が渡されます。

error

関数

操作が失敗したときに呼び出される関数です。関数にはエラー応答が渡されます。

次に、callback オブジェクトの例を示します。

{ success: function(result){
      // Do something with the success response.
   }, error: function(error){
      // Do something with the error response.
   }
}

registration オブジェクトは次のように定義されます。

registration オブジェクト

プロパティ 適用対象 説明

registrationId

string

すべて

登録 ID です。

channelUri

string

WNS または MPNS のみ

登録用の現在のチャネル URI です。

deviceToken

string

APNS のみ

登録用の現在のデバイス トークンです。

gcmRegistrationId

string

GCM のみ

登録用の現在の RegistrationId です。

tags

string

すべて

タグのコンマ区切りの一覧 (スペースなし) です。

bodyTemplate

オブジェクト

テンプレートのみ

テンプレートの登録本文を定義します。

wnsHeaders

オブジェクト

WNS のみ

WNS で使用される追加のヘッダーです。

mpnsHeaders

オブジェクト

MPNS のみ

MPNS で使用される追加のヘッダーです。

expiry

string

APNS のみ

APNS 登録の有効期限です。

表示:
© 2016 Microsoft