别名(alias)相关接口
说明
以下接口调用时,如有回调均为异步执行,且回调不能为空。
添加别名
为设备添加别名。
注意
单个设备最多添加128个别名,同一个别名最多可被添加到128个设备。
别名支持的最大长度为128字节。
接口定义
void addAlias(String alias, CommonCallback callback);
参数说明
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
alias | String | 是 | 别名 |
callback | CommonCallback | 是 | 结果回调 |
代码示例
mPushService = PushServiceFactory.getCloudPushService();
mPushService.addAlias(alias, new CommonCallback() {
@Override
public void onSuccess(String s) {
tvConsoleText.append("add alias " + alias + " success\n");
}
@Override
public void onFailed(String errorCode, String errorMsg) {
tvConsoleText.append("add alias " + alias + " failed." +
"errorCode: " + errorCode + ", errorMsg:" + errorMsg + "\n");
}
});
删除别名
删除设备别名。
说明
支持删除指定别名和删除全部别名。
接口定义
void removeAlias(String alias, CommonCallback callback);
参数说明
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
alias | String | 否 | alias = null or alias.length = 0 时,删除设备全部别名。 |
callback | CommonCallback | 是 | 回调 |
代码示例
mPushService = PushServiceFactory.getCloudPushService();
mPushService.removeAlias(alias, new CommonCallback() {
@Override
public void onSuccess(String s) {
tvConsoleText.append("remove alias " + alias + " success\n");
}
@Override
public void onFailed(String errorCode, String errorMsg) {
tvConsoleText.append("remove alias " + alias + " failed." +
"errorCode: " + errorCode + ", errorMsg:" + errorMsg + "\n");
}
});
查询别名
查询设备别名。
注意
查询结果可从回调onSuccess(response)的response中获取。
从SDK版本V3.0.9开始,接口内部有5s短缓存,5s内多次调用只会请求服务端一次。
接口定义
void listAliases(CommonCallback callback);
参数说明
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
callback | CommonCallback | 是 | 回调 |
代码示例
mPushService = PushServiceFactory.getCloudPushService();
mPushService.listAliases(new CommonCallback() {
@Override
public void onSuccess(String response) {
tvConsoleText.append("aliases:" + response + " \n");
}
@Override
public void onFailed(String errorCode, String errorMsg) {
tvConsoleText.append("list aliases failed. errorCode:" + errorCode + " errorMsg:" + errorMsg);
}
});