gitee/cim
1
0
Fork 0
mirror of https://gitee.com/farsunset/cim.git synced 2025-07-27 10:30:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

更新 README.md

Browse Source
This commit is contained in:
远方夕阳 2017-08-21 11:08:33 +08:00
parent aabe69aba7
commit a87e88c326
1 changed files with 111 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

220
README.md
View File

@ -42,158 +42,160 @@
### 常用功能接口 ### 常用功能接口
所有开放外部接口都集中在 所有开放外部接口都集中在
com.farsunset.cim.client.android.CIMPushManager com.farsunset.cim.client.android.CIMPushManager
```java
## 1.1连接服务器 ## 1.1连接服务器
/** ```java
* 初始化,连接服务端，在程序启动页或者 在Application里调用 /**
* @param context * 初始化,连接服务端，在程序启动页或者 在Application里调用
* @param ip * @param context
* @param port * @param ip
*/ * @param port
public static void connect(Context context,String ip,int port) */
public static void connect(Context context,String ip,int port)
示例 //示例
CIMPushManager.connect(context,"125.12.35.231",28888); CIMPushManager.connect(context,"125.12.35.231",28888);
``` ```
```java
1.2绑定账号到服务端 1.2绑定账号到服务端
/** ```java
* 设置一个账号登录到服务端 /**
* @param account 用户唯一ID * 设置一个账号登录到服务端
*/ * @param account 用户唯一ID
*/
public static void bindAccount(Context context,String account) public static void bindAccount(Context context,String account)
示例 //示例
CIMPushManager.bindAccount(context,"xiyang"); CIMPushManager.bindAccount(context,"xiyang");
``` ```
```java
1.3发送一个CIM请求
酌情使用此功能，可用http接口替代
/** 1.3发送一个CIM请求
* 发送一个CIM请求
* @param context 酌情使用此功能，可用http接口替代
* @param ip ```java
* @param port /**
*/ * 发送一个CIM请求
* @param context
* @param body 请求体的结构
*/
public static void sendRequest(Context context,SentBody body) public static void sendRequest(Context context,SentBody body)
示例：获取离线消息 //示例：获取离线消息
SentBody sent = new SentBody(); SentBody sent = new SentBody();
sent.setKey(CIMConstant.RequestKey.CLIENT_OFFLINE_MESSAGE); sent.setKey(CIMConstant.RequestKey.CLIENT_OFFLINE_MESSAGE);
sent.put("account", "xiyang"); sent.put("account", "xiyang");
CIMPushManager.sendRequest(context, sent); CIMPushManager.sendRequest(context, sent);
该功能需要服务端实现，详情参考服务端PullOflineMessageHandler.java //该功能需要服务端实现，详情参考服务端PullOflineMessageHandler.java
``` ```
```java
1.4停止接收消息 1.4停止接收消息
/** /**
* 停止接受推送，将会退出当前账号登录，端口与服务端的连接 * 停止接受推送，将会退出当前账号登录，端口与服务端的连接
* @param context * @param context
*/ */
public static void stop(Context context) public static void stop(Context context)
示例： //示例：
CIMPushManager.stop(context); CIMPushManager.stop(context);
``` ```
```java ```java
1.5恢复接收消息 1.5恢复接收消息
/**
* 重新恢复接收推送，重新连接服务端，并登录当前账号
* @param context
*/
public static void resume(Context context)
示例：
CIMPushManager.resume(context);
```
```java ```java
/**
* 重新恢复接收推送，重新连接服务端，并登录当前账号
* @param context
*/
public static void resume(Context context)
//示例：
CIMPushManager.resume(context);
```
1.6完全销毁连接 1.6完全销毁连接
```java
/** /**
* 完全销毁CIM，一般用于完全退出程序，调用resume将不能恢复 * 完全销毁CIM，一般用于完全退出程序，调用resume将不能恢复
* @param context * @param context
*/ */
public static void destroy(Context context) public static void destroy(Context context)
示例： //示例：
CIMPushManager.destroy(context); CIMPushManager.destroy(context);
``` ```
```java
1.7获取是否与服务端连接正常 1.7获取是否与服务端连接正常
/**
*
* @param context
*/
public boolean isConnected(Context context)
示例：
CIMPushManager.isConnected(context);
```
```java ```java
/**
*
* @param context
*/
public boolean isConnected(Context context)
//示例：
CIMPushManager.isConnected(context);
```
1.8获取PushManager状态 1.8获取PushManager状态
//被销毁的destroy()
CIMPushManager.STATE_DESTROYED = 0x0000DE;
//被销停止的 stop()
CIMPushManager.STATE_STOPED = 0x0000EE;
CIMPushManager.STATE_NORMAL = 0x000000;
public int getState(Context context)
示例：
CIMPushManager.getState(context);
```
```java ```java
//被销毁的destroy()
CIMPushManager.STATE_DESTROYED = 0x0000DE;
//被销停止的 stop()
CIMPushManager.STATE_STOPED = 0x0000EE;
CIMPushManager.STATE_NORMAL = 0x000000;
public int getState(Context context)
//示例：
CIMPushManager.getState(context);
```
1.9推送消息以及相关事件的接收 1.9推送消息以及相关事件的接收
首先注册一个广播，并监听以下action 参照 后面androidManifest.xml配置 首先注册一个广播，并监听以下action 参照 后面androidManifest.xml配置
参考CustomCIMMessageReceiver的实现 参考CustomCIMMessageReceiver的实现
/** ```java
* 当收到服务端推送过来的消息时调用 /**
* @param message * 当收到服务端推送过来的消息时调用
*/ * @param message
public abstract void onMessageReceived(Message message); */
public abstract void onMessageReceived(Message message);
/** /**
* 当调用CIMPushManager.sendRequest()向服务端发送请求，获得相应时调用 * 当调用CIMPushManager.sendRequest()向服务端发送请求，获得相应时调用
* @param replybody * @param replybody
*/ */
public abstract void onReplyReceived(ReplyBody replybody); public abstract void onReplyReceived(ReplyBody replybody);
/** /**
* 当手机网络发生变化时调用 * 当手机网络发生变化时调用
* @param networkinfo * @param networkinfo
*/ */
public abstract void onNetworkChanged(NetworkInfo networkinfo); public abstract void onNetworkChanged(NetworkInfo networkinfo);
/**
* 当连接服务器成功时回调
* @param hasAutoBind : true 已经自动绑定账号到服务器了，不需要再手动调用bindAccount
*/
public abstract void onConnectionSuccessed(boolean hasAutoBind);
/** /**
* 当连接服务器成功时回调 * 当断开服务器连接的时候回调
* @param hasAutoBind : true 已经自动绑定账号到服务器了，不需要再手动调用bindAccount */
*/ public abstract void onConnectionClosed();
public abstract void onConnectionSuccessed(boolean hasAutoBind);
/** /**
* 当断开服务器连接的时候回调 * 当服务器连接失败的时候回调
*/ *
public abstract void onConnectionClosed(); */
public abstract void onConnectionFailed(Exception e);
/**
* 当服务器连接失败的时候回调
*
*/
public abstract void onConnectionFailed(Exception e);
``` ```