https://github.com/easemob/easemob-push-server-sdk
https://github.com/easemob/easemob-push-server-sdk
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/easemob/easemob-push-server-sdk
- Owner: easemob
- Created: 2022-06-21T07:02:10.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-10T06:56:45.000Z (4 months ago)
- Last Synced: 2025-03-23T00:31:51.216Z (4 months ago)
- Language: Java
- Size: 197 KB
- Stars: 4
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Easemob PUSH SDK for Java
为使用环信服务端推送提供便捷。
## 准备
### 获取环信 appKey, clientId, clientSecret
如果您有环信管理后台账号并创建过应用，请进入 [这里](https://console.easemob.com/user/login) 进行登录。
如图点击查看后，可以看到自己的 appkey、Client ID、ClientSecret，用于 SDK 的初始化。
如果您没有环信管理后台账号，请进入 [这里](https://console.easemob.com/user/register) 进行注册账号，注册成功后请进行登录。
如图先添加应用(也就是创建 appkey，自动生成 Client ID、ClientSecret)，添加成功后在应用列表中可以看到应用信息，点击查看可以看到自己的 appkey、Client
ID、ClientSecret，用于 SDK 的初始化。
## 依赖
### Maven
如果你的项目使用 Maven 构建，在 pom.xml 中添加下面代码即可：
[版本链接](https://search.maven.org/search?q=g:com.easemob.im%20AND%20a:push-sdk-api)
``` xml
com.easemob.im
push-sdk-api
${version}
```
### Gradle
如果你的项目使用 Gradle 构建，可以在 build.grade 中添加下面代码：
``` gradle
implementation 'com.easemob.im:push-sdk-api:${version}'
```
## [JAVA DOCS](https://easemob.github.io/easemob-push-server-sdk/)
### 1、初始化EmPushService
注意: 无特殊需求 EMPushService 上下文中可为单例
``` java
EmPushProperties emPushProperties=EmPushProperties.builder()
.setProtocol(EmPushProperties.Protocol.HTTPS)
.setCredentials(EasemobAppCredentials.of("client_id","client_secret"))
.setAppKey("appkey")
.build();
EMPushService emPushService=new EMPushService(emPushProperties);
```
### 2、API 调用
``` java
//推送特性配置内容，详见：https://docs-im.easemob.com/push/apppush/pushkv
PushMessage pushMessage = PushMessage.builder()
.title("环信")
.content("欢迎使用环信推送服务")
.config(Config.builder()
.clickAction(
ClickAction.builder().url("https://www.easemob.com").build()
)
.badge(
Badge.builder().addNum(1).activity("com.xxx.activity").build()
)
.build()
)
.build();
EMPushHttpResponse eMPushHttpResponse = emPushService.push().single(
PushRequest.builder()
.setTargets(Collections.singletonList("username"))
.setPushMessage(pushMessage)
.build()
);
```