使用

初始化

ProfileManager本身无需初始化,默认依赖基础库内置shark实例,因此在使用ProfileManager之前,需先初始化基础库。

说明:基础库初始化请参考:

  • "将TMF添加到您的项目中"初始化部分
  • "基础库API"

设置UserId

/**
 * 绑定UserId(按用户账号推送)
 * @param userId 用户ID 传空值时表示解绑操作
 */
public static void setUserId(String userId);
参数名称 参数类型 参数描述 必选
userId String 用户ID,传空值时表示解绑操作 Y
listener IConchPushListener 云指令下发监听接口 Y

示例:

ProfileManager.setUserId("158xxxxxxxx");

地理位置上报

/**
 * 地理位置上报(按地区推送)
 *
 * @param country  国家
 * @param province 省
 * @param city     市
 */
public static void setLocation(String country, String province, String city)
参数名称 参数类型 参数描述 必选
country String 国家 Y
province String Y
city String Y

设置标签

/**
 * 设置单个标签
 * 如果标签key已设置过,则直接覆盖其value
 *
 * @param tag
 * @param value
 */
public static void setTag(String tag, String value)
参数名称 参数类型 参数描述 必选
tag String 标签名,注意需要在控制台创建好相应标签 Y
value String 标签值,如果是限定值标签,值的范围需要在限定范围内 Y

批量设置标签

/**
 * 设置多个标签
 *
 * @param tags
 */
public static void setTags(Map<String, String> tags)
参数名称 参数类型 参数描述 必选
tags Map key对应标签名,value对应标签值 Y

标签设置错误监听器

/**
 * 设置标签错误监听器
 * 用于监听所上报的标签键/值不符合要求的具体错误原因
 *
 * @param listener
 */
public static void setTagErrorListener(ITagErrorListener listener)

public interface ITagErrorListener {

    /**
     * 云端回调上报的标签不符合要求,无法使用该标签
     *
     * @param tagResults Tag结果结构体,返回具体Tag及其错误原因
     */
    public void onError(List<TagResult> tagResults);

    /**
     * Tag结果结构体,包括Tag的key-value及其错误码
     */
    public class TagResult {
        public String mTagKey;
        public String mTagValue;
        //上报返回错误码,详见TagErrorCode
        public int mErrorCode;
    }
}

public class TagErrorCode {

    public static final int ERR_NONE = 0;//无错误,即上报成功
    public static final int ERR_ISharkNullError = -997;//传入的IShark未完成初始化
    public static final int ERR_TagNullError = -998;//设置了tag中存在key/value为null的错误
    public static final int ERR_NetworkError = -999;//网络错误,即当前无网络
    public static final int ERR_ServerError = -1001;//服务端发生错误
    public static final int ERR_SDKInnerError = -1002;//SDK内部发生错误

    //云端返回上报标签不符合要求的具体错误码
    public static final int ERR_ReportTagNotAvai = -1004;//上报标签不可用。标签无效或未配置,需检查配置
    public static final int ERR_ReportTagValueNotAvai = -1005;//上报标签值不在配置范围内
    public static final int ERR_ReportTagValueTooLong = -1006;//上报标签值过长,需要小于128字节
}
Copyright © 2013-2023 Tencent Cloud. all right reserved,powered by GitbookUpdate Time 2023-08-31 14:46:07

results matching ""

    No results matching ""