导出 (0) 打印
全部展开

push 对象

更新时间: 2015年2月

帮助访问用于从 JavaScript 后端 移动服务向应用程序发送推送通知的对象。移动服务与 Azure 通知中心集成以支持更多的推送通知功能,例如模板、多个平台和改进的可缩放性。有关详细信息,请参阅推送通知入门

 

Name 返回 说明

apns

apns 对象

返回用于使用 Apple 推送通知服务 (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)
创建或更新注册。

参数

Name 类型 参数 说明

registration

字符串

要更新的注册。

options

object

<optional>

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

属性

Name 类型 参数 说明

etag

object

<optional>

etag。

callback

object

<optional>

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

createRegistrationId(callback)
创建注册标识符。

参数

Name 类型 参数 说明

callback

object

<optional>

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

deleteRegistration(registrationId, options, callback)
删除注册。

参数

Name 类型 参数 说明

registrationId

字符串

要删除的注册。

options

object

<optional>

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

属性

Name 类型 参数 说明

etag

object

<optional>

etag。

callback

object

<optional>

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

getRegistration(registrationId, options, callback)
检索具有指定 registrationId 的现有注册。

参数

Name 类型 参数 说明

registrationId

字符串

要检索的注册。

options

object

<optional>

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

callback

object

<optional>

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

listRegistrations(options, callback)
返回所有现有注册。

参数

Name 类型 参数 说明

options

object

<optional>

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

属性

Name 类型 参数 说明

top

object

<optional>

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

skip

object

<optional>

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

callback

object

<optional>

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

listRegistrationsByTag(tag, options, callback)
返回具有指定 tag 的所有现有注册。

参数

Name 类型 参数 说明

tag

字符串

注册标记。

options

object

<optional>

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

属性

Name 类型 参数 说明

top

object

<optional>

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

skip

object

<optional>

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

callback

object

<optional>

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

send(tags, payload, options, callback)
发送模板消息。

参数

Name 类型 参数 说明

tags

字符串

单个标记或标记表达式。如果为 Null,则向所有模板注册发送消息。

payload

对象 | 字符串

模板消息负载。

options

object

<optional>

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

属性

Name 类型 参数 说明

headers

object

<optional>

其他标头。

callback

object

<optional>

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

updateRegistration(registration, options, callback)
更新现有注册。

参数

Name 类型 参数 说明

registration

object

要更新的注册。

options

object

<optional>

要更新的注册。有关注册对象定义,请参阅备注部分。

callback

object

<optional>

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

全局 push 对象用于通过通知中心注册推送通知,并将消息发送到模板注册。使用平台特定的推送对象将消息发送到本机注册。虽然你可以从移动服务后端注册推送通知,但我们建议让客户端通过在客户端上调用注册方法来注册通知。有关详细信息,请参阅向移动服务应用程序添加推送通知

可以在客户端发起的注册过程中注入业务逻辑。有关详细信息,请参阅Registration endpoint

下面定义了提供给 callback 参数的 callback 对象:

回调对象

属性 类型 说明

success

函数

操作成功时调用的函数。将成功响应传递给该函数。

error

函数

操作失败时调用的函数。将错误响应传递给该函数。

以下是回调对象的示例:

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

registration 对象定义如下:

注册对象

属性 类型 适用范围 说明

registrationId

字符串

��部

注册 id。

channelUri

字符串

WNS 或只 MPNS-only

注册的当前通道 URI。

deviceToken

字符串

APNS-only

注册的当前设备令牌。

gcmRegistrationId

字符串

GCM-only

注册的当前 RegistrationId。

tags

字符串

��部

标记的逗号分隔列表(无空格)。

bodyTemplate

object

Template-only

定义模板注册正文。

wnsHeaders

object

WNS-only

用于 WNS 的其他标头。

mpnsHeaders

object

MPNS-only

用于 MPNS 的其他标头。

expiry

字符串

APNS-only

APNS 注册过期时间。

显示:
© 2015 Microsoft