Android SDK 接入指南

Android SDK版本

目前SDK支持Android 2.2或以上版本的手机系统。

将imsdk，imkit加入到android studio工程

将imsdk,imkit模块导入到自己的工程中
将 libasync_tcp.so 放到工程的libs目录下

在app的gradle文件中添加imkit模块的依赖

  compile 'com.android.support:support-v4:21.+'
  compile 'com.android.support:appcompat-v7:21.+'
  compile 'com.google.code.gson:gson:2.3.1'
  compile 'com.squareup.picasso:picasso:2.4.0'
  compile 'com.squareup.retrofit:retrofit:1.7.1'
  compile 'com.netflix.rxjava:rxjava-core:0.17.6'
  compile 'com.netflix.rxjava:rxjava-android:0.17.6'
  compile 'com.squareup.okhttp:okhttp:2.1.0'
  compile 'com.squareup.okhttp:okhttp-urlconnection:2.1.0'
  compile 'org.apache.commons:commons-io:1.3.2'
  compile 'joda-time:joda-time:2.5'

AndroidManifest.xml配置

manifest 标签下添加：

  <!-- 必需： 权限配置 -->
  <uses-permission android:name="android.permission.INTERNET" />
  <uses-permission android:name="android.permission.RECORD_AUDIO"/>

application 标签下添加：

 <!-- 必需： 应用ID(此处的id为您申请的应用id) -->
 <meta-data
     android:name="GOBELIEVE_APPID"
     android:value="7" />

 <!-- 必需： 应用KEY (此处appkey为您申请的应用密钥)-->
 <meta-data
     android:name="GOBELIEVE_APPKEY"
     android:value="HS5NVruwDJxFwUPEdzqo7gBrQCSFsIhA" />

 <activity
     android:name="com.beetle.bauhinia.PeerMessageActivity"
     android:exported="true"
     android:windowSoftInputMode="adjustResize|stateHidden"
     android:theme="@style/imkit.NoActionBar">
     <intent-filter>
         <action android:name="android.intent.action.VIEW" />
     </intent-filter>
 </activity>

 <activity
     android:name="com.beetle.bauhinia.activity.PhotoActivity"
     android:label="照片"
     android:theme="@style/imkit.ActionBar">
 </activity>

 <activity
     android:name="com.beetle.bauhinia.MapActivity"
     android:label="位置"
     android:theme="@style/imkit.ActionBar">
 </activity>
 <activity
     android:name="com.beetle.bauhinia.LocationPickerActivity"
     android:label="位置"
     android:theme="@style/imkit.ActionBar">
 </activity>

 <activity
     android:name="com.beetle.bauhinia.WebActivity"
     android:label=""
     android:theme="@style/imkit.ActionBar">
 </activity>

IMSDK

imsdk只包含消息基础通讯功能

配置服务地址

配置服务器地址是可选步骤,而且必须在Application对象的onCreate里面配置，否则配置无效

  //app可以单独部署服务器，给予第三方应用更多的灵活性
  IMService.getInstance().setHost("imnode.gobelieve.io");
  IMHttpAPI.setAPIURL("api.gobelieve.io");

初始化IM

在开始IM服务之前需要设置用户accessToken以及添加IMServiceObserver监听状态回调.

  mIMService = IMService.getInstance();
  String androidID = Settings.Secure.getString(getContentResolver(),
      Settings.Secure.ANDROID_ID);

  //设置设备唯一标识,用于多点登录时设备校验
  mIMService.setDeviceID(androidID);
  //监听网络状态变化
  Context context = getApplicationContext();
  mIMService.registerConnectivityChangeReceiver(context);

用户登录成功后启动IM，设置用户的accesstoken并启动im

     IMHttpAPI.setToken(token);
     mIMService.setAccessToken(accessToken);
     mIMService.setUID(uid);
     mIMService.start();

绑定当前用户的devicetoken用于离线消息推送,当前支持的第三方推送有:google推送,小米推送，华为推送，信鸽推送

     IMHttpAPI.Singleton().bindDeviceToken(deviceToken);

用户注销后清空用户的devicetoken并停止IM

     IMHttpAPI.Singleton().unbindDeviceToken(deviceToken);
     mIMService.setAccessToken("");
     mIMService.stop();

应用切到后台暂停IM,此后所有的消息将通过推送通道下发

     mIMService.enterBackground()

应用切到前台恢复IM

     mIMService.enterForeground()

发送消息

启动IM服务设置好用户id之后便可以开始发送消息,消息发送的代码需要在UI线程中调用(消息内容大小限制为4k) :

    //建立消息对象
   IMMessage msg = new IMMessage();
   //设置发送方id
   msg.sender = senderId;
   //设置接收方id
   msg.receiver = receiverId;
   //消息本地id
   msg.msgLocalID = msgLocalId;
   //设置消息内容
   msg.content = "早上好";
   IMService.sendPeerMessage(msg);

类IMService

设置当前用户的access token

方法名：public void setAccessToken(String token)
功能：在调用start之前必须要设置用户的accessToken，token是由第三方应用服务器调用IM服务器RestAPI所得。
参数说明： 
    * token  客户端连接IM服务必须的acessToken
返回值：无返回值

设置当前用户id

方法名：public void setUID(long uid)
参数说明： 
    * uid  当前用户id
返回值：无返回值

设置当前设备id

方法名：public void setDeviceID(String deviceID)
功能：设备id可以用户多点登陆的唯一性判断,可选调用
参数说明：
    *deviceID 设备id
