EVENT

Members

(static) 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

Example

let onSdkNotReady = function(event) {
  // To use features such as message sending, the access side needs to drive the SDK to enter the ready state and then calls the login API again as follows:
  // tim.login({userID: 'your userID', userSig: 'your userSig'});
};
tim.on(TIM.EVENT.SDK_NOT_READY, onSdkNotReady);

(static) MESSAGE_RECEIVED

Example

let onMessageReceived = function(event) {
  // event.data - An array that stores the Message objects - [Message]
};
tim.on(TIM.EVENT.MESSAGE_RECEIVED, onMessageReceived);

(static) MESSAGE_MODIFIED

Example

let onMessageModified = function(event) {
  // event.data - An array that stores the Message objects modified by a third-party callback - [Message]
};
tim.on(TIM.EVENT.MESSAGE_MODIFIED, onMessageModified);

(static) MESSAGE_REVOKED

Example

let onMessageRevoked = function(event) {
  // event.data - An array that stores the Message objects - [Message] - The isRevoked value of each Message object is true.
};
tim.on(TIM.EVENT.MESSAGE_REVOKED, onMessageRevoked);

(static) MESSAGE_READ_BY_PEER

Example

let onMessageReadByPeer = function(event) {
  // event.data - An array that stores the Message objects - [Message] - The isPeerRead value of each Message object is true.
};
tim.on(TIM.EVENT.MESSAGE_READ_BY_PEER, onMessageReadByPeer);

(static) CONVERSATION_LIST_UPDATED

Example

let onConversationListUpdated = function(event) {
  console.log(event.data); // Array that stores Conversation instances
};
tim.on(TIM.EVENT.CONVERSATION_LIST_UPDATED, onConversationListUpdated);

(static) GROUP_LIST_UPDATED

Example

let onGroupListUpdated = function(event) {
   console.log(event.data);// Array that stores Group instances
};
tim.on(TIM.EVENT.GROUP_LIST_UPDATED, onGroupListUpdated);

(static) GROUP_ATTRIBUTES_UPDATED

Example

let onGroupAttributesUpdated = function(event) {
   const groupID = event.data.groupID // Group ID
   const groupAttributes = event.data.groupAttributes //Updated group properties
   console.log(event.data);
};
tim.on(TIM.EVENT.GROUP_ATTRIBUTES_UPDATED, onGroupAttributesUpdated);

(static) PROFILE_UPDATED

Example

let onProfileUpdated = function(event) {
  console.log(event.data); // Array that stores Profile objects
};
tim.on(TIM.EVENT.PROFILE_UPDATED, onProfileUpdated);

(static) BLACKLIST_UPDATED

Example

let onBlacklistUpdated = function(event) {
  console.log(event.data); // Your blocklist. The value is an array that stores userIDs.
};
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

Example

let onFriendApplicationListUpdated = function(event) {
  // friendApplicationList - Friend request list - [FriendApplication]
  // unreadCount - Unread friend request count
  const { friendApplicationList, unreadCount } = event.data;
  // Friend requests received by me (friend requests that are sent to you by others)
  const applicationSentToMe = friendApplicationList.filter((friendApplication) => friendApplication.type === TIM.TYPES.SNS_APPLICATION_SENT_TO_ME);
  // Friend requests sent by me (friend requests that you send to others)
  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: the user is kicked offline because the same account logs in from multiple pages on the web client.
  // TIM.TYPES.KICKED_OUT_MULT_DEVICE: the user is kicked offline because the same account logs in from multiple terminals.
  // TIM.TYPES.KICKED_OUT_USERSIG_EXPIRED: the user is kicked offline because the signature expires. Before using this event, you need to upgrade your SDK to v2.4.0 or later.
};
tim.on(TIM.EVENT.KICKED_OUT, onKickedOut);

(static) ERROR

Example

let onError = function(event) {
  // event.data.code - Error code
  // event.data.message - Error message
};
tim.on(TIM.EVENT.ERROR, onError);

(static) NET_STATE_CHANGE

Example

let onNetStateChange = function(event) {
  // Supported from v2.5.0
  // event.data.state indicates the current network status. The enumerated values are described as follows:
  // TIM.TYPES.NET_STATE_CONNECTED: already connected to the network
  // TIM.TYPES.NET_STATE_CONNECTING: connecting. This often occurs when the SDK must reconnect due to network jitter. The message "The current network is unstable" or "Connecting..." can be displayed at the access side based on this status.
  // TIM.TYPES.NET_STATE_DISCONNECTED: disconnected. The message "The current network is unavailable" can be displayed at the access side based on this status. The SDK will continue to try to reconnect. If the user network recovers, the SDK will automatically synchronize messages.
};
tim.on(TIM.EVENT.NET_STATE_CHANGE, onNetStateChange);

(static) SDK_RELOAD

Example

// Supported from v2.7.7
let onSDKReload = function(event) {
};
tim.on(TIM.EVENT.SDK_RELOAD, onSDKReload);