事件处理

概述

当sdk收到某些后台下发的数据，或者发生了某些需要上层关注的事件时，sdk会上抛事件对象通知给上层，例如，在线消息事件、会话刷新事件、用户下线事件等。
应用上层需要根据实际情况决定是否需要接收并且处理事件。

事件接收类的注册

应用层可以在任意类中注册事件接收，sdk会持有这个类的强引用，上层需要注意在合适的地方解绑事件接收。
如果要实现全局事件监听，或者在应用的整个生命周期内都需要监听事件的话，建议放在application类里，不要放在类似activity、或者fragmemt、service之类的组件中。

JMessageClient.registerEventReceiver(Object receiver);
JMessageClient.registerEventReceiver(Object receiver, int priority);

参数说明

• Object receiver 消息接收类对象
• int priority 定义事件接收者接收事件的优先级，默认值为0，优先级越高将越先接收到事件。（优先级只对同一个线程模式中的接收者有效）

事件接收类的解绑

JMessageClient.unRegisterEventReceiver(Object receiver);

参数说明

• Object receiver 消息接收类对象，对象解绑之后将不再接收到任何event。

事件接收

注册事件接收类之后，需要在消息接收类中实现如下方法来接收对应消息。sdk将根据实现方法的方法名来区分不同的线程模式，常用的线程模式有onEvent(默认线程模式)和onEventMainThread(主线程模式)两种。

可以通过定义不同类型的参数，来接收不同种类的事件。具体事件类型定义见 “事件类型” 一节

子线程模式（默认线程）

public void onEvent(EventEntity event){
  //do your own business
}

方法体将在子线程中被调用， 可以用来处理耗时操作。

参数定义

• EventEntity event 事件对象。（ 指代下文的具体事件类型实体类型，具体用法可以参考“示例代码“。）

主线程模式

public void onEventMainThread(EventEntity event){
  //do your own business
}

方法体将在主线程中被调用，可以用来刷新UI。 参数定义

• EventEntity event 事件对象。EventEntity指代的是下文的具体事件类型

用户事件

当前登录用户信息被更新事件实体类 MyInfoUpdatedEvent

用户下线事件UserLogoutEvent
(已过时，请使用LoginStateChangeEvent代替)

用户被删除事件UserDeletedEvent
(已过时，请使用LoginStateChangeEvent代替)

用户登录状态变更事件LoginStateChangeEvent

消息/会话事件

在线消息事件实体类 MessageEvent

离线消息事件实体类 OfflineMessageEvent
Since 2.1.0

会话刷新事件实体类 ConversationRefreshEvent

消息被对方撤回通知事件MessageRetractEvent
Since 2.2.0

消息未回执人数变更事件MessageReceiptStatusChangeEvent
Since 2.3.0

群组事件

群成员变化相关事件
群组成员变化相关事件因为sdk需要入库，所以sdk会将相关事件以消息事件的方式上抛，用户可以将群组中产生的成员变化事件理解成一条特殊的消息，其消息类型为eventNotification，例如：

  //用户在线期间，如果群组中发生了成员变化事件，sdk也会通过上抛MessageEvent的方式来通知上层
  public void onEvent(MessageEvent event) {
    Message msg = event.getMessage();
    //获取消息类型，如text voice image eventNotification等。
    switch (msg.getContentType()) {
      //处理事件提醒消息，此处message的contentType类型为eventNotification。
      case eventNotification:
        //获取事件发生的群的群信息
        GroupInfo groupInfo = (GroupInfo) msg.getTargetInfo();
        //获取事件具体的内容对象
        EventNotificationContent eventNotificationContent = (EventNotificationContent)msg.getContent();
        //获取事件具体类型
        switch (eventNotificationContent.getEventNotificationType()){ 
          case group_member_added:
          //群成员加群事件
          break;
          case group_member_removed:
          //群成员被踢事件
          break;
          case group_member_exit:
          //群成员退群事件
          break;
          case group_info_updated://since 2.2.1
          //群信息变更事件
          break;
          ...
        }
        break;
    }
  }
  //用户离线期间，如果群组中发生了成员变化事件，sdk也会通过上抛OfflineMessageEvent
  //的方式来通知上层，处理方式类似上面的MessageEvent
  public void onEvent(OfflineMessageEvent event) {
    List<Message> msgs = event.getOfflineMessageList();
    for (Message msg:msgs) {
       //...
    }
  }

群成员审批事件GroupApprovalEvent
Since 2.4.0

群成员审批拒绝事件GroupApprovalRefuseEvent
Since 2.4.0

已审批事件通知GroupApprovedNotificationEvent
Since 2.5.0

群成员昵称修改事件GroupMemNicknameChangedEvent
Since 2.7.0

群公告变更事件GroupAnnouncementChangedEvent
Since 2.8.0

