API接口说明
设置用户同意隐私协议接口
通过调用此接口告知协同生态SDK用户是否同意了隐私协议。
TH.setAgreePolicy(Context context, boolean agree)
参数说明
- boolean agree为用户是否同意了隐私协议,true为同意,false为不同意,如果不设置隐私协议,可能在SDK实际运行中由于某些需要授权的权限问题导致部分功能失效。
- 合入推送SDK的App需要在自身隐私协议中设置移动APP推送隐私协议,隐私协议链接为:http://sofire.bdstatic.com/push/privacy.html
开启PUSH服务
通过此接口,可以开启推送服务,绑定设备信息进行上报,建议开发者在调用完SDK的init方法后立即调用此方法,以便能够及时收到推送消息。
TH.startPushService ();
设置通知状态栏小图标
该方法用于设置通知状态栏小图标。
TH.tinvoke(100019, "ssi",new Class[] { int.class }, R.drawable.b_b);
参数说明
- R.drawable.b_b:需要设置的图标文件资源id。
设置静默时间段
该方法用于设置静默时间。请于初始化方法后调用。若不设置静默时间,默认静默时间为晚11点到次日7点。
TH.tinvoke(100019, "setSilentTime",new Callback() {
@Override
public Object onEnd(Object...arg0) {
return null;
}
@Override
public Object onError(Object...arg0) {
return null;
}
},new Class[] { int.class,int.class }, int startHour,int durationHour);
参数说明
-
"setSilentTime" 是SDK的接口名称。
new Callback() { @Override public Object onEnd(Object...arg0) { return null; } @Override public Object onError(Object...arg0) { return null; } }
- 是一个实例对象,用于接收该方法的执行结果。
CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回boolean型的结果,true表示设置成功,false 表示设置失败。 - CallBack对象的onError方法会在执行异常时收到Integer型的错误码,错误码为其参数arg0[0]。错误码含义见通用错误码。
- new Class[] { int.class,int.class} 是百度慧推SDK接口的参数列表。
- int startHour是静默时间的开始时间值,24小时制,如传入13表示静默时间从下午1时开始。
- int durationHour是静默时间的持续时间,单位为小时,如静默2小时则传入2。
获取推送设备的唯一标识ID
该方法用于获取当前设备的唯一标识ID,该ID用于对设备进行唯一映射。
TH.tinvoke(100019, "getPushUid",new Callback() {
@Override
public Object onEnd(Object...arg0){
return null;
}
@Override
public Object onError(Object...arg0) {
return null;
}
});
参数说明
- "getPushUid" 是SDK的接口名称。
- CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回String型的结果,值为当前设备的唯一标识ID。
- CallBack对象的onError方法会在执行异常时收到Integer型的错误码,错误码为其参数arg0[0]。错误码含义见通用错误码。
开启/关闭调试信息
该方法用开启或关闭调试信息输出。如果不调用该方法,默认值为false。将debug参数设为true之后,将会在logcat中输出TAG为“PUSH_SDK”的调试信息。
TH.tinvoke(100019, "setDebug", new Class[] { boolean.class }, boolean debug);
参数说明
- "setDebug" 是SDK的接口名称。
- new Class[] { boolean.class }是SDK接口的参数列表。
- debug是要设置的调试信息开关的值。
绑定别名
该方法用与给设备绑定别名,一台设备只能绑定一个别名
别名约束:
- UTF8编码、不能以 _ (下划线)开头、小于40个字节
- 只能包含:字母(区分大小写)、数字、汉字、@!#$&*+=.|_
-
一个设备只能绑定一个别名,重复绑定则会覆盖
TH.tinvoke(100019, "setAlias", new Callback() { @Override public Object onEnd(Object...arg0) { Log.d("PUSH_SDK", "onEnd:" + arg0[0]); return super.onEnd(arg0); } @Override public Object onError(Object...arg0) { Log.d("PUSH_SDK", "onError:" + arg0[0]); return super.onError(arg0); } }, newClass[] { String.class },String alias);
参数说明:
- " setAlias " 是SDK的接口名称。
- CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回Integer类型的结果码。结果码含义如下:
0 - 成功
10000 - 失败:设备未注册
100001 - 绑定失败:别名格式不符合规范
其他结果码见通用结果码。 - CallBack对象的onError方法会在执行异常时收到Integer型的错误码,错误码为其参数arg0[0]。错误码含义见通用错误码。
- new Class[] { String.class }是SDK接口的参数列表。
- alias是要设置的别名。
获取别名
该方法用获取一个设备已绑定的别名。
TH.tinvoke(100019, "getAlias", new Callback() {
@Override
public Object onEnd(Object...arg0) {
Log.d("PUSH_SDK", "onEnd:" + arg0[0]);
return super.onEnd(arg0);
}
@Override
Public Object onError(Object...arg0) {
Log.d("PUSH_SDK", "onError:" + arg0[0]);
return super.onError(arg0);
}
}, newClass[] {});
参数说明
- "getAlias" 是SDK的接口名称。
- CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回Pair<Integer, String>型的结果,
Integer为结果码,String为别名。
结果码含义如下:
0 - 成功
10000 - 失败:设备未注册
110001 - 查询别名出错,原因:设备尚未绑定别名
其他结果码见通用结果码。 - CallBack对象的onError方法会在执行异常时收到Integer型的错误码,错误码为其参数arg0[0]。 错误码含义见通用错误码。
- new Class[] { }是SDK接口的参数列表。
删除别名
该方法用于删除一个设备已绑定的别名。
TH.tinvoke(100019, "deleteAlias", new Callback() {
@Override
public Object onEnd(Object...arg0) {
Log.d("PUSH_SDK", "onEnd:" + arg0[0]);
return super.onEnd(arg0);
}
@Override
public Object onError(Object...arg0) {
Log.d("PUSH_SDK", "onError:" + arg0[0]);
return super.onError(arg0);
}
}, newClass[] {});
参数说明
- "deleteAlias" 是SDK的接口名称。
- CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回Integer型的数字结果码。
结果码含义如下:
0 - 成功
10000 - 失败:设备未注册
100001 - 绑定失败:别名格式不符合规范
其他结果码见通用结果码。 - CallBack对象的onError方法会在执行异常时收到Integer型的错误码,错误码为其参数arg0[0]。 错误码含义见通用错误码。
- new Class[] { }是SDK接口的参数列表。
设置标签
该方法用于给设备设置标签,一个设备可以设置多个标签,最多可以设置添加1000个标签。
标签约束:
- UTF8编码、不能以 _ (下划线)开头、小于40个字节
- 只能包含:字母(区分大小写)、数字、汉字、@!#$&*+=.|_
- 每个设备可以设置多个标签,数量上限1000
TH.tinvoke(100019, "addTags", new Callback() {
@Override
public Object onEnd(Object...arg0) {
Log.d("PUSH_SDK", "onEnd:" + arg0[0]);
return super.onEnd(arg0);
}
@Override
Public Object onError(Object...arg0) {
Log.d("PUSH_SDK", "onError:" + arg0[0]);
return super.onError(arg0);
}
}, newClass[] {String[].class},new Object[]{String[] tags});
参数说明
- "addTags" 是SDK的接口名称。
- CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回Integer型的数字结果码。 结果码含义如下: 0 - 成功 10000 - 失败:设备未注册 200001 - 失败,标签不符合规范 200002 - 失败,此设备标签数量超过上限 200003 - 失败,增加或更新的标签为空 200004 - 失败,每次最多设置和更新100个标签 其他结果码见通用结果码。
- CallBack对象的onError方法会在执行异常时收到Integer型的错误码,错误码为其参数arg0[0]。错误码含义见通用错误码。
- new Class[] { String[].class}是SDK接口的参数列表。
- tags 是一个String[],存放要添加的标签。
删除标签
该方法用于删除一个设备已设置的标签,可以一次性删除多个标签。
TH.tinvoke(100019, "deleteTags", new Callback() {
@Override
public Object onEnd(Object...arg0) {
Log.d("PUSH_SDK", "onEnd:" + arg0[0]);
return super.onEnd(arg0);
}
@Override
public Object onError(Object...arg0) {
Log.d("PUSH_SDK", "onError:" + arg0[0]);
return super.onError(arg0);
}
}, newClass[] {String[].class},new Object[]{String[] tags});
参数说明
- "deleteTags" 是SDK的接口名称。
- CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回Integer型的数字结果码。
结果码含义如下:
0 - 成功
10000 - 失败:设备未注册
200001 - 失败,标签不符合规范
200002 - 失败,此设备标签数量超过上限
200003 - 失败,增加或更新的标签为空
200004 - 失败,每次最多设置和更新100个标签
其他结果码见通用结果码。 - CallBack对象的onError方法会在执行异常时收到Integer型的错误码,错误码为其参数arg0[0]。 错误码含义见通用错误码。
- new Class[] { String[].class }是SDK接口的参数列表。
- tags 是一个String[],存放要删除的标签。
更新标签
该方法用更新一个设备已设置的标签,每次更新标签会清空原有所有设置的标签,并更换为新设的标签列表。
TH.tinvoke(100019, "updateTags", new Callback() {
@Override
public Object onEnd(Object...arg0) {
Log.d("PUSH_SDK", "onEnd:" + arg0[0]);
return super.onEnd(arg0);
}
@Override
Public Object onError(Object...arg0) {
Log.d("PUSH_SDK", "onError:" + arg0[0]);
return super.onError(arg0);
}
}, newClass[] {String[].class},new Object[]{String[] tags});
参数说明
- "updateTags" 是SDK的接口名称。
- CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回Integer型的数字结果码。
结果码含义如下:
0 - 成功
10000 - 失败:设备未注册
200001 - 失败,标签不符合规范
200002 - 失败,此设备标签数量超过上限
200003 - 失败,增加或更新的标签为空
200004 - 失败,每次最多设置和更新100个标签
其他结果码见通用结果码。 - CallBack对象的onError方法会在执行异常时收到Integer型的错误码,错误码为其参数arg0[0]。 错误码含义见通用错误码。
- new Class[] { String[].class }是SDK接口的参数列表。
- tags 是一个String[],存放要更新的标签。
清空标签
该方法用于清空一个设备已设置的所有标签。
TH.tinvoke(100019, "cleanTags", new Callback() {
@Override
public Object onEnd(Object...arg0) {
Log.d("PUSH_SDK", "onEnd:" + arg0[0]);
return super.onEnd(arg0);
}
@Override
public Object onError(Object...arg0) {
Log.d("PUSH_SDK", "onError:" + arg0[0]);
return super.onError(arg0);
}
});
参数说明
- "cleanTags " 是SDK的接口名称。
- CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回Integer型的数字结果码。
结果码含义如下:
0 - 成功
10000 - 失败:设备未注册
其他结果码见通用结果码。 - CallBack对象的onError方法会在执行异常时收到Integer型的错误码,错误码为其参数arg0[0]。 错误码含义见通用错误码。
- new Class[] { }是SDK接口的参数列表。
查询单个标签
该方法用于查询一个设备是否已设置某个标签。
TH.tinvoke(100019, "isTagBinding", new Callback() {
@Override
public Object onEnd(Object...arg0) {
Log.d("PUSH_SDK", "onEnd:" + arg0[0]);
return super.onEnd(arg0);
}
@Override
public Object onError(Object...arg0) {
Log.d("PUSH_SDK", "onError:" + arg0[0]);
return super.onError(arg0);
}
}, newClass[] {String.class},String tag });
参数说明
- "isTagBinding " 是SDK的接口名称。
- CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回Integer型的数字结果码。
结果码含义如下:
0 - 成功 & 设备绑定所查询的标签
10000 - 失败:设备未注册
200001 - 失败,标签不符合规范
210001 - 查询单个标签,设备未绑定所查询的标签 其他结果码见通用结果码。 - CallBack对象的onError方法会在执行异常时收到Integer型的错误码,错误码为其参数arg0[0]。错误码含义见通用错误码。
- new Class[] { String.class}是SDK接口的参数列表。
- tag表示要查询的标签
查询所有标签
该方法用于获取标一个设备已设置的所有标签。
TH.tinvoke(100019, "getAllTags", new Callback() {
@Override
public Object onEnd(Object...arg0) {
Log.d("PUSH_SDK", "onEnd:" + arg0[0]);
return super.onEnd(arg0);
}
@Override
public Object onError(Object...arg0) {
Log.d("PUSH_SDK", "onError:" + arg0[0]);
return super.onError(arg0);
}
});
参数说明
- "getAllTags " 是SDK的接口名称。
- CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回Pair<Integer,ArrayList
>型, 其中Integer代表结果码,ArrayList 代表标签列表。
结果码含义如下:
0 - 成功
10000 - 失败:设备未注册
其他结果码见通用结果码。 - CallBack对象的onError方法会在执行异常时收到Integer型的错误码,错误码为其参数arg0[0]。 错误码含义见通用错误码。
- new Class[] { }是SDK接口的参数列表。
获取是否拥有通知栏权限
该方法用于获取是否有通知栏权限。
TH.tinvoke(100019, "areNotificationsEnabled", new Callback() {
@Override
public Object onEnd(Object...arg0) {
Log.d("PUSH_SDK", "onEnd:" + arg0[0]);
return super.onEnd(arg0);
}
@Override
public Object onError(Object...arg0) {
Log.d("PUSH_SDK", "onError:" + arg0[0]);
return super.onError(arg0);
}
});
参数说明
- "areNotificationsEnabled" 是SDK的接口名称。
- CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回Boolean类型结果码
结果码含义如下:
true - 成功。
其他结果码见通用结果码。 - CallBack对象的onError方法会在执行异常时收到Integer型的错误码,错误码为其参数arg0[0]。 错误码含义见通用错误码。
设置应用处于前台状态下,能否显示通知栏
该方法用于设置当应用属于前台是否展示通知,避免应用一旦打开通知立即展示,避免给用户带来干扰,默认是展示。
TH.tinvoke(100019, "setNotificationEnableInForeground",new Class[] { boolean.class },
false);
参数说明
- "areNotificationsEnabled" 是SDK的接口名称。
- new Class[] { boolean.class } 参数列表
- false 代表最终设置的参数
设置通知栏最大显示的条数
该方法用于设置当前应用在通知栏中,最多展示多少条通知,避免展示过多导致用户体验反感,如果设置了最大条数,新的会覆盖旧的通知。
TH.tinvoke(100019, "setMaxNotificationCount", new Class[] { int.class }, 3);
参数说明
- "areNotificationsEnabled" 是百度慧推SDK的接口名称。
- new Class[] { int.class } 参数列表
- 3 代表最终设置的参数
通知权限引导
该接口是用于引导用户开启通知栏权限,以便能够最大限度收到推送通知,提升推送到达率。
TH.tinvoke(100019, "showNotificationGuide", new Callback() {
@Override
public Object onEnd(Object...arg0) {
Log.d("PUSH_SDK", "onEnd:" + arg0[0]);
return super.onEnd(arg0);
}
@Override
public Object onError(Object...arg0) {
Log.d("PUSH_SDK", "onError:" + arg0[0]);
return super.onError(arg0);
}
});
参数说明
"showNotificationGuide" 是推送SDK的接口名称。 CallBack的onEnd方法会在执行结束后在其arg0[0]位置上返回Integer型的数字结果码。 结果码含义如下:
- 1:通知权限已开启
- -1:SDK不支持通知栏权限引导功能
- -2:通知权限引导功能关闭开
- -3:没有拉取到策略
- -4:调用太频繁,时间小于最小间隔
- -5:配置时间内超过弹出最大弹窗次数
开启/关闭地理围栏功能
该方法用于开启/关闭地理围栏功能。
TH.enableGeoFence(Context context, boolean enabled)
参数说明
- boolean enabled 为是否开启地理围栏功能。