导出 (0) 打印
全部展开

mpns 对象

更新时间: 2014年10月

该对象可让你使用 Azure 通知中心通过 Microsoft Azure 移动服务服务器脚本向 Windows Phone 8.0 或 Windows Phone 8.1 Silverlight 应用程序发送推送通知。

createFlipTileRegistration(channel, tags, template, options, callback)
使用翻转磁贴模板创建注册。(仅适用于 Windows Phone 7.8 或更高版本。)有关详细信息,请参阅适用于 Windows Phone 8 的翻转磁贴模板

参数

Name 类型 参数 说明

channel

字符串

设备通道 URI。

tags

字符串 | 数组

单个标记,或标记数组(逗号分隔列表,不包含空格)。

template

object

注册模板。

属性

Name 类型 说明

backgroundImage

字符串

磁贴背景图像的 URI。

count

字符串

在磁贴上显示的数字。

title

字符串

磁贴的标题文本。

backBackgroundImage

字符串

在磁贴背面显示的图像的 URI。

backTitle

字符串

磁贴背面的标题文本。

backContent

字符串

磁贴背面的文本。

id

字符串

相关辅助磁贴的 ID。

smallBackgroundImage

字符串

在磁贴缩小为小尺寸时其背景图像的 URI。

wideBackgroundImage

字符串

在磁贴放大为大尺寸时其背景图像的 URI。

wideBackContent

字符串

在磁贴扩展为大尺寸时其背面的内容。

wideBackBackgroundImage

字符串

在磁贴扩展为大尺寸时其背面图像的 URI。

options

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

headers

object

<optional>

要包含的 mpns 标头。

callback

object

<optional>

一个 JSON 对象,用于指定 successerror 回调函数。

createNativeRegistration(channel, tags, optionsOrCallback, callback)
创建本机 MPNS 注册。

参数

Name 类型 参数 说明

channel

字符串

设备通道 URI。

tags

字符串 | 数组

单个标记,或标记数组(逗号分隔列表,不包含空格)。

optionsOrCallback

object

<optional>

请求选项或回调。

callback

object

<optional>

一个 JSON 对象,用于指定 successerror 回调函数。

createOrUpdateNativeRegistration(registrationId, channel, tags, optionsOrCallback, callback)
创建或更新本机 MPNS 注册。

参数

Name 类型 参数 说明

registrationId

字符串

注册标识符。

channel

字符串

设备通道 URI。

tags

字符串 | 数组

单个标记,或标记数组(逗号分隔列表,不包含空格)。

optionsOrCallback

object

<optional>

请求选项或回调。

callback

object

<optional>

一个 JSON 对象,用于指定 successerror 回调函数。

createOrUpdateRawTemplateRegistration(registrationId, channel, tags, template, optionsOrCallback, callback)
创建或更新自定义模板注册。

参数

Name 类型 参数 说明

registrationId

字符串

注册标识符。

channel

字符串

设备通道 URI。

tags

字符串 | 数组

单个标记,或标记数组(逗号分隔列表,不包含空格)。

template

json

注册的 JSON 模板。

optionsOrCallback

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

headers

object

<optional>

要包含的 mpns 标头。

callback

object

<optional>

一个 JSON 对象,用于指定 successerror 回调函数。

createRawTemplateRegistration(channel, tags, template, optionsOrCallback, callback)
创建自定义模板注册。使用此方法可以全面控制模板格式。

参数

Name 类型 参数 说明

channel

字符串

设备通道 URI。

tags

字符串 | 数组

单个标记,或标记数组(逗号分隔列表,不包含空格)。

template

json

注册的 JSON 模板。

optionsOrCallback

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

pnsCredentialName

object

<optional>

要使用的 pns 凭据。

headers

object

<optional>

要包含的 mpns 标头。

callback

object

<optional>

一个 JSON 对象,用于指定 successerror 回调函数。

createTileRegistration(channel, tags, template, options, callback)
使用磁贴模板创建注册。有关详细信息,请参阅 Windows Phone 磁贴模板

参数

Name 类型 参数 说明

channel

字符串

设备通道 URI。

tags

字符串 | 数组

单个标记,或标记数组(逗号分隔列表,不包含空格)。

template

object

注册模板。

属性

Name 类型 说明

backgroundImage

字符串

磁贴背景图像的 URI。

count

字符串

在磁贴上显示的数字。

title

字符串

磁贴的标题文本。

backBackgroundImage

字符串

在磁贴背面显示的图像的 URI。

backTitle

字符串

磁贴背面的标题文本。

backContent

字符串

磁贴背面的文本。

id

字符串

相关辅助磁贴的 ID。

options

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

headers

object

<optional>

要包含的 mpns 标头。

callback

object

<optional>

一个 JSON 对象,用于指定 successerror 回调函数。

createToastRegistration(channel, tags, template, options, callback)
使用 toast 模板创建新注册。有关详细信息,请参阅适用于 Windows Phone 8 的 Toast

参数

Name 类型 参数 说明

channel

字符串

设备通道 URI。

tags

字符串 | 数组

