エクスポート (0) 印刷
すべて展開

apns オブジェクト

更新日: 2015年2月

Azure Notification Hubs を使用して、Microsoft Azure モバイル サービス サーバー スクリプトから iOS アプリにプッシュ通知を送信できるようにします。APNS 通知のペイロードの JSON 形式は次のようになります。

{
    aps: {
        badge: badge_number,
        alert: 'alert_text',
        sound: 'sound_file',
        payload: payload_object,
        expiry: expire_date
    }
}

createNativeRegistration(token, tags, options, callback)
ネイティブの APNS 登録を作成します。

パラメーター

名前 引数 説明

token

string

デバイス トークン。

tags

文字列 | 配列

単一のタグまたはタグの配列 (コンマ区切り一覧、スペース使用不可)。

options

オブジェクト

<省略可能>

要求オプションまたはコールバック関数。

callback

オブジェクト

<省略可能>

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

createOrUpdateNativeRegistration(registrationId, token, tags, options, callback)
ネイティブの APNS 登録を作成または更新します。

パラメーター

名前 引数 説明

registrationId

string

登録 ID。

token

string

デバイス トークン。

tags

文字列 | 配列

単一のタグまたはタグの配列 (コンマ区切り一覧、スペース使用不可)。

options

オブジェクト

<省略可能>

要求オプションまたはコールバック関数。

callback

オブジェクト

<省略可能>

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

createOrUpdateTemplateRegistration(registrationId, token, template, options, callback)
テンプレート登録を作成または更新します。

パラメーター

名前 引数 説明

registrationId

string

登録 ID。

token

string

デバイス トークン。

template

文字列 | 配列

以下のように指定されたメッセージの JSON ペイロード。

プロパティ

名前 引数 説明

badge

number

<省略可能>

アプリ アイコンの上に表示する数値。

アラート

string

<省略可能>

アラート テキスト。

sound

string

<省略可能>

サウンド ファイルの名前。

payload

オブジェクト

<省略可能>

通知テキストが含まれているペイロード オブジェクト。

expiry

date

<省略可能>

有効期限。

ペイロードが文字列の場合、APNS 形式に従います。

options

オブジェクト

<省略可能>

要求オプションまたはコールバック関数。

callback

オブジェクト

<省略可能>

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

createTemplateRegistration(token, tags, template, options, callback)
テンプレート登録を作成します。

パラメーター

名前 引数 説明

token

string

デバイス トークン。

tags

文字列 | 配列

単一のタグまたはタグの配列 (コンマ区切り一覧、スペース使用不可)。

template

文字列 | 配列

以下のように指定されたメッセージの JSON ペイロード。

プロパティ

名前 引数 説明

badge

number

<省略可能>

アプリ アイコンの上に表示する数値。

アラート

string

<省略可能>

アラート テキスト。

sound

string

<省略可能>

サウンド ファイルの名前。

payload

オブジェクト

<省略可能>

通知テキストが含まれているペイロード オブジェクト。

expiry

date

<省略可能>

有効期限。

ペイロードが文字列の場合、APNS 形式に従います。

options

オブジェクト

<省略可能>

要求オプションまたはコールバック関数。

callback

オブジェクト

<省略可能>

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

listRegistrationsByToken(token, options, callback)
デバイス トークンにより登録を取得します。

パラメーター

名前 引数 説明

token

string

デバイス トークン。

options

オブジェクト

<省略可能>

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

プロパティ

名前 引数 説明

top

オブジェクト

<省略可能>

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

skip

オブジェクト

<省略可能>

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

callback

オブジェクト

<省略可能>

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

send(tags, payload, callback)
APNS 通知を送信します。

パラメーター

名前 説明

tags

string

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

payload

オブジェクト | 文字列

以下のように指定されたメッセージの JSON ペイロード。

プロパティ

名前 引数 説明

badge

number

<省略可能>

アプリ アイコンの上に表示する数値。

アラート

string

<省略可能>

アラート テキスト。

sound

string

<省略可能>

サウンド ファイルの名前。

payload

オブジェクト

<省略可能>

通知テキストが含まれているペイロード オブジェクト。

expiry

date

<省略可能>

有効期限。

ペイロードが文字列の場合、APNS 形式に従います。

callback

オブジェクト

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

updateTemplateRegistration(registrationId, token, template, options, callback)
既存のテンプレート登録を更新します。

パラメーター

名前 引数 説明

registrationId

string

登録 ID。

token

string

デバイス トークン。

template

文字列 | 配列

以下のように指定されたメッセージの JSON ペイロード。

プロパティ

名前 引数 説明

badge

number

<省略可能>

アプリ アイコンの上に表示する数値。

アラート

string

<省略可能>

アラート テキスト。

sound

string

<省略可能>

サウンド ファイルの名前。

payload

オブジェクト

<省略可能>

通知テキストが含まれているペイロード オブジェクト。

expiry

date

<省略可能>

有効期限。

ペイロードが文字列の場合、APNS 形式に従います。

options

オブジェクト

<省略可能>

要求オプション。

callback

オブジェクト

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

モバイル サービスから iOS アプリにプッシュ通知を送信する方法の例については、「モバイル サービスでのプッシュ通知の使用」を参照してください。

サーバー スクリプトでは、apns オブジェクトを push オブジェクトから取得します。完全な例については、「モバイル サービスでのプッシュ通知の使用」を参照してください。

APNS 通知のペイロードの JSON 形式は次のようになります。

{
    aps: {
        badge: badge_number,
        alert: 'alert_text',
        sound: 'sound_file',
        payload: payload_object,
        expiry: expire_date
    }
}

payload オブジェクトの alert フィールドを指定した場合、割り当てられたテキスト値がトースト通知として表示されます。この通知は、アプリが実行されていない場合でも表示されます。payload オブジェクトの payload フィールドのデータは、アプリが実行されている場合にのみ表示されます。

次の例では、新しいアイテムがテーブルに挿入されたときに、send メソッドを呼び出して、特定のデバイスにテキスト通知を送信します。

function insert(item, user, request) {
    request.execute();
    push.apns.send(null, {
        alert: "Alert: " + item.text,
        payload: {
            inAppMessage: "Hey, a new item arrived: '" + item.text + "'"
        }
    });
}

表示:
© 2015 Microsoft