API
类
本SDK中有四个重要的开放类,分别为:PushManager、PushSettings、BasicPushNotificationBuilder和CustomPushNotificationBuilder,另外还有常量类PushConstants和回调接收类PushMessageReceiver。类 | 描述 |
---|---|
PushManager | 提供了所有使用Push服务的静态方法 |
PushSettings | 提供了端上Push服务的配置静态方法 |
BasicPushNotificationBuilder | 用于定制 Android Notification 里的基础样式和行为 |
CustomPushNotificationBuilder | 用于定制 Android Notification 里的 sound / flags / icon,以及通知栏的layout、图标 和状态栏图标 |
PushConsants | SDK对外的常量定义 |
PushMessageReceiver | 自定义接收push消息和通知实现的直接父类 |
接口与方法
Push Android SDK目前支持以下接口:
分类 | 功能 | API函数原型 |
---|---|---|
Push服务接口 | 提供Push服务 | startWork, stopWork, resumeWork |
Tag管理接口 | Tag的创建与删除 | setTags, delTags, onListTags |
通知管理接口 | 自定义通知样式 | CustomPushNotificationBuilder, BasicPushNotificationBuilder, setNotificationFlags, setNotificationDefaults, setStatusbarIcon, setLayoutDrawable, setNotificationSound, setNotificationBuilder |
设置接口 | Push服务设置 | enableDebugMode |
LBS推送接口 | 打开或关闭精确LBS推送 | enableLbs, disableLbs |
异步消息处理接口 | Push消息处理receiver | onBind, onMessage, onNotificationClicked, onNotificationArrived, onSetTags, onDelTags, onListTags, onUnbind |
Push服务初始化及绑定-- startWork
函数原型
public static void startWork(Context context, int loginType, String loginValue);
功能
PushManager类定义的静态方法,完成Push服务的初始化,并且自动完成bind工作。
参数
- context:当前执行Context
- loginType:绑定认证方式(无账号认证方式
PushConstants.LOGIN_TYPE_API_KEY
) - loginValue:应用的API Key
返回结果
通过自定义的Receiver类里onBind方法返回结果,详见 onBind
注意:不要在Application的onCreate里去做startWork的操作。
停止和恢复Push服务-- stopWork、resumeWork
函数原型
public static void stopWork(Context context);
功能
PushManager类定义的静态方法,停止本应用Push服务进程,并且完成unbind工作。startWork和resumeWork都会重新开启本应用Push功能。
参数
- context:当前执行Context
返回结果
通过自定义的Receiver类里onUnbind方法返回结果,详见 onUnbind
函数原型
public static void resumeWork(Context context);
功能
PushManager类定义的静态方法,恢复本应用Push服务,并且再次完成bind工作。
参数
- context:当前执行Context
返回结果
通过自定义的Receiver类里onBind方法返回结果,详见 onBind
查询push是否被停止的接口-- isPushEnabled
函数原型
public static boolean isPushEnabled(Context context);
功能
PushManager类定义的静态方法,查询push是否已经被停止。
参数
- context:当前执行Context
返回结果
- true:已开启push服务
- false:未开启push服务
设置免打扰时段-- setNoDisturbMode
函数原型
PushManager.setNoDisturbMode(Context