文档

别名(alias)相关接口

更新时间:

添加别名

为设备添加别名,可以实现按别名的定向消息推送。

重要
  • 单个设备最多添加128个别名,同一个别名最多可被添加到128个设备。

  • 别名支持的最大长度为128字节。

addAlias

接口定义

void addAlias(String alias, CommonCallback callback)

所属类

CloudPushService

参数说明

参数

类型

是否必填

说明

alias

String

别名

callback

CommonCallback

结果回调

代码示例

PushServiceFactory.getCloudPushService()
    .addAlias(alias, object : CommonCallback {
        override fun onSuccess(s: String) {}
        override fun onFailed(errorCode: String, errorMsg: String) {}
    })
PushServiceFactory.getCloudPushService().addAlias(alias, new CommonCallback() {
    @Override
    public void onSuccess(String s) {

    }

    @Override
    public void onFailed(String errorCode, String errorMsg) {

    }
});

删除别名

删除设备别名。

说明

支持删除指定别名和删除全部别名。

removeAlias

接口定义

void removeAlias(String alias, CommonCallback callback)

所属类

CloudPushService

参数说明

参数

类型

是否必填

说明

alias

String

alias = null or alias.length = 0 时,删除设备全部别名。

callback

CommonCallback

回调

代码示例

PushServiceFactory.getCloudPushService()
    .removeAlias(alias, object : CommonCallback {
        override fun onSuccess(s: String) {}
        override fun onFailed(errorCode: String, errorMsg: String) {}
    })
PushServiceFactory.getCloudPushService().removeAlias(alias, new CommonCallback() {
    @Override
    public void onSuccess(String s) {

    }

    @Override
    public void onFailed(String errorCode, String errorMsg) {

    }
});

查询别名

查询设备别名。

重要
  • 从SDK版本V3.0.9开始,接口内部有5s短缓存,5s内多次调用只会请求服务端一次。

listAliases

接口定义

void listAliases(CommonCallback callback)

所属类

CloudPushService

参数说明

参数

类型

是否必填

说明

callback

CommonCallback

回调。查询结果可从回调onSuccess(response)的response中获取。

代码示例

PushServiceFactory.getCloudPushService()
    .listAliases(alias, object : CommonCallback {
        override fun onSuccess(s: String) {}
        override fun onFailed(errorCode: String, errorMsg: String) {}
    })
PushServiceFactory.getCloudPushService().listAliases(alias, new CommonCallback() {
    @Override
    public void onSuccess(String s) {

    }

    @Override
    public void onFailed(String errorCode, String errorMsg) {

    }
});