EVENT

接入侧需要监听处理的事件列表，详细如下：

Members

(static) SDK_READY

SDK 进入 ready 状态时触发，接入侧监听此事件，然后可调用 SDK 发送消息等 API，使用 SDK 的各项功能

注意：login 成功才会驱动 SDK 触发 SDK_READY 事件

Example
let onSdkReady = function(event) {
  let message = tim.createTextMessage({ to: 'user1', conversationType: 'C2C', payload: { text: 'Hello world!' }});
  tim.sendMessage(message);
};
tim.on(TIM.EVENT.SDK_READY, onSdkReady);

(static) SDK_NOT_READY

SDK 进入 not ready 状态时触发，此时接入侧将无法使用 SDK 发送消息等功能。
如果想恢复使用，接入侧需调用 login 接口，驱动 SDK 进入 ready 状态

注意：同一帐号多端互踢场景下，避免在 SDK_NOT_READY 中调用 login 接口，可能会造成循环互踢的情况。

Example
let onSdkNotReady = function(event) {
  // 如果想使用发送消息等功能，接入侧需驱动 SDK 进入 ready 状态，重新调用 login 接口即可，如下所示：
  // tim.login({userID: 'your userID', userSig: 'your userSig'});
};
tim.on(TIM.EVENT.SDK_NOT_READY, onSdkNotReady);

(static) MESSAGE_RECEIVED

SDK 收到推送的单聊、群聊、群提示、群系统通知的新消息，接入侧可通过遍历 event.data 获取消息列表数据并渲染到页面

Example
let onMessageReceived = function(event) {
  // event.data - 存储 Message 对象的数组 - [Message]
};
tim.on(TIM.EVENT.MESSAGE_RECEIVED, onMessageReceived);

(static) MESSAGE_MODIFIED

SDK 收到消息被修改的通知，消息发送方可通过遍历 event.data 获取消息列表数据并更新页面上同 ID 消息的内容。
使用举例：
1、单聊用户或群成员发送了一个【Hello World】的消息并上屏，然后 SDK 收到了此消息被第三方回调修改的通知（例如被修改成了【Hello China】，对端或者其他群成员收到的是【Hello China】），此时 SDK 会触发此事件。
2、接入侧在事件回调里，遍历被修改的消息，替换页面上同 ID 消息的内容，将【Hello World】替换为【Hello China】，并重新渲染和展示。

注意：使用前需要将 SDK 版本升级至v2.12.1或以上。

Example
let onMessageModified = function(event) {
  // event.data - 存储被修改过的 Message 对象的数组 - [Message]
};
tim.on(TIM.EVENT.MESSAGE_MODIFIED, onMessageModified);

(static) MESSAGE_REVOKED

SDK 收到消息被撤回的通知，可通过遍历 event.data 获取被撤回的消息列表数据并渲染到页面，如单聊会话内可展示为 "对方撤回了一条消息"；群聊会话内可展示为 "XXX撤回了一条消息"。

注意：使用前需要将SDK版本升级至v2.4.0或以上。

Example
let onMessageRevoked = function(event) {
  // event.data - 存储 Message 对象的数组 - [Message] - 每个 Message 对象的 isRevoked 属性值为 true
};
tim.on(TIM.EVENT.MESSAGE_REVOKED, onMessageRevoked);

(static) MESSAGE_READ_BY_PEER

SDK 收到对端已读消息的通知，消息接收方调用 setMessageRead 已读上报成功后消息发送方会收到此事件。可通过遍历 event.data 获取对端已读的消息列表数据并渲染到页面，如单聊会话内可将自己发送的消息由“未读”状态改为“已读”。

注意：使用前需要将SDK版本升级至v2.7.0或以上。仅支持单聊会话。

Example
let onMessageReadByPeer = function(event) {
  // event.data - 存储 Message 对象的数组 - [Message] - 每个 Message 对象的 isPeerRead 属性值为 true
};
tim.on(TIM.EVENT.MESSAGE_READ_BY_PEER, onMessageReadByPeer);

(static) MESSAGE_READ_RECEIPT_RECEIVED

SDK 收到了消息的已读回执通知，消息接收方调用 sendMessageReadReceipt 时消息发送方会收到此事件。

