cmp.push.push 类

消息推送相关

方法

getRemoteNotification

getRemoteNotification
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-push-doc.js:129

获取离线消息推送服务

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.push.getRemoteNotification({
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

getRemoteNotificationToken

getRemoteNotificationToken
(
  • options
)
Object

定义于 doc\doc\cmp_doc_all\cmp-push-doc.js:90

获取离线消息推送配置

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
userId String 必选

用户id

serverIdentifier String 必选

服务器唯一标识

showContent Boolean 必选

是否通知显示消息详情 默认true

soundRemind Boolean 必选

是否有声音 默认true

vibrationRemind Boolean 必选

是否震动 默认true

platforms Array 必选

android使用，进行推送的消息平台"baidu","xiaomi","huawei"

success Function 必选

成功后的回调

error Function 必选

失败后的回调

返回值:

[Object]
  • clientProtocolType = iPhoneInHouse; //设备类型 android、iPad、iPadInHouse、iPhone、iPhoneInHouse
  • tokens = {"baidu":"612021290303441655", "xiaomi":"23423456"}; // 用户注册id/li>
  • platforms = ["baidu", "xiaomi"];// 消息推送平台 baidu、 xiaomi 、huawei

示例:

<script>
   cmp.push.getRemoteNotificationToken({
       userId:"xxasd",
       serverIdentifier:"123333",
       showContent:true,
       soundRemind:true,
       vibrationRemind:true,
       platforms:["baidu","xiaomi","huawei"],
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

setPushConfig

setPushConfig
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-push-doc.js:38

设置消息推送参数（是否接收消息，是否声音提醒等）

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
userKey String 必选

用来存储消息设置的唯一的key

showContent Boolean 必选

是否通知显示消息详情 默认true

soundRemind Boolean 必选

是否有声音 默认true

vibrationRemind Boolean 必选

是否震动 默认true

platforms Array 必选

android使用，进行推送的消息平台"baidu","xiaomi","huawei"

success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.push.setPushConfig({
       userKey:"xxasd",
       showContent:true,
       soundRemind:true,
       vibrationRemind:true,
       platforms:["baidu","xiaomi","huawei"],
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

startPush

startPush
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-push-doc.js:17

开启消息推送服务

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.push.startPush({
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>

stopPush

stopPush
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-push-doc.js:69

停止消息推送服务

参数:

名称类型标识描述
options Object 必选

配置参数

名称类型标识描述
success Function 必选

成功后的回调

error Function 必选

失败后的回调

示例:

<script>
   cmp.push.stopPush({
       success:function(result){
            //do something with result
       },
       error:function(error){
       }
   });
</script>
Top