单个标记,或标记数组(逗号分隔列表,不包含空格)。

template

object

注册的正文模板。

属性

Name 类型 说明

text1}

字符串

Text1 元素的值。

text2

字符串

Text2 元素的值。

param

字符串

向 toast 提供的可选参数。(仅适用于 Windows Phone 7.5 或更高版本。)

lang

字符串

绑定元素的语言值。

options

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

headers

object

<optional>

要包含的 mpns 标头。

callback

object

<optional>

一个 JSON 对象,用于指定 successerror 回调函数。

listRegistrationsByChannel(channel, optionsOrCallback, callback)
按通道 URI 检索注册。

参数

Name 类型 参数 说明

channel

字符串

设备通道 URI。

optionsOrCallback

object

<optional>

请求选项或回调函数。其他属性将作为标头传递。

属性

Name 类型 参数 说明

top

object

<optional>

指定要通过调用获取的最大注册数。

skip

object

<optional>

指定要在调用中跳过的注册数。

callback

object

<optional>

一个 JSON 对象,用于指定 successerror 回调函数。

send(tags, payload, targetName, notificationClass, optionsOrCallback, callback)
发送自定义 MPNS 通知。如果你想要全面控制负载,请使用此方法。

参数

Name 类型 参数 说明

tags

数组 | 字符串

单个标记、标记表达式或标记数组。

payload

字符串

消息的 XML 负载。

targetName

字符串

目标名称。

notificationClass

字符串

通知类。

optionsOrCallback

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

headers

object

<optional>

要包含的 mpns 标头。

callback

object

一个 JSON 对象,用于指定 successerror 回调函数。

sendFlipTile(tags, payload, options, callback)
发送翻转磁贴通知。(仅适用于 Windows Phone 7.8 或更高版本。)有关详细信息,请参阅适用于 Windows Phone 8 的翻转磁贴模板

参数

Name 类型 参数 说明

tags

数组 | 字符串

标记标识符的逗号分隔列表或数组。

payload

object

消息负载。

属性

Name 类型 说明

backgroundImage

字符串

磁贴背景图像的 URI。

count

字符串

在磁贴上显示的数字。

title

字符串

磁贴的标题文本。

backBackgroundImage

字符串

在磁贴背面显示的图像的 URI。

backTitle

字符串

磁贴背面的标题文本。

backContent

字符串

磁贴背面的文本。

id

字符串

相关辅助磁贴的 ID。

smallBackgroundImage

字符串

在磁贴缩小为小尺寸时其背景图像的 URI。

wideBackgroundImage

字符串

在磁贴放大为大尺寸时其背景图像的 URI。

wideBackContent

字符串

在磁贴扩展为大尺寸时其背面的内容。

wideBackBackgroundImage

字符串

在磁贴扩展为大尺寸时其背面图像的 URI。

optionsOrCallback

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

headers

object

<optional>

要包含的 mpns 标头。

callback

object

一个 JSON 对象,用于指定 successerror 回调函数。

sendTile(tags, payload, optionsOrCallback, callback)
发送磁贴通知。有关详细信息,请参阅 Windows Phone 磁贴模板

参数

Name 类型 参数 说明

tags

数组 | 字符串

标记标识符的逗号分隔列表或数组。

payload

object

消息负载。

属性

Name 类型 说明

backgroundImage

字符串

磁贴背景图像的 URI。

count

字符串

在磁贴上显示的数字。

title

字符串

磁贴的标题文本。

backBackgroundImage

字符串

在磁贴背面显示的图像的 URI。

backTitle

字符串

磁贴背面的标题文本。

backContent

字符串

磁贴背面的文本。

id

字符串

相关辅助磁贴的 ID。

optionsOrCallback

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

headers

object

<optional>

要包含的 mpns 标头。

callback

object

一个 JSON 对象,用于指定 successerror 回调函数。

sendToast(tags, payload, options, callback)
发送 Toast 通知。有关详细信息,请参阅适用于 Windows Phone 8 的 Toast

参数

Name 类型 参数 说明

tags

数组 | 字符串

标记标识符的逗号分隔列表或数组。

payload

object

消息负载。

属性

Name 类型 说明

text1}

字符串

Text1 元素的值。

text2

字符串

Text2 元素的值。

param

字符串

向 toast 提供的可选参数。(仅适用于 Windows Phone 7.5 或更高版本。)

lang

字符串

绑定元素的语言值。

optionsOrCallback

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

headers

object

<optional>

要包含的 mpns 标头。

callback

object

一个 JSON 对象,用于指定 successerror 回调函数。

updateFlipTileRegistration(registrationId, channel, tags, template, optionsOrCallback, callback)
使用翻转磁贴模板更新现有注册。(仅支持 Windows Phone 7.8 或更高版本。)有关详细信息,请参阅适用于 Windows Phone 8 的翻转磁贴模板

参数

Name 类型 参数 说明

registrationId

字符串

注册标识符。

channel

字符串

设备通道 URI。

tags

字符串 | 数组

单个标记,或标记数组(逗号分隔列表,不包含空格)。