注意1：使用群消息已读回执功能前需要将SDK版本升级至v2.18.0或以上。
注意2：使用 C2C 消息已读回执功能前需要将SDK版本升级至v2.20.0或以上。
注意3：v2.25.0起 readReceiptInfo 支持 C2C 消息已读回执信息 isPeerRead。

Example
let onMessageReadReceiptReceived = function(event) {
  // event.data - 存储消息已读回执信息的数组
  const readReceiptInfoList = event.data;
  readReceiptInfoList.forEach((item) => {
    const { groupID, userID, messageID, readCount, unreadCount, isPeerRead } = item;
    // messageID - 消息 ID
    // userID - C2C 消息接收方
    // isPeerRead - C2C 消息对端是否已读
    // groupID - 群组 ID
    // readCount - 群消息已读人数
    // unreadCount - 群消息未读人数
    const message = tim.findMessage(messageID);
    if (message) {
     if (message.conversationType === TIM.TYPES.CONV_C2C) {
       if (message.readReceiptInfo.isPeerRead === true) {
         // 对端已读
       }
     } else if (message.conversationType === TIM.TYPES.CONV_GROUP) {
      if (message.readReceiptInfo.unreadCount === 0) {
        // 全部已读
      } else {
        // message.readReceiptInfo.readCount - 消息最新的已读数
        // 如果想要查询哪些群成员已读了此消息，请使用 [getGroupMessageReadMemberList] 接口
      }
     }
    }
  });
}
tim.on(TIM.EVENT.MESSAGE_READ_RECEIPT_RECEIVED, onMessageReadReceiptReceived);

(static) MESSAGE_EXTENSIONS_UPDATED

SDK 收到消息扩展更新通知，调用 setMessageExtensions 设置成功后，自己和对端用户（C2C）或群组成员（Group）都会收到此事件。

注意1：使用前需要将SDK版本升级至v2.25.0或以上。
注意2：v2.27.0 起社群和话题支持消息扩展。

Example
let onMessageExtensionsUpdated = function(event) {
  const { messageID, extensions } = event.data;
  // messageID - 消息 ID
  // extensions - 消息扩展信息
  extensions.forEach((item) => {
   const { key, value } = item;
   // key - 消息扩展 key
   // value - 消息扩展 key 对应的 value 值
  });
};
tim.on(TIM.EVENT.MESSAGE_EXTENSIONS_UPDATED, onMessageExtensionsUpdated);

(static) MESSAGE_EXTENSIONS_DELETED

SDK 收到消息扩展删除通知，调用 deleteMessageExtensions 删除成功后，自己和对端用户（C2C）或群组成员（Group）都会收到此事件。

注意1：使用前需要将SDK版本升级至v2.25.0或以上。
注意2：v2.27.0 起社群和话题支持消息扩展。

Example
let onMessageExtensionsDeleted = function(event) {
  const { messageID, keyList } = event.data;
  // messageID - 消息 ID
  // keyList - 被删除的消息扩展 key 列表
  keyList.forEach((key) => {
   // console.log(key)
  });
};
tim.on(TIM.EVENT.MESSAGE_EXTENSIONS_DELETED, onMessageExtensionsDeleted);

(static) CONVERSATION_LIST_UPDATED

会话列表更新，event.data 是包含 Conversation 对象的数组

Example
let onConversationListUpdated = function(event) {
  console.log(event.data); // 包含 Conversation 实例的数组
};
tim.on(TIM.EVENT.CONVERSATION_LIST_UPDATED, onConversationListUpdated);

(static) TOTAL_UNREAD_MESSAGE_COUNT_UPDATED

会话未读总数更新，event.data 是当前单聊和群聊会话的未读总数

注意1：使用前需要将SDK版本升级至v2.23.0或以上。
注意2：未读总数会减去设置为免打扰的会话的未读数。
注意3：未读总数不计算系统会话的未读数。

Example
let onTotalUnreadMessageCountUpdated = function(event) {
  console.log(event.data); // 当前单聊和群聊会话的未读总数
};
tim.on(TIM.EVENT.TOTAL_UNREAD_MESSAGE_COUNT_UPDATED, onTotalUnreadMessageCountUpdated);

(static) CONVERSATION_GROUP_LIST_UPDATED

会话分组更新时触发（如创建会话分组、删除会话分组、重命名会话分组）。

