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

mpns オブジェクト

更新日: 2015年6月

Microsoft Azure モバイル サービスのサーバー スクリプトで Microsoft プッシュ通知サービス (MPNS) の機能を公開します。

このオブジェクトには、次のメンバーがあります。

チャネルにフリップ タイル通知を送信します。

noteメモ
sendFlipTile メソッドは、Windows Phone 7.8 以降のバージョンに通知を送信するためにのみサポートされます。

sendFlipTile(channel, payload, options)

 

パラメーター 説明

channel

通知を受信するチャネルを示す必須のチャネル URI 値または URI 値の配列。

payload

通知情報を含む必須の JSON オブジェクト。次のフィールドが含まれます。

  • backgroundImage - タイルの背景画像の URI。

  • count - タイルに表示される数。

  • title - タイルのタイトル テキスト。

  • backBackgroundImage - タイルのバックに表示される画像の URI。

  • backTitle - タイルのバックのタイトル。

  • backContent - タイルのバックのテキスト。

  • id - 関連するセカンダリ タイルの ID。

  • smallBackgroundImage - タイルが小さいサイズに縮小されたときの背景画像の URI。

  • wideBackgroundImage - タイルがワイド サイズに拡大されたときの背景画像の URI。

  • wideBackContent - タイルがワイド サイズに拡大されたときのバック タイルのコンテンツ。

  • wideBackBackgroundImage - タイルがワイド サイズに拡大されたときにタイルのバックに配置される画像の URI。

フリップ タイル テンプレートの詳細については、「Flip Tile template for Windows Phone 8」を参照してください。

options

通知の結果をキャプチャするために使用されるコールバック:

{
    success: success,
    error: error
}

success は通知が送信された後で呼び出される関数であり、error はエラーが発生したときに呼び出される関数です。

プッシュ操作に成功すると、次の情報が設定された JSON オブジェクトが success 関数に渡されます。

{
    statusCode: http_status_code, 
    deviceConnectionStatus: 'connection_status', 
    notificationStatus: 'notification_status', 
    subscriptionStatus: 'subscription_status', 
    title: 'title_field', 
    pushType: 'flipTile', 
    tileTemplate: 'tile_template' 
}

このオブジェクトには、MPNS に渡されるすべてのプッシュ通知オプションのフィールドが含まれます。

未定義です。

チャネルにタイル通知を送信します。

sendTile(channel, payload, options)

 

パラメーター 説明

channel

通知を受信するチャネルを示す必須のチャネル URI 値または URI 値の配列。

payload

通知情報を含む必須の JSON オブジェクト。次のフィールドが含まれます。

  • backgroundImage - タイルの背景画像の URI。

  • count - タイルに表示される数。

  • title - タイルのタイトル テキスト。

  • backBackgroundImage - タイルのバックに表示される画像の URI。

  • backTitle - タイルのバックのタイトル。

  • backContent - タイルのバックのテキスト。

  • id - 関連するセカンダリ タイルの ID。

    Windows Phone 7.5 以降のバージョンに通知を送信するためにのみサポートされます。

このタイル テンプレートの詳細については、「Windows Phone OS 7.1 Tile template」を参照してください。

options

通知の結果をキャプチャするために使用されるコールバック:

{
    success: success,
    error: error
}

success は通知が送信された後で呼び出される関数であり、error はエラーが発生したときに呼び出される関数です。

プッシュ操作に成功すると、次の情報が設定された JSON オブジェクトが success 関数に渡されます。

{
    statusCode: http_status_code, 
    deviceConnectionStatus: 'connection_status', 
    notificationStatus: 'notification_status', 
    subscriptionStatus: 'subscription_status', 
    title: 'title_field', 
    pushType: 'tile', 
    tileTemplate: 'tile_template' 
}

このオブジェクトには、MPNS に渡されるすべてのプッシュ通知オプションのフィールドが含まれます。

未定義です。

チャネルにトースト通知を送信します。

sendToast(channel, payload, options)

 

パラメーター 説明

channel

通知を受信するチャネルを示す必須のチャネル URI 値または URI 値の配列。

payload

通知情報を含む必須のオブジェクト。次のようになります。

{
    text1: 'Bold text:',
    text2: 'normal text',
    param: 'NewPage.xaml?item=5'
}

text1text2 は、トーストのテキスト文字列です。param は、アプリで開く XAML ページを指定する省略可能な URI パラメーターとクエリ文字列パラメーターです。

param フィールドは、Windows Phone 7.5 以降のバージョンに通知を送信するためにのみサポートされます。

トースト通知の送信の詳細については、「Toasts for Windows Phone62d355e3-2cb6-4b16-97b9-76dec5e8b797」を参照してください。

options

通知の結果をキャプチャするために使用される省略可能なオブジェクト:

{
    success: success,
    error: error
}

success は通知が送信された後で呼び出される関数であり、error はエラーが発生したときに呼び出される関数です。

プッシュ操作に成功すると、次の情報が設定された JSON オブジェクトが success 関数に渡されます。

{ 
    statusCode: http_status_code, 
    deviceConnectionStatus: 'connection_status', 
    notificationStatus: 'notification_status', 
    subscriptionStatus: 'subscription_status', 
    text1: 'toast_text1', 
    text2: 'toast_text1', 
    pushType: 'toast' 
}

未定義です。

チャネルに未加工のプッシュ通知文字列を送信します。

sendRaw(channel, payload, options)

 

パラメーター 説明

channel

通知を受信するチャネルを示す必須のチャネル URI 値または URI 値の配列。

payload

変更せずにクライアントに配信されるアプリケーション固有の文字列。

{
    payload: 'raw notification string'
}

payload は、通知の文字列です。

noteメモ
payload パラメーターにオブジェクトを指定せず、payload の代わりに単に未加工の通知の文字列を指定できます。

options

通知の結果をキャプチャするために使用される省略可能なオブジェクト:

{
    success: success,
    error: error
}

success は通知が送信された後で呼び出される関数であり、error はエラーが発生したときに呼び出される関数です。

プッシュ操作に成功すると、次の情報が設定された JSON オブジェクトが success 関数に渡されます。

{ 
    statusCode: http_status_code, 
    deviceConnectionStatus: 'connection_status', 
    notificationStatus: 'notification_status', 
    subscriptionStatus: 'subscription_status', 
    payload: 'payload_string', 
    pushType: 'raw' 
}

未定義です。

モバイル サービスでは、認証された使用を有効にするために MPNS にアプリを登録する必要はありません。このため、MPNS を使用した場合、ユーザーごとに 1 日あたり 500 件を超えるメッセージを送信することはできません。

次のスクリプトでは、mpns オブジェクトを使用して、Windows Phone 8 アプリにフリップ タイル通知を送信します。

function insert(item, user, request) {
    request.execute({
        success: function() {
            request.respond();
            sendNotifications();
        }
    });


function sendNotifications() {
    var channelTable = tables.getTable('Channel');
    channelTable.read({
        success: function(channels) {
            channels.forEach(function(channel) {
                push.mpns.sendFlipTile(channel.uri, {
                    title: item.text
                }, {
                    success: function(pushResponse) {
                        console.log("Sent push:", pushResponse);
                    }
                });
            });
        }
    });
}


}

表示:
© 2016 Microsoft