别名管理接口

本文档介绍如何使用别名管理接口为设备添加和移除别名

别名管理须知

  • 添加限制:单个设备最多可以添加 128 个别名。同一个别名最多可以被添加到 128 个设备。

  • 长度限制:每个别名的最大长度为 128 字节。

  • 删除操作:支持删除指定别名或删除全部别名。

添加别名

用于为设备添加一个别名

接口定义

+ (void)addAlias:(NSString *)alias
    withCallback:(CallbackHandler)callback;

参数说明

参数

类型

是否必填

说明

alias

NSString

要添加的别名。

callback

Block

操作结果的回调。

删除别名

用于删除设备的别名。

接口定义

+ (void)removeAlias:(NSString *)alias
       withCallback:(CallbackHandler)callback;

参数说明

参数

类型

是否必填

说明

alias

NSString

要删除的别名。当 aliasnil 或为空字符串时,删除设备的全部别名。

callback

Block

操作结果的回调。

查询别名

用于查询设备当前绑定的别名。

接口定义

+ (void)listAliases:(CallbackHandler)callback;

参数说明

参数

类型

是否必填

说明

callback

Block

操作结果的回调。

使用示例

CloudPushSDK.listAliases() { res in
    if res.success {
        var aliases: [String] = []
        if let data = res.data as? String, data.count > 0 {
            aliases = data.components(separatedBy: ",")
        }
        print("同步设备别名成功 \(aliases)")
    } else {
        if let error = res.error {
            print("同步设备别名失败 \(error)")
        }
    }
}
[CloudPushSDK listAliases:^(CloudPushCallbackResult *res) {
    if (res.success) {
        NSArray<NSString *> * aliases;
        if ([res.data length] > 0) {
            aliases = [res.data componentsSeparatedByString:@","];
        }
        NSLog(@"同步设备别名成功 %@", aliases);
    } else {
        NSLog(@"同步设备别名失败 %@", res.error);
    }
}];