注意：使用前需要将SDK版本升级至v2.22.0或以上。

Example
let onConversationGroupListUpdated = function(event) {
  console.log(event.data); // 全量的会话分组名列表
}
tim.on(TIM.EVENT.CONVERSATION_GROUP_LIST_UPDATED, onConversationGroupListUpdated);

(static) CONVERSATION_IN_GROUP_UPDATED

会话分组内的会话更新时触发（如添加会话到分组，或者从分组内删除会话）。

注意：使用前需要将SDK版本升级至v2.22.0或以上。

Example
let onConversationInGroupUpdated = function(event) {
  const { groupName, conversationList }  = event.data;
  // groupName - 会话分组名
  // conversationList - 分组内的会话列表
}
tim.on(TIM.EVENT.CONVERSATION_IN_GROUP_UPDATED, onConversationInGroupUpdated);

(static) GROUP_LIST_UPDATED

SDK 群组列表更新时触发，可通过遍历 event.data 获取群组列表数据并渲染到页面

Example
let onGroupListUpdated = function(event) {
   console.log(event.data);// 包含 Group 实例的数组
};
tim.on(TIM.EVENT.GROUP_LIST_UPDATED, onGroupListUpdated);

(static) GROUP_ATTRIBUTES_UPDATED

群属性更新时触发，可通过 event.data 获取到更新后的群属性数据

注意1：v2.14.0 起只支持直播群（AVChatroom）。
注意2：v2.25.0 起同时支持 AVChatRoom、Public、Meeting、Work、Community 五种群类型。
注意3：话题不支持群属性。

Example
let onGroupAttributesUpdated = function(event) {
   const groupID = event.data.groupID // 群组ID
   const groupAttributes = event.data.groupAttributes // 更新后的群属性
   console.log(event.data);
};
tim.on(TIM.EVENT.GROUP_ATTRIBUTES_UPDATED, onGroupAttributesUpdated);

(static) GROUP_COUNTER_UPDATED

SDK 收到群计数器更新通知，自己和其他群组成员都会收到此事件。

注意1：使用前需要将SDK版本升级至v2.26.0或以上。
注意2：您调用以下接口操作成功后均会触发该事件：

Example
let onGroupCounterUpdated = function(event) {
  const { groupID, key, value } = event.data;
  // groupID - 群组 ID
  // key - 群计数器 key
  // value - 群计数器 key 对应的 value
};
tim.on(TIM.EVENT.GROUP_COUNTER_UPDATED, onGroupCounterUpdated);

(static) TOPIC_CREATED

v2.19.1 起支持，创建话题时触发。

Example
let onTopicCreated = function(event) {
   const groupID = event.data.groupID // 话题所属社群 ID
   const topicID = event.data.topicID // 话题 ID
   console.log(event.data);
};
tim.on(TIM.EVENT.TOPIC_CREATED, onTopicCreated);

(static) TOPIC_DELETED

v2.19.1 起支持，删除话题时触发。

Example
let onTopicDeleted = function(event) {
   const groupID = event.data.groupID // 话题所属社群 ID
   const topicIDList = event.data.topicIDList // 删除的话题 ID 列表
   console.log(event.data);
};
tim.on(TIM.EVENT.TOPIC_DELETED, onTopicDeleted);

(static) TOPIC_UPDATED

v2.19.1 起支持，话题资料更新时触发。

Example
let onTopicUpdated = function(event) {
   const groupID = event.data.groupID // 话题所属社群 ID
   const topic = event.data.topic // 话题资料
   console.log(event.data);
};
tim.on(TIM.EVENT.TOPIC_UPDATED, onTopicUpdated);

(static) PROFILE_UPDATED

自己或好友的资料发生变更时触发，event.data 是包含 Profile 对象的数组

Example
let onProfileUpdated = function(event) {
  console.log(event.data); // 包含 Profile 对象的数组
};
tim.on(TIM.EVENT.PROFILE_UPDATED, onProfileUpdated);

(static) USER_STATUS_UPDATED

v2.21.0 起支持，已订阅用户或好友的状态变更（在线状态或自定义状态）时触发。

