1- # JPush API client library for Java
1+ # JPush API Java Library
22
33## 概述
4+
45这是 JPush REST API 的 Java 版本封装开发包,是由极光推送官方提供的,一般支持最新的 API 功能。
56
67对应的 REST API 文档:< http://docs.jpush.cn/display/dev/REST+API >
78
8- API Javadoc:[ API Docs] ( http://jpush.github.io/jpush-api-java-client/apidocs/ )
9+ 本开发包 Javadoc:[ API Docs] ( http://jpush.github.io/jpush-api-java-client/apidocs/ )
10+
11+ 版本更新:[ Release页面] ( https://github.com/jpush/jpush-api-java-client/releases ) 。下载更新请到这里。
12+
913
1014## 安装
1115
@@ -24,13 +28,14 @@ API Javadoc:[API Docs](http://jpush.github.io/jpush-api-java-client/apidocs/)
2428请到 [ Release页面] ( https://github.com/jpush/jpush-api-java-client/releases ) 下载相应版本的发布包。
2529
2630### 依赖包
27- * slf4j/ log4j (Log )
28- * gson (Google)
29- * guava (Google)
31+ * [ slf4j] ( http://www.slf4j.org/ ) / log4j (Logger )
32+ * [ gson] ( https://code.google.com/p/google-gson/ ) (Google JSON Utils )
33+ * [ guava] ( https://code.google.com/p/guava-libraries/ ) (Google Java Utils )
3034
3135> 其中 slf4j 可以与 logback, log4j, commons-logging 等日志框架一起工作,可根据你的需要配置使用。
3236
3337如果使用 Maven 构建项目,则需要在你的项目 pom.xml 里增加:
38+
3439```
3540 <dependency>
3641 <groupId>com.google.code.gson</groupId>
@@ -42,7 +47,6 @@ API Javadoc:[API Docs](http://jpush.github.io/jpush-api-java-client/apidocs/)
4247 <artifactId>slf4j-api</artifactId>
4348 <version>1.7.5</version>
4449 </dependency>
45-
4650 <dependency>
4751 <groupId>org.slf4j</groupId>
4852 <artifactId>slf4j-log4j12</artifactId>
@@ -64,7 +68,6 @@ API Javadoc:[API Docs](http://jpush.github.io/jpush-api-java-client/apidocs/)
6468 <artifactId>guava</artifactId>
6569 <version>17.0</version>
6670 </dependency>
67-
6871 <dependency>
6972 <groupId>com.squareup.okhttp</groupId>
7073 <artifactId>mockwebserver</artifactId>
@@ -77,7 +80,9 @@ API Javadoc:[API Docs](http://jpush.github.io/jpush-api-java-client/apidocs/)
7780如果不使用 Maven 构建项目,则项目 libs/ 目录下有依赖的 jar 可复制到你的项目里去。
7881
7982### 构建本项目
83+
8084建议直接使用 maven,执行命令:
85+
8186```
8287maven package
8388```
@@ -109,13 +114,15 @@ maven package
109114进行推送的关键在于构建一个 PushPayload 对象。以下示例一般的构建对象的用法。
110115
111116* 快捷地构建推送对象:所有平台,所有设备,内容为 ALERT 的通知。
117+
112118```
113119 public static PushPayload buildPushObject_all_all_alert() {
114120 return PushPayload.alertAll(ALERT);
115121 }
116122```
117123
118124* 构建推送对象:所有平台,推送目标是别名为 "alias1",通知内容为 ALERT。
125+
119126```
120127 public static PushPayload buildPushObject_all_alias_alert() {
121128 return PushPayload.newBuilder()
@@ -127,6 +134,7 @@ maven package
127134```
128135
129136* 构建推送对象:平台是 Android,目标是 tag 为 "tag1" 的设备,内容是 Android 通知 ALERT,并且标题为 TITLE。
137+
130138```
131139 public static PushPayload buildPushObject_android_tag_alertWithTitle() {
132140 return PushPayload.newBuilder()
@@ -143,6 +151,7 @@ maven package
143151```
144152
145153* 构建推送对象:平台是 iOS,推送目标是 "tag1", "tag_all" 的并集,推送内容同时包括通知与消息 - 通知信息是 ALERT,并且附加字段 from = "JPush";消息内容是 MSG_CONTENT。通知是 APNs 推送通道的,消息是 JPush 应用内消息通道的。
154+
146155```
147156 public static PushPayload buildPushObject_ios_tagAnd_alertWithExtrasAndMessage() {
148157 return PushPayload.newBuilder()
@@ -160,6 +169,7 @@ maven package
160169```
161170
162171* 构建推送对象:平台是 Andorid 与 iOS,推送目标是 ("tag1" 与 "tag2" 的交集)并("alias1" 与 "alias2" 的交集),推送内容是 - 内容为 MSG_CONTENT 的消息,并且附加字段 from = JPush。
172+
163173```
164174 public static PushPayload buildPushObject_ios_audienceMore_messageWithExtras() {
165175 return PushPayload.newBuilder()
@@ -201,6 +211,3 @@ if (receivedsResult.isResultOK()) {
201211```
202212
203213
204- ## 版本更新
205-
206- [ Release页面] ( https://github.com/jpush/jpush-api-java-client/releases ) 有详细的版本发布记录与下载。
0 commit comments