返回值：无返回值

监控网络变化

方法名: public void registerConnectivityChangeReceiver(Context context)
功能: 可以及时的根据网络变化情况，断开，建立socket链接。

设置观察者

方法名: public void addObserver(IMServiceObserver observer)
功能：设置observer，在observer中处理接受到的消息。
参数说明： 
    * observer 观察者
返回值：无返回值

开始接受消息

方法名：public void start()
功能：用户登陆成功后，连接im服务器来接受在线消息。

停止接受消息

方法名：public void stop()
功能：用户注销后，断开和im服务器的连接，从而终止接受在线消息。

应用进入到前台

方法名：public void enterForeground()
功能：应用进入前台，im服务器将停止将消息推送到通知栏

应用进入到后台

方法名：public void enterBackground()
功能：应用进入后台，im服务器会将将消息推送到通知栏

发送消息

方法名:public boolean sendPeerMessage(IMMessage msg)
功能：发送im消息，如果当前连接处于断开状态，消息会发送失败, 函数返回true，也不能表明服务器已经接收到消息。
参数说明：
    *msg 消息对象
返回值:boolean

发送群组消息

方法名:public boolean sendGroupMessage(IMMessage msg)
功能：发送im消息，如果当前连接处于断开状态，消息会发送失败, 函数返回true，也不能表明服务器已经接收到消息。
参数说明：
    *msg 消息对象
返回值:boolean

接口IMServiceObserver

连接状态

方法名:public void onConnectState(IMService.ConnectState state)
功能:连接状态变更通知
参数说明:
    *state 连接的状态 STATE_UNCONNECTED, STATE_CONNECTING, STATE_CONNECTED, STATE_CONNECTFAIL
返回值:无返回值

消息

方法名:public void onPeerMessage(IMMessage msg)
功能：接受到一条im消息
参数说明：
    *msg 消息对象
返回值:无返回值

消息ACK

方法名:public void onPeerMessageACK(int msgLocalID, long uid)
功能:服务器对收到消息的ack,此时这条消息才能标志为发送成功
参数说明:
    *msgLocalID 消息的本地ID
    *uid 消息接受者
返回值:无返回值

消息接受者ACK

方法名:public void onPeerMessageRemoteACK(int msgLocalID, long uid)
功能:消息已经被对端接收到。
参数说明:
    *msgLocalID 消息的本地ID
    *uid 消息接受者
返回值:无返回值

消息发送失败

方法名:public void onPeerMessageFailure(int msgLocalID, long uid)
功能：消息发出后，未收到服务器的ack，在和服务器的连接断开后，会通知消息发送失败。
参数说明:
    *msgLocalID 消息的本地ID
    *uid 消息接受者
返回值:无返回值

类IMApi

设置当前用户的device token

方法名:public boolean bindDeviceToken(PostDeviceToken token)
功能:设置device token后，im服务器会对用户推送离线消息，device token来自于push系统生成。
参数说明:
    *deviceToken 推送的deviceToken
返回值:boolean 是否设置成功。

清空当前用户关联的device token

方法名:public boolean unbindDeviceToken(PostDeviceToken token)
功能:im服务器不会再对这台设备推送离线消息
参数说明:
    *deviceToken 推送的deviceToken
返回值:boolean 是否清空成功。

IMKit

imkit包含了完整的聊天界面和历史消息的存储

初始化IMKit

除了imsdk必要的初始化动作外，使用imkit需要初始化存储类

  //设置的路径名中可以包含用户id，这样就可以同时保存多个用户的聊天历史
  //否则用户注销后，必须要清空目录
  FileCache fc = FileCache.getInstance();
  fc.setDir(this.getDir("cache", MODE_PRIVATE));

  PeerMessageDB db = PeerMessageDB.getInstance();
  db.setDir(this.getDir("peer", MODE_PRIVATE));
  GroupMessageDB db = GroupMessageDB.getInstance();
  db.setDir(this.getDir("group", MODE_PRIVATE));

  mIMService.setPeerMessageHandler(PeerMessageHandler.getInstance());
  mIMService.setGroupMessageHandler(GroupMessageHandler.getInstance());

打开聊天界面

    Intent intent = new Intent(this, IMActivity.class);
    intent.putExtra("peer_uid", peerUID);
    intent.putExtra("peer_name", peerName);
    intent.putExtra("current_uid", currentUID
    startActivity(intent);

Android SDK 接入指南

Android SDK版本

将imsdk，imkit加入到android studio工程

AndroidManifest.xml配置

IMSDK

配置服务地址

初始化IM

用户登录成功后启动IM，设置用户的accesstoken并启动im

绑定当前用户的devicetoken用于离线消息推送,当前支持的第三方推送有:google推送,小米推送， 华为推送，信鸽推送

用户注销后清空用户的devicetoken并停止IM

应用切到后台暂停IM,此后所有的消息将通过推送通道下发

应用切到前台恢复IM

发送消息

类IMService

设置当前用户的access token

设置当前用户id

设置当前设备id

监控网络变化

设置观察者

开始接受消息

停止接受消息

应用进入到前台

应用进入到后台

发送消息

发送群组消息

接口IMServiceObserver

连接状态

消息

消息ACK

消息接受者ACK

消息发送失败

类IMApi

设置当前用户的device token

清空当前用户关联的device token

IMKit

初始化IMKit

打开聊天界面

绑定当前用户的devicetoken用于离线消息推送,当前支持的第三方推送有:google推送,小米推送，华为推送，信鸽推送