<
## 安装
### 安装SDK
#### 快速入门
由于卓易推送SDK基于卓易CoreSDK，所以请在安装卓易推送SDK之前仔细阅读[快速入门](http://www.droibaas.com/html/doc_24138.html)，并确保已经完成快速入门的所有步骤 。
#### Android Studio 安装SDK
在工程Module目录的`build.gradle`文件中添加如下依赖：
dependencies {
/*其他依赖 */
compile 'com.droi.sdk:push:+'
compile 'com.android.support:support-v4:23.3.0'
}
在工程Module目录的`build.gradle`文件中配置`DROI_PUSH_APPID`参数，内容为应用APPID：
android {
defaultConfig {
/*配置applicationId */
applicationId "你的应用包名"
/*配置应用APPID */
manifestPlaceholders = [DROI_PUSH_APPID: '你的应用APPID']
}
// 其他配置...
}
**注意：
Android Studio工程build.gradle需要配置`applicationId`和`DROI_PUSH_APPID`信息，否则会影响推送；**
#### Eclipse 安装SDK
下载[卓易推送SDK](http://www.droibaas.com/Index/download.html)，解压后将 `droipushsdk.jar`和`utility.jar`包导入到工程的 `libs` 目录下；右键工程根目录，选择`Properties` -> `Java Build Path` -> `Libraries`，然后点击`Add External JARs...` 选择指向jar的路径，点击OK，即导入成功**（ADT17及以上版本不需要手动导入）**。
将SDK解压后文件夹`libs`下的文件复制到工程的 `libs` 目录。
将`res`文件夹直接复制到工程目录下，和工程本身`res`目录合并。请不要随意变更其中的文件**（`res`文件均以dp开头）**。
**权限配置**
在应用AndroidManidest中配置如下权限
<!-- 推送SDK使用权限 -->
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="android.permission.FLASHLIGHT" />
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
**组件配置**
在应用AndroidManidest中配置如下组件
<!--注册推送服务-->
<service
android:name="com.droi.sdk.push.DroiPushService"
android:exported="true"
android:process=":pushservice_v2">
<intent-filter>
<action android:name="com.droi.sdk.push.action.START_v2" />
</intent-filter>
</service>
<!--注册推送广播接收器组件-->
<receiver
android:name="com.droi.sdk.push.TickAlarmReceiver"
android:process=":pushservice_v2">
</receiver>
<receiver android:name="com.droi.sdk.push.DroiPushReceiver">
<intent-filter>
<action android:name="android.intent.action.PACKAGE_REMOVED" />
<action android:name="android.intent.action.PACKAGE_ADDED" />
<action android:name="android.intent.action.PACKAGE_REPLACED" />
<data android:scheme="package" />
</intent-filter>
<intent-filter>
<action android:name="android.net.conn.CONNECTIVITY_CHANGE" />
<action android:name="android.intent.action.PHONE_STATE" />
<action android:name="android.intent.action.USER_PRESENT" />
<action android:name="android.intent.action.USER_CLEARNOTIFY" />
<action android:name="com.droi.sdk.push.action.DATA_v2" />
<!-- 请使用当前应用包名作为前缀 -->
<action android:name="你的应用包名.Action.START_v2" />
<action android:name="com.droi.sdk.push.action.REMOVE_NOTIFICATION_v2" />
</intent-filter>
</receiver>
<!--注册推送弹出框Activity组件-->
<activity
android:name="com.droi.sdk.push.DroiPushActivity"
android:configChanges="orientation|keyboardHidden|screenSize"
android:exported="false"
android:screenOrientation="portrait"
android:theme="@style/droi_dialog_activity_style" />
<!--辅助推送Provider-->
<provider
android:name="com.droi.sdk.push.PushProvider"
android:authorities="com.droi.sdk.push.PushProvider_你的应用APPID"
android:exported="true">
</provider>
## 使用
1. 初始化
在Application的`onCreate()`方法中调用：
DroiPush.initialize(context, apiKey);
**注意：
由于DroiBaaS策略变更，推送SDK初始化需传入ApiKey参数。获取步骤如下：
若推送服务未激活，先通过web控制台->应用管理中心->设置详情->安全设置->推送服务激活服务;
通过web控制台->应用管理中心->应用设置->安全密钥获取推送ApiKey；**
2. 获取设备、应用ID与渠道
SDK提供接口获取设备ID(deviceId)、应用ID(appId)、渠道号(channel)等信息。
- 获取deviceId
DroiPush.getDeviceIdInBackground(mContext, new GetDeviceIdCallback(){
@Override
public void onGetDeviceId(String deviceId) {
// 通过回调返回deviceId，成功返回deviceId字符串，否则返回null
}
});
- 获取appId
String appId = DroiPush.getAppId(context);
- 获取channel
String channel = DroiPush.getChannel(context);
**注意：
deviceId首次获取需要联网，无网络情况下返回null；**
3. 标签操作
卓易推送支持向指定标签所有设备推送消息，提供`覆盖`、`追加`、`删除`、`获取`标签的接口。标签参数为所有标签拼接字符串，各标签之间使用`英文逗号`分隔。
- 覆盖标签
使用传入标签替换已有标签，接口调用如下所示：
DroiPush.replaceTagsInBackground(getApplicationContext(), tag, new DroiCallback<String>(){
@Override
public void result(final String result, DroiError droiError) {
// result为服务端返回信息
if (droiError.isOk()) {
// 替换标签成功
} else {
// 获取出错提示信息
String resultStr = droiError.getAppendedMessage();
}
}
});
- 追加标签
将传入标签追加到已有标签当中，接口调用如下所示：
DroiPush.appendTagsInBackground(getApplicationContext(), tag, new DroiCallback<String>() {
@Override
public void result(final String result, DroiError droiError) {
// result为服务端返回信息
String resultStr = "";
if (droiError.isOk()) {
// 追加标签成功
} else {
// 获取错误码及提示信息
int errorCode = droiError.getCode();
String errorInfo = droiError.getAppendedMessage();
}
}
});
- 删除标签
从已有标签中删除传入的标签，接口调用如下所示：
DroiPush.deleteTagsInBackground(getApplicationContext(), tag, new DroiCallback<String>() {
@Override
public void result(final String result, DroiError droiError) {
// result为服务端返回信息
if (droiError.isOk()) {
// 删除标签成功
} else {
// 获取错误码及提示信息
int errorCode = droiError.getCode();
String errorInfo = droiError.getAppendedMessage();
}
}
});
- 获取所有标签
查询标签并返回，接口调用如下所示：
DroiPush.queryTagsInBackground(getApplicationContext(), new DroiCallback<String>() {
@Override
public void result(final String result, DroiError droiError) {
if (droiError.isOk()) {
// 获取标签成功，result为标签JSON串，例如{"tags":"aa,bb"}
} else {
// 获取错误码及提示信息
int errorCode = droiError.getCode();
String errorInfo = droiError.getAppendedMessage();
}
}
});
返回标签为JSON字符串，以下为字段含义：
| 字段名称 | 字段含义 |
| -------- | ----- |
| tags | 所有标签拼接字符串，使用英文逗号分隔，如"aa,bb,cc" |
**注意：
应用tag数量最多限制为1024个，每个长度最多为256字符；
tag内容不能加入URLEncode等其他的变换处理，建议使用原生字符串；**
4. 设置静默时间
静默时间指的每天对应的时间段内，不展示推送消息；比如为了防止骚扰到用户，可以把每天0:00到6:00设置为静默时间。
- 设置静默时间
DroiPush.setSilentTime(context, 0, 0, 6, 0);
- 获取静默时间
int[] time = DroiPush.getSilentTime(context);
- 清除静默时间
DroiPush.clearSilentTime(context);
5. 启用/禁用推送
禁用后，推送功能将不可用，请谨慎调用
- 启用/禁用推送
DroiPush.setPushableState(context, true);
- 获取推送开关状态
boolean isEnabled = DroiPush.getPushableState(context);
6. 透传消息处理
DroiMessageHandler抽象类提供处理透传消息的方法`onHandleCustomMessage`，以下为示例代码：
DroiPush.setMessageHandler(new DroiMessageHandler() {
@Override
public void onHandleCustomMessage(final Context context, final String message) {
// TODO Auto-generated method stub
//message为透传消息内容，应用获取后自行处理
new Handler(getMainLooper()).post(new Runnable() {
@Override
public void run() {
// TODO Auto-generated method stub
Toast.makeText(context, "Demo Custom Msg:" + message, Toast.LENGTH_LONG).show();
}
});
}
}); ]]>
18501785218
baas.business@droi.com
微信公众号
官方微博