群黑名单变更事件GroupBlackListChangedEvent
Since 2.8.0

聊天室事件

聊天室消息事件ChatRoomMessageEvent
Since 2.4.0 聊天室消息因为sdk不会入库，所以没有走正常的消息事件，而是单独的聊天室消息事件。注意和消息事件做区分

聊天室通知事件ChatRoomNotificationEvent
Since 2.8.0

好友事件

好友相关事件通知实体类ContactNotifyEvent
Since 1.4.0

命令透传事件

命令透传事件实体类CommandNotificationEvent
Since 2.3.0

通知栏点击事件

通知栏点击事件实体类NotificationClickEvent

示例代码

接收消息事件

class MessageEventReceiver extends Activity {
  @Override
  protected void onCreate() {
    super.onCreate(savedInstanceState);
    //这里只是为了展示注册事件接受者接口的用法，实际上开发者可以在任意类中注册事件接收者
    //，而不仅仅在Activity中。 下同
    JMessageClient.registerEventReceiver(this);
  }
  @Override
  protected void onDestroy() {
    JMessageClient.unRegisterEventReceiver(this);
    super.onDestroy();
  }
  //用户在线期间收到的消息都会以MessageEvent的方式上抛
  public void onEvent(MessageEvent event) {
    Message msg = event.getMessage();
    switch (msg.getContentType()) {
      case text:
        //处理文字消息
        TextContent textContent = (TextContent) msg.getContent();
        textContent.getText();
        break;
      case image:
        //处理图片消息
        ImageContent imageContent = (ImageContent) msg.getContent();
        imageContent.getLocalPath();//图片本地地址
        imageContent.getLocalThumbnailPath();//图片对应缩略图的本地地址
         break;
      case voice:
        //处理语音消息
        VoiceContent voiceContent = (VoiceContent) msg.getContent();
        voiceContent.getLocalPath();//语音文件本地地址
        voiceContent.getDuration();//语音文件时长
        break;
      case custom:
        //处理自定义消息
        CustomContent customContent = (CustomContent) msg.getContent();
        customContent.getNumberValue("custom_num"); //获取自定义的值
        customContent.getBooleanValue("custom_boolean");
        customContent.getStringValue("custom_string");
        break;
      case eventNotification:
        //处理事件提醒消息
        EventNotificationContent eventNotificationContent = (EventNotificationContent)msg.getContent();
        switch (eventNotificationContent.getEventNotificationType()){
          case group_member_added:
          //群成员加群事件
          break;
          case group_member_removed:
          //群成员被踢事件
          break;
          case group_member_exit:
          //群成员退群事件
          break;
          case group_info_updated://since 2.2.1
          //群信息变更事件
          break;
        }
        break;
      case unknown:
        // 处理未知消息，未知消息的Content为PromptContent 默认提示文本为“当前版本不支持此类型消息，请更新sdk版本”，上层可选择不处理
        PromptContent promptContent = (PromptContent) msg.getContent();
        promptContent.getPromptType();//未知消息的type是unknown_msg_type
        promptContent.getPromptText();//提示文本，“当前版本不支持此类型消息，请更新sdk版本”
        break;
    }
  }
  //用户离线期间收到的消息会以OfflineMessageEvent的方式上抛，处理方式类似上面的
  //MessageEvent
  public void onEvent(OfflineMessageEvent event) {
    List<Message> msgs = event.getOfflineMessageList();
    for (Message msg:msgs) {
       //...
    }
  }
}

接收通知栏点击事件

class NotificationClickEvent extends Activity{
    @Override
    protected void onCreate() {
        super.onCreate(savedInstanceState);
        JMessageClient.registerEventReceiver(this);
    }
    @Override
    protected void onDestroy() {
        JMessageClient.unRegisterEventReceiver(this);
        super.onDestroy();
    }
    public void onEvent(NotificationClickEvent event){
        Intent notificationIntent = new Intent(mContext, ChatActivity.class);
        mContext.startActivity(notificationIntent);//自定义跳转到指定页面
    }
}

用户登录状态变更事件

class UserLogoutEventReceiver extends Activity{
    @Override
    protected void onCreate() {
        super.onCreate(savedInstanceState);
        JMessageClient.registerEventReceiver(this);
    }
    @Override
    protected void onDestroy() {
        JMessageClient.unRegisterEventReceiver(this);
        super.onDestroy();``
    }
    public void onEvent(LoginStateChangeEvent event){
        LoginStateChangeEvent.Reason reason = event.getReason();//获取变更的原因
        UserInfo myInfo = event.getMyInfo();//获取当前被登出账号的信息
        switch (reason) {
            case user_password_change:
                //用户密码在服务器端被修改
                break;
            case user_logout:
                //用户换设备登录
                break;
            case user_deleted:
                //用户被删除
                break;
        }
     }
}