全部产品

标签(tag)相关接口

说明

以下接口调用时,如有回调均为异步执行,且回调不能为空。

绑定标签

绑定标签到指定目标。

注意

  • 支持向设备、账号和别名绑定标签,绑定类型有参数target指定。

  • App最多支持定义1万个标签,单个标签支持的最大长度为129字符。

  • 绑定标签在10分钟内生效。

接口定义

void bindTag(int target, String[] tags, String alias, CommonCallback callback);

参数说明

参数

类型

是否必须

说明

target

int

目标类型可选值:

  • 1:本设备

  • 2:本设备绑定的账号

  • 3:别名

目标类型可选值(SDK版本V2.3.5及以上版本):

  • CloudPushService.DEVICE_TARGET:本设备

  • CloudPushService.ACCOUNT_TARGET:本账号

  • CloudPushService.ALIAS_TARGET:别名

tags

String[]

标签(数组输入)

alias

String

别名,仅当target=3时生效

callback

CommonCallback

回调

代码示例

        mPushService = PushServiceFactory.getCloudPushService();
        mPushService.bindTag(CloudPushService.DEVICE_TARGET, new String[]{tag}, null, new CommonCallback() {
            @Override
            public void onSuccess(String s) {
                tvConsoleText.append("bind tag " + tag + " success\n");
            }

            @Override
            public void onFailed(String errorCode, String errorMsg) {
                tvConsoleText.append("bind tag " + tag + " failed." +
                        "errorCode: " + errorCode + ", errorMsg:" + errorMsg + "\n");
            }
        });

解绑标签

解绑指定目标的标签。

注意

  • 支持解绑设备、账号和别名的标签,解绑类型有参数target指定。

  • 解绑标签只是解除设备和标签的绑定关系,不等同于删除标签,即该App下标签依然存在,系统当前不支持删除标签。

  • 解绑标签在10分钟内生效。

接口定义

void unbindTag(int target, String[] tags, String alias, CommonCallback callback);

参数说明

参数

类型

是否必须

说明

target

int

目标类型可选值:

  • 1:本设备

  • 2:本设备绑定的账号

  • 3:别名

目标类型可选值(SDK版本V2.3.5及以上版本):

  • CloudPushService.DEVICE_TARGET:本设备

  • CloudPushService.ACCOUNT_TARGET:本账号

  • CloudPushService.ALIAS_TARGET:别名

tags

String[]

标签(数组输入)

alias

String

别名,仅当target=3时生效

callback

CommonCallback

回调

代码示例

        mPushService = PushServiceFactory.getCloudPushService();
        mPushService.unbindTag(CloudPushService.DEVICE_TARGET, new String[]{tag}, null, new CommonCallback() {
            @Override
            public void onSuccess(String s) {
                tvConsoleText.append("unbind tag " + tag + " success\n");
            }

            @Override
            public void onFailed(String errorCode, String errorMsg) {
                tvConsoleText.append("unbind tag " + tag + " failed." +
                        "errorCode: " + errorCode + ", errorMsg:" + errorMsg + "\n");
            }
        });

查询标签

查询目标绑定的标签,当前仅支持查询设备标签。

注意

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

接口定义

void listTags(int target, CommonCallback callback);

参数说明

参数

类型

是否必须

说明

target

int

目标类型可选值:

  • 1:本设备

目标类型可选值(SDK版本V2.3.5及以上版本):

  • CloudPushService.DEVICE_TARGET:本设备

callback

CommonCallback

回调

代码示例

        mPushService = PushServiceFactory.getCloudPushService();
        mPushService.listTags(CloudPushService.DEVICE_TARGET, new CommonCallback() {
            @Override
            public void onSuccess(String response) {
                tvConsoleText.append("tags:" + response + " \n");
            }

            @Override
            public void onFailed(String errorCode, String errorMsg) {
                tvConsoleText.append("list tags failed. errorCode:" + errorCode + " errorMsg:" + errorMsg);
            }
        });