环信聊天

最新推荐文章于 2020-06-02 14:43:58 发布
原创最新推荐文章于 2020-06-02 14:43:58 发布 · 716 阅读
0 ·
CC 4.0 BY-SA版权
其他专栏收录该内容
13 篇文章
订阅专栏
compile 'com.hyphenate:kefu-easeui-android:latest.release'
ndk {
    //选择要添加的对应cpu类型的.so库
    abiFilters 'armeabi', 'arm64-v8a'
    //还可以添加 'armeabi-v7a', 'x86'
}
初始化
 
  移动客服Android SDK包含EaseUI，需要在Application中调用初始化的方法（本示例中Application的文件名为MyApplication.java）：
  
    
      使用ChatClient方法对SDK进行初始化
    

    
      使用UIProvider方法对EaseUI进行初始化
    
  ChatClient的其他方法也都需要在它后面调用。例如：本文档中的DebugMode（日志），以及Demo中的自定义通知栏、消息通知等。
  public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        ChatClient.Options options = new ChatClient.Options();
        options.setAppkey("Your appkey");//必填项，appkey获取地址：kefu.easemob.com，“管理员模式 > 渠道管理 > 手机APP”页面的关联的“AppKey”
        options.setTenantId("Your tenantId");//必填项，tenantId获取地址：kefu.easemob.com，“管理员模式 > 设置 > 企业信息”页面的“租户ID”
        
        // Kefu SDK 初始化
        if (!ChatClient.getInstance().init(this, options)){
            return;
        }
        // Kefu EaseUI的初始化
        UIProvider.getInstance().init(this);
        //后面可以设置其他属性
    }
}

  //Kefu sdk 初始化简写方式：
  ChatClient.getInstance().init(this, new ChatClient.Options().setAppkey("zdxd#ksf").setTenantId("35"));

  自定义的Application需要在Androidmanifest.xml中注册。
  <application
        ...
        android:name=".MyApplication"
        ...
</application>

 
注册
 
  注册模式分两种，开放注册和授权注册。只有开放注册时，才可以客户端注册。
  
    
      开放注册是为了测试使用，正式环境中不推荐使用该方式注册环信账号；
    

    
      授权注册的流程应该是您服务器通过环信提供的 REST 
     API 注册，之后保存到您的服务器或返回给客户端。
    
  建议使用授权模式，即在服务端注册，而不要放到APP中，可以在登录自己APP时从返回的结果中获取环信账号再登录环信服务器。
  ChatClient.getInstance().createAccount("username", "password", new Callback(){});

//ErrorCode:
Error.NETWORK_ERROR 网络不可用
Error.USER_ALREADY_EXIST  用户已存在
Error.USER_AUTHENTICATION_FAILED 无开放注册权限（后台管理界面设置[开放|授权]）
Error.USER_ILLEGAL_ARGUMENT 用户名非法

 
登录
 
  用户需要登录后才能进入会话界面，与客服聊天。
  ChatClient.getInstance().login("username", "password", new Callback(){});

 
登录状态
 
  需要先判断登录状态再进入会话界面，否则会出问题。
  if(ChatClient.getInstance().isLoggedInBefore()){
    //已经登录，可以直接进入会话界面
}else{
    //未登录，需要登录后，再进入会话界面
}

 
退出
 
  登出后则无法收到客服发来的消息。
  //第一个参数为是否解绑推送的devicetoken
ChatClient.getInstance().logout(true, new Callback(){});

 
日志
 
  设置调试模式。
  // 设置为true后，将打印日志到logcat, 发布APP时应关闭该选项
ChatClient.getInstance().setDebugMode(true|false);

 
会话
 
  新建“联系客服”按钮，并调用以下方法打开会话界面。
  注意：该方法中设置的“IM服务号”需要与初始化时设置的appkey对应。
  Intent intent = new IntentBuilder({Activity}.this)
                        .setServiceIMNumber("客服关联的IM服务号") //获取地址：kefu.easemob.com，“管理员模式 > 渠道管理 > 手机APP”页面的关联的“IM服务号”
                        .build();
                startActivity(intent);

  界面引用了环信IM的EaseUI，您可以对界面进行修改，使用指南见EaseUI 使用指南。
 
网络监听
 
  添加网络监听，可以显示当前是否连接服务器。
  ChatClient.getInstance().addConnectionListener(new ChatClient.ConnectionListener() {
            @Override
            public void onConnected() {
                   //成功连接到服务器
            }

            @Override
            public void onDisconnected(int errorcode) {
               //errorcode的值
               //Error.USER_REMOVED 账号移除
               //Error.USER_LOGIN_ANOTHER_DEVICE 账号在其他地方登录
               //Error.USER_AUTHENTICATION_FAILED 账号密码错误
               //Error.USER_NOT_FOUND  账号找不到

            }
        });

 
消息监听
 
  添加消息监听。
  ChatClient.getInstance().getChat().addMessageListener(new ChatManager.MessageListener() {
            @Override
            public void onMessage(List<Message> list) {
                //收到普通消息
            }

            @Override
            public void onCmdMessage(List<Message> list) {
                 //收到命令消息，命令消息不存数据库，一般用来作为系统通知，例如留言评论更新，
                 //会话被客服接入，被转接，被关闭提醒
            }

            @Override
            public void onMessageStatusUpdate() {
            //消息的状态修改，一般可以用来刷新列表，显示最新的状态

            }

            @Override
            public void onMessageSent() {
            //发送消息后，会调用，可以在此刷新列表，显示最新的消息

            }
        });