template

object

注册模板。

属性

Name 类型 说明

backgroundImage

字符串

磁贴背景图像的 URI。

count

字符串

在磁贴上显示的数字。

title

字符串

磁贴的标题文本。

backBackgroundImage

字符串

在磁贴背面显示的图像的 URI。

backTitle

字符串

磁贴背面的标题文本。

backContent

字符串

磁贴背面的文本。

id

字符串

相关辅助磁贴的 ID。

smallBackgroundImage

字符串

在磁贴缩小为小尺寸时其背景图像的 URI。

wideBackgroundImage

字符串

在磁贴放大为大尺寸时其背景图像的 URI。

wideBackContent

字符串

在磁贴扩展为大尺寸时其背面的内容。

wideBackBackgroundImage

字符串

在磁贴扩展为大尺寸时其背面图像的 URI。

optionsOrCallback

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

headers

object

<optional>

要包含的 mpns 标头。

callback

object

<optional>

一个 JSON 对象,用于指定 successerror 回调函数。

updatesRawTemplateRegistration(registrationId, channel, tags, template, optionsOrCallback, callback)
更新原始模板注册。

参数

Name 类型 参数 说明

registrationId

字符串

注册标识符。

channel

字符串

设备通道 URI。

tags

字符串 | 数组

注册的标记。

template

json

注册的模板。

optionsOrCallback

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

headers

object

<optional>

要包含的 mpns 标头。

etag

object

<optional>

要包含的 etag。

callback

object

一个 JSON 对象,用于指定 successerror 回调函数。

updatesToastRegistration(registrationId, channel, tags, template, options, callback)
使用新的 toast 模板更新现有模板注册。有关详细信息,请参阅适用于 Windows Phone 8 的 Toast

参数

Name 类型 参数 说明

registrationId

字符串

注册标识符。

channel

字符串

设备通道 URI。

tags

字符串 | 数组

注册的标记。

template

object

注册的正文模板。

属性

Name 类型 说明

text1}

字符串

Text1 元素的值。

text2

字符串

Text2 元素的值。

param

字符串

向 toast 提供的可选参数。(仅适用于 Windows Phone 7.5 或更高版本。)

lang

字符串

绑定元素的语言值。

optionsOrCallback

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

headers

object

<optional>

要包含的 mpns 标头。

callback

object

一个 JSON 对象,用于指定 successerror 回调函数。

updateTileRegistration(registrationId, channel, tags, template, optionsOrCallback, callback)
使用磁贴模板更新现有注册。有关详细信息,请参阅 Windows Phone 磁贴模板

参数

Name 类型 参数 说明

registrationId

字符串

注册标识符。

channel

字符串

设备通道 URI。

tags

字符串 | 数组

单个标记,或标记数组(逗号分隔列表,不包含空格)。

template

object

注册模板。

属性

Name 类型 说明

backgroundImage

字符串

磁贴背景图像的 URI。

count

字符串

在磁贴上显示的数字。

title

字符串

磁贴的标题文本。

backBackgroundImage

字符串

在磁贴背面显示的图像的 URI。

backTitle

字符串

磁贴背面的标题文本。

backContent

字符串

磁贴背面的文本。

id

字符串

相关辅助磁贴的 ID。

optionsOrCallback

object

<optional>

请求选项或回调。

属性

Name 类型 参数 说明

headers

object

<optional>

要包含的 mpns 标头。

callback

object

<optional>

一个 JSON 对象,用于指定 successerror 回调函数。

mpns 对象用于向 Windows Phone 8 和 Windows Phone 8.1 Silverlight 应用程序发送推送通知。若要向 Windows Phone 应用商店 8.1 应用程序发送推送通知,你必须使用 wns 对象。Windows Phone 应用商店 8.1 应用程序不支持 MPNS。

有关如何从移动服务向 Windows Phone 8 应用程序发送推送通知的示例,请参阅向移动服务应用程序添加推送通知

移动服务 不要求你向 MPNS 注册你的应用程序以便启用经过了身份验证的使用。因此,你不能通过使用 MPNS 每天为每个用户发送超过 500 条消息。

以下脚本使用 mpns 对象向 Windows Phone 8 应用程序发送翻转磁贴通知。

function insert(item, user, request) {
// Define a payload for the Windows Phone toast notification.
var payload = '<?xml version="1.0" encoding="utf-8"?>' +
    '<wp:Notification xmlns:wp="WPNotification"><wp:Toast>' +
    '<wp:Text1>New Item</wp:Text1><wp:Text2>' + item.text + 
    '</wp:Text2></wp:Toast></wp:Notification>';

request.execute({
    success: function() {
        // If the insert succeeds, send a notification.
        push.mpns.send(null, payload, 'toast', 22, {
            success: function(pushResponse) {
                console.log("Sent push:", pushResponse);
                request.respond();
                },              
                error: function (pushResponse) {
                    console.log("Error Sending push:", pushResponse);
                    request.respond(500, { error: pushResponse });
                    }
                });
            }
        });      
}

显示:
© 2015 Microsoft