Add an alias
Adds an alias to a device to send targeted messages by alias.
A single device can have up to 128 aliases. The same alias can be added to a maximum of 128 devices.
An alias can be up to 128 bytes long.
addAlias
API definition
void addAlias(String alias, CommonCallback callback)
Class
CloudPushService
Parameters
Parameter | Type | Required | Description |
alias | String | Yes | The alias. |
callback | CommonCallback | Yes | The result callback. |
Code examples
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) {
}
});Delete an alias
Deletes a device alias.
You can delete a specific alias or all aliases from a device.
removeAlias
API definition
void removeAlias(String alias, CommonCallback callback)
Class
CloudPushService
Parameters
Parameter | Type | Required | Description |
alias | String | No | If `alias` is null or `alias.length` is 0, all aliases for the device are deleted. |
callback | CommonCallback | Yes | The callback. |
Code examples
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) {
}
});Query aliases
Queries device aliases.
Starting from SDK V3.0.9, this API has a 5 s internal cache. Multiple calls within 5 s result in only one request to the server-side.
listAliases
API definition
void listAliases(CommonCallback callback)
Class
CloudPushService
Parameters
Parameter | Type | Required | Description |
callback | CommonCallback | Yes | The callback. The query result can be obtained from the `response` parameter of the `onSuccess(response)` callback. |
Code examples
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) {
}
});