mirror of
https://gitee.com/farsunset/cim.git
synced 2025-07-27 10:30:34 +08:00
更新 README.md
This commit is contained in:
parent
aabe69aba7
commit
a87e88c326
52
README.md
52
README.md
@ -42,9 +42,10 @@
|
||||
### 常用功能接口
|
||||
所有开放外部接口都集中在
|
||||
com.farsunset.cim.client.android.CIMPushManager
|
||||
```java
|
||||
|
||||
|
||||
## 1.1连接服务器
|
||||
```java
|
||||
/**
|
||||
* 初始化,连接服务端,在程序启动页或者 在Application里调用
|
||||
* @param context
|
||||
@ -53,45 +54,46 @@ com.farsunset.cim.client.android.CIMPushManager
|
||||
*/
|
||||
public static void connect(Context context,String ip,int port)
|
||||
|
||||
示例
|
||||
//示例
|
||||
CIMPushManager.connect(context,"125.12.35.231",28888);
|
||||
|
||||
```
|
||||
```java
|
||||
|
||||
1.2绑定账号到服务端
|
||||
```java
|
||||
/**
|
||||
* 设置一个账号登录到服务端
|
||||
* @param account 用户唯一ID
|
||||
*/
|
||||
public static void bindAccount(Context context,String account)
|
||||
|
||||
示例
|
||||
//示例
|
||||
CIMPushManager.bindAccount(context,"xiyang");
|
||||
|
||||
|
||||
```
|
||||
```java
|
||||
1.3发送一个CIM请求
|
||||
酌情使用此功能,可用http接口替代
|
||||
|
||||
1.3发送一个CIM请求
|
||||
|
||||
酌情使用此功能,可用http接口替代
|
||||
```java
|
||||
/**
|
||||
* 发送一个CIM请求
|
||||
* @param context
|
||||
* @param ip
|
||||
* @param port
|
||||
* @param body 请求体的结构
|
||||
*/
|
||||
public static void sendRequest(Context context,SentBody body)
|
||||
|
||||
示例:获取离线消息
|
||||
//示例:获取离线消息
|
||||
SentBody sent = new SentBody();
|
||||
sent.setKey(CIMConstant.RequestKey.CLIENT_OFFLINE_MESSAGE);
|
||||
sent.put("account", "xiyang");
|
||||
CIMPushManager.sendRequest(context, sent);
|
||||
|
||||
该功能需要服务端实现,详情参考服务端PullOflineMessageHandler.java
|
||||
//该功能需要服务端实现,详情参考服务端PullOflineMessageHandler.java
|
||||
|
||||
```
|
||||
```java
|
||||
|
||||
1.4停止接收消息
|
||||
|
||||
/**
|
||||
@ -99,38 +101,37 @@ public static void sendRequest(Context context,SentBody body)
|
||||
* @param context
|
||||
*/
|
||||
public static void stop(Context context)
|
||||
示例:
|
||||
//示例:
|
||||
CIMPushManager.stop(context);
|
||||
|
||||
```
|
||||
```java
|
||||
1.5恢复接收消息
|
||||
|
||||
```java
|
||||
/**
|
||||
* 重新恢复接收推送,重新连接服务端,并登录当前账号
|
||||
* @param context
|
||||
*/
|
||||
public static void resume(Context context)
|
||||
示例:
|
||||
//示例:
|
||||
CIMPushManager.resume(context);
|
||||
|
||||
```
|
||||
```java
|
||||
|
||||
|
||||
1.6完全销毁连接
|
||||
|
||||
```java
|
||||
/**
|
||||
* 完全销毁CIM,一般用于完全退出程序,调用resume将不能恢复
|
||||
* @param context
|
||||
*/
|
||||
public static void destroy(Context context)
|
||||
示例:
|
||||
//示例:
|
||||
CIMPushManager.destroy(context);
|
||||
|
||||
|
||||
```
|
||||
```java
|
||||
1.7获取是否与服务端连接正常
|
||||
```java
|
||||
|
||||
/**
|
||||
*
|
||||
@ -138,11 +139,12 @@ public static void sendRequest(Context context,SentBody body)
|
||||
*/
|
||||
public boolean isConnected(Context context)
|
||||
|
||||
示例:
|
||||
//示例:
|
||||
CIMPushManager.isConnected(context);
|
||||
```
|
||||
```java
|
||||
|
||||
1.8获取PushManager状态
|
||||
```java
|
||||
//被销毁的destroy()
|
||||
CIMPushManager.STATE_DESTROYED = 0x0000DE;
|
||||
//被销停止的 stop()
|
||||
@ -152,15 +154,16 @@ public static void sendRequest(Context context,SentBody body)
|
||||
|
||||
public int getState(Context context)
|
||||
|
||||
示例:
|
||||
//示例:
|
||||
CIMPushManager.getState(context);
|
||||
```
|
||||
```java
|
||||
|
||||
1.9推送消息以及相关事件的接收
|
||||
|
||||
首先注册一个广播,并监听以下action 参照 后面androidManifest.xml配置
|
||||
|
||||
参考CustomCIMMessageReceiver的实现
|
||||
```java
|
||||
/**
|
||||
* 当收到服务端推送过来的消息时调用
|
||||
* @param message
|
||||
@ -179,7 +182,6 @@ public static void sendRequest(Context context,SentBody body)
|
||||
*/
|
||||
public abstract void onNetworkChanged(NetworkInfo networkinfo);
|
||||
|
||||
|
||||
/**
|
||||
* 当连接服务器成功时回调
|
||||
* @param hasAutoBind : true 已经自动绑定账号到服务器了,不需要再手动调用bindAccount
|
||||
|
Loading…
x
Reference in New Issue
Block a user