Push 服务
SDK 用户手册
(Android 版)
发布日期: 2014年1月20日
百度开发者中心
(版权所有,翻版必究)
Push SDK 用户手册 (Android 版)
百度开发者中心 2
目录
第 1 章 简介............................................................................................................................................. 3
第 2 章 阅读对象 ..................................................................................................................................... 4
第 3 章 SDK 功能说明 .......................................................................................................................... 5
3.1 框架设计............................................................................................................................................ 5
3.2 主要功能............................................................................................................................................ 5
第 4 章 开发前准备 ................................................................................................................................. 7
4.1 运行环境............................................................................................................................................ 7
4.2 参数申请及权限开通 ........................................................................................................................ 7
4.3 账户支持............................................................................................................................................ 7
第 5 章 使用 SDK 开发应用 .................................................................................................................... 8
5.1 添加 SDK 到 APP 工程 .................................................................................................................... 8
5.2 调用 API .......................................................................................................................................... 11
第 6 章 API 说明 ............................................................................................................................... 18
6.1 类 ..................................................................................................................................................... 19
6.2 API ................................................................................................................................................... 19
6.3 常量说明.......................................................................................................................................... 29
第 7 章 联系我们 ................................................................................................................................... 31
第 8 章 缩略语 ....................................................................................................................................... 32
Push SDK 用户手册 (Android 版)
百度开发者中心 3
第1章 简介
百度 Push 服务 Android SDK 是百度官方推出的 Push 服务的 Android 平台开发 SDK,提供给
Android 开发者简单的接口,轻松集成百度 Push 推送服务。
Android Push 服务以后台 service 方式运行。如果一款手机安装了多个集成了 Push SDK 的应用,
不会每个应用都开启一个后台 service,而是只有一个 service 实例运行,采用多个应用共享一个 Push
通道的方式。这样的设计能够减少手机系统运行的进程数,减少内存使用,降低功耗,同时一个通道
能减少网络流量开销。
Push service 运行于一个独立进程,不和主进程运行于同一进程,主程序不需要常驻内存,当 Push
service 接受到 Push 消息后,会通过 Intent 接口发送给主程序处理。
Push Android SDK 的完整下载包为 Baidu-Push-SDK-Android-L2-VERSION.zip,VERSION 是版本
号,如 2.1.0。下载解压后的目录结构如下所示:
demo
存放一个 Android 示例工程,可以快速帮助用户了解如何使用 SDK
lib
pushservice-VERSION.jar:push SDK 以 jar 方式提供;
libpush-socket.so: Push 服务需要用到的 jni 资源。请将您要支持的对应体系的 so 文件夹
拷贝到您的工程 libs 目录下。
请将工程的 Application 类继承 FrontiaApplication 类,在 onCreate 函数中加上:
super.onCreate(),否则会崩溃;
另外一种方法是:在自定义 Application 的 onCreate 方法中调用 Push 的接口:
FrontiaApplication.initFrontia(Context context),否则 push 的接口无法使用。
SDK 富媒体功能用到的资源文件 res 文件夹
用户手册
版本说明
Push SDK 用户手册 (Android 版)
百度开发者中心 4
第2章 阅读对象
本文档面向所有使用该 SDK 的 Android 开发人员、测试人员、合作伙伴以及对此感兴趣的其他用
户。
Push SDK 用户手册 (Android 版)
百度开发者中心 5
第3章 SDK 功能说明
3.1 框架设计
Push Android SDK 是开发者与 Push 服务器之间的桥梁。可以让用户越过复杂的 Push HTTP/HTTPS
API,直接和 Push 服务器进行交互来使用 Push 服务。(框架设计如图 1 所示)
用户应用
Push SDK
Push HTTP/HTTPS API
Push服务器
图 1 Push SDK 框架图
3.2 主要功能
本 SDK 主要提供以下功能的接口:
1. Push 服务
- Push 服务初始化及绑定
- Push 服务停止和恢复
2. Tag 管理
创建或者删除标签
- 创建 Tag
- 删除 Tag
3. 通知推送
接收和展现通知,还提供自定义通知栏样式的功能,可以:
- 设置自定义通知的 Builder
- 设置默认的通知的 Builder
- 设置富媒体通知的 Builder
4. LBS 推送
- 打开精确 LBS 推送模式 enableLbs
- 关闭精确 LBS 推送模式 disableLbs