Экспорт (0) Печать
Развернуть все

объект mpns

Обновлено: Июнь 2013 г.

Предоставляет функциональные возможности службы Microsoft Push Notification Service (MPNS) в серверных скриптах Мобильные службы Windows Azure.

Этот объект содержит следующие элементы.

sendFlipTile

Отправляет уведомление с переворачивающейся плиткой каналу.

noteПримечание
Только метод sendFlipTile поддерживается для отправки уведомлений на Windows Phone 7.8 и более поздние версии.

Синтаксис

sendFlipTile(channel, payload, options)

Параметры

 

Параметр Описание

channel

Необходимое значение URI канала или массив значений URI, указывающих каналы для получения уведомлений.

payload

Обязательный объект JSON, содержащий данные уведомлений, включающие следующие поля:

  • backgroundImage — URI фонового изображения для карточки.

  • count — число, которое отображается на карточке.

  • title — текст заголовка карточки.

  • backBackgroundImage — URI изображения на обратной стороне карточки.

  • backTitle — заголовок для обратной стороны карточки.

  • backContent — текст для обратной стороны карточки.

  • id — идентификатор родственной вторичной карточки.

  • smallBackgroundImage — URI для фонового изображения карточки при ее уменьшении.

  • wideBackgroundImage — URI для фонового изображения карточки при ее развертывании до широкого размера.

  • wideBackContent — содержимое обратной стороны карточки при ее развертывании до широкого размера.

  • wideBackBackgroundImage — URI для изображения на обратной стороне карточки при ее развертывании до широкого размера.

Дополнительные сведения о шаблонах карточек с переворачивающейся плиткой см. в разделе Flip Tile template for Windows Phone 8.

options

Обратный вызов, используемый для захвата результатов уведомления:

{
    success: success,
    error: error
}

Где success — функция, которая вызывается после того, как отправлено уведомление, а error — функция, которая вызывается при возникновении ошибки.

Когда операция отправки завершается успешно, функция success передается в объект JSON, заполняемый следующей информацией.

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

Этот объект также содержит поля для всех параметров уведомления, заданных для MPNS.

Возвращаемые значения

Не определено.

sendTile

Отправляет карточку уведомления каналу.

Синтаксис

sendTile(channel, payload, options)

Параметры

 

Параметр Описание

channel

Необходимое значение URI канала или массив значений URI, указывающих каналы для получения уведомлений.

payload

Обязательный объект JSON, содержащий данные уведомлений, включающие следующие поля:

  • backgroundImage — URI фонового изображения для карточки.

  • count — число, которое отображается на карточке.

  • title — текст заголовка карточки.

  • backBackgroundImage — URI изображения на обратной стороне карточки.

  • backTitle — заголовок для обратной стороны карточки.

  • backContent — текст для обратной стороны карточки.

  • id — идентификатор родственной вторичной карточки.

    Только этот метод поддерживается для отправки уведомлений на Windows Phone 7.5 и более поздние версии.

Дополнительные сведения о шаблонах карточек см. в разделе Windows Phone OS 7.1 Tile template.

options

Обратный вызов, используемый для захвата результатов уведомления:

{
    success: success,
    error: error
}

Где success — функция, которая вызывается после того, как отправлено уведомление, а error — функция, которая вызывается при возникновении ошибки.

Когда операция отправки завершается успешно, функция success передается в объект JSON, заполняемый следующей информацией.

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

Этот объект также содержит поля для всех параметров уведомления, заданных для MPNS.

Возвращаемые значения

Не определено.

sendToast

Отправляет извещающее уведомление каналу.

Синтаксис

sendToast(channel, payload, options)

Параметры

 

Параметр Описание

channel

Необходимое значение URI канала или массив значений URI, указывающих каналы для получения уведомлений.

payload

Обязательный объект, содержащий данные уведомлений, которые выглядят следующим образом:

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

Где text1 и text2 — строки текста извещения, а param — необязательный параметр URI, который указывает страницу XAML для открытия в приложении, а также все параметры строки запроса.

Только поле param поддерживается для отправки уведомлений на Windows Phone 7.5 и более поздние версии.

Дополнительные сведения об отправке извещающего уведомления см. в разделе Toasts for Windows Phone62d355e3-2cb6-4b16-97b9-76dec5e8b797.

options

Необязательный объект, используемый для захвата результатов уведомления:

{
    success: success,
    error: error
}

Где success — функция, которая вызывается после того, как отправлено уведомление, а error — функция, которая вызывается при возникновении ошибки.

Когда операция отправки завершается успешно, функция success передается в объект JSON, заполняемый следующей информацией.

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

Возвращаемые значения

Не определено.

sendRaw

Отправляет необработанное уведомление каналу.

Синтаксис

sendRaw(channel, payload, options)

Параметры

 

Параметр Описание

channel

Необходимое значение URI канала или массив значений URI, указывающих каналы для получения уведомлений.

payload

Специфическая для приложения строка, передаваемая клиенту без изменений.

{
    payload: 'raw notification string'
}

Где payload — строка уведомления.

noteПримечание
Вместо передачи объекту параметра payload можно просто предоставить необработанную строку уведомления вместо payload.

options

Необязательный объект, используемый для захвата результатов уведомления:

{
    success: success,
    error: error
}

Где success — функция, которая вызывается после того, как отправлено уведомление, а error — функция, которая вызывается при возникновении ошибки.

Когда операция отправки завершается успешно, функция success передается в объект JSON, заполняемый следующей информацией.

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

Возвращаемые значения

Не определено.

Мобильные службы не требует регистрации приложения в MPNS для включения проверки подлинности. Поэтому нельзя отправить более 500 сообщений в день с помощью MPNS.

Следующий скрипт использует объект 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);
                    }
                });
            });
        }
    });
}


}

Показ:
© 2014 Microsoft