Example
let onUserStatusUpdated = function(event) {
   console.log(event.data);
   const userStatusList = event.data;
   userStatusList.forEach((item) => {
     const { userID, statusType, customStatus } = item;
     // userID - 用户 ID
     // statusType - 用户状态，枚举值及说明如下：
     // TIM.TYPES.USER_STATUS_UNKNOWN - 未知
     // TIM.TYPES.USER_STATUS_ONLINE - 在线
     // TIM.TYPES.USER_STATUS_OFFLINE - 离线
     // TIM.TYPES.USER_STATUS_UNLOGINED - 未登录
     // customStatus - 用户自定义状态
   })
};
tim.on(TIM.EVENT.USER_STATUS_UPDATED, onUserStatusUpdated);

(static) BLACKLIST_UPDATED

SDK 黑名单列表更新时触发

Example
let onBlacklistUpdated = function(event) {
  console.log(event.data); // 我的黑名单列表，结构为包含用户 userID 的数组
};
tim.on(TIM.EVENT.BLACKLIST_UPDATED, onBlacklistUpdated);

(static) FRIEND_LIST_UPDATED

好友列表更新时触发

Example
let onFriendListUpdated = function(event) {
  console.log(event.data);
}
tim.on(TIM.EVENT.FRIEND_LIST_UPDATED, onFriendListUpdated);

(static) FRIEND_GROUP_LIST_UPDATED

好友分组列表更新时触发

Example
let onFriendGroupListUpdated = function(event) {
  console.log(event.data);
}
tim.on(TIM.EVENT.FRIEND_GROUP_LIST_UPDATED, onFriendGroupListUpdated);

(static) FRIEND_APPLICATION_LIST_UPDATED

SDK 好友申请列表更新时触发

Example
let onFriendApplicationListUpdated = function(event) {
  // friendApplicationList - 好友申请列表 - [FriendApplication]
  // unreadCount - 好友申请的未读数
  const { friendApplicationList, unreadCount } = event.data;
  // 发送给我的好友申请（即别人申请加我为好友）
  const applicationSentToMe = friendApplicationList.filter((friendApplication) => friendApplication.type === TIM.TYPES.SNS_APPLICATION_SENT_TO_ME);
  // 我发送出去的好友申请（即我申请加别人为好友）
  const applicationSentByMe = friendApplicationList.filter((friendApplication) => friendApplication.type === TIM.TYPES.SNS_APPLICATION_SENT_BY_ME);
};
tim.on(TIM.EVENT.FRIEND_APPLICATION_LIST_UPDATED, onFriendApplicationListUpdated);

(static) KICKED_OUT

用户被踢下线时触发

Example
let onKickedOut = function(event) {
  console.log(event.data.type);
  // TIM.TYPES.KICKED_OUT_MULT_ACCOUNT(Web端，同一帐号，多页面登录被踢)
  // TIM.TYPES.KICKED_OUT_MULT_DEVICE(同一帐号，多端登录被踢)
  // TIM.TYPES.KICKED_OUT_USERSIG_EXPIRED(签名过期。使用前需要将SDK版本升级至v2.4.0或以上)
  // TIM.TYPES.KICKED_OUT_REST_API(REST API kick 接口踢出。使用前需要将SDK版本升级至v2.20.0或以上)
};
tim.on(TIM.EVENT.KICKED_OUT, onKickedOut);

(static) ERROR

SDK 遇到错误时触发

Example
let onError = function(event) {
  // event.data.code - 错误码
  // event.data.message - 错误信息
};
tim.on(TIM.EVENT.ERROR, onError);

(static) NET_STATE_CHANGE

网络状态发生改变

Example
let onNetStateChange = function(event) {
  // v2.5.0 起支持
  // event.data.state 当前网络状态，枚举值及说明如下：
  // TIM.TYPES.NET_STATE_CONNECTED - 已接入网络
  // TIM.TYPES.NET_STATE_CONNECTING - 连接中。很可能遇到网络抖动，SDK 在重试。接入侧可根据此状态提示“当前网络不稳定”或“连接中”
  // TIM.TYPES.NET_STATE_DISCONNECTED - 未接入网络。接入侧可根据此状态提示“当前网络不可用”。SDK 仍会继续重试，若用户网络恢复，SDK 会自动同步消息
};
tim.on(TIM.EVENT.NET_STATE_CHANGE, onNetStateChange);