IMSDK
IM features a comprehensive suite of solutions including global access, one-to-one chat, group chat, message push, profile and relationship chain hosting, and account authentication. It also provides complete app access and backend management APIs.
V2TIMManagerabstract

Public Member Functions

abstract boolean initSDK (Context context, int sdkAppID, V2TIMSDKConfig config)
 
abstract void unInitSDK ()
 
abstract void addIMSDKListener (V2TIMSDKListener listener)
 
abstract void removeIMSDKListener (V2TIMSDKListener listener)
 
abstract String getVersion ()
 
abstract long getServerTime ()
 
abstract boolean initSDK (Context context, int sdkAppID, V2TIMSDKConfig config, V2TIMSDKListener listener)
 
abstract void login (String userID, String userSig, V2TIMCallback callback)
 
abstract void logout (V2TIMCallback callback)
 
abstract String getLoginUser ()
 
abstract int getLoginStatus ()
 
abstract void addSimpleMsgListener (V2TIMSimpleMsgListener v2TIMSimpleMsgListener)
 
abstract void removeSimpleMsgListener (V2TIMSimpleMsgListener v2TIMSimpleMsgListener)
 
abstract String sendC2CTextMessage (String text, String userID, V2TIMValueCallback< V2TIMMessage > callback)
 
abstract String sendC2CCustomMessage (byte[] customData, String userID, V2TIMValueCallback< V2TIMMessage > callback)
 
abstract String sendGroupTextMessage (String text, String groupID, int priority, V2TIMValueCallback< V2TIMMessage > callback)
 
abstract String sendGroupCustomMessage (byte[] customData, String groupID, int priority, V2TIMValueCallback< V2TIMMessage > callback)
 
abstract void setGroupListener (V2TIMGroupListener listener)
 
abstract void addGroupListener (V2TIMGroupListener listener)
 
abstract void removeGroupListener (V2TIMGroupListener listener)
 
abstract void createGroup (String groupType, String groupID, String groupName, V2TIMValueCallback< String > callback)
 
abstract void joinGroup (String groupID, String message, V2TIMCallback callback)
 
abstract void quitGroup (String groupID, final V2TIMCallback callback)
 
abstract void dismissGroup (String groupID, final V2TIMCallback callback)
 
abstract void getUsersInfo (List< String > userIDList, V2TIMValueCallback< List< V2TIMUserFullInfo >> callback)
 
abstract void setSelfInfo (V2TIMUserFullInfo info, V2TIMCallback callback)
 
abstract void callExperimentalAPI (String api, Object param, V2TIMValueCallback< Object > callback)
 

Static Public Member Functions

static V2TIMManager getInstance ()
 
static V2TIMMessageManager getMessageManager ()
 
static V2TIMGroupManager getGroupManager ()
 
static V2TIMConversationManager getConversationManager ()
 
static V2TIMFriendshipManager getFriendshipManager ()
 
static V2TIMOfflinePushManager getOfflinePushManager ()
 
static V2TIMSignalingManager getSignalingManager ()
 

Static Public Attributes

static final int V2TIM_STATUS_LOGINED = 1
 
static final int V2TIM_STATUS_LOGINING = 2
 
static final int V2TIM_STATUS_LOGOUT = 3
 
static final String GROUP_TYPE_WORK = "Work"
 
static final String GROUP_TYPE_PUBLIC = "Public"
 
static final String GROUP_TYPE_MEETING = "Meeting"
 
static final String GROUP_TYPE_AVCHATROOM = "AVChatRoom"
 
static final String GROUP_TYPE_COMMUNITY = "Community"
 

Detailed Description

Core class of the IM SDK, implementing features such as IM SDK initialization and login, message sending and receiving, and group creation and quitting

Member Function Documentation

◆ getInstance()

static V2TIMManager getInstance ( )
inlinestatic

1.1 Get the V2TIMManager instance

◆ initSDK() [1/2]

abstract boolean initSDK ( Context  context,
int  sdkAppID,
V2TIMSDKConfig  config 
)
abstract

1.2 Initialize the SDK

Parameters
contextContext
sdkAppIDApp ID. This field is required. You can obtain the app ID from the console.
configConfiguration information
Returns
true: successful; false: failed. If context is empty, false is returned.

◆ unInitSDK()

abstract void unInitSDK ( )
abstract

1.3 Uninitialize the SDK

◆ addIMSDKListener()

abstract void addIMSDKListener ( V2TIMSDKListener  listener)
abstract

1.4 Add IM listener

◆ removeIMSDKListener()

abstract void removeIMSDKListener ( V2TIMSDKListener  listener)
abstract

1.5 Remove IM listener

◆ getVersion()

abstract String getVersion ( )
abstract

1.6 Get the SDK version

Returns

◆ getServerTime()

abstract long getServerTime ( )
abstract

1.7 Get the current server time

Returns
Server time, in seconds

◆ initSDK() [2/2]

abstract boolean initSDK ( Context  context,
int  sdkAppID,
V2TIMSDKConfig  config,
V2TIMSDKListener  listener 
)
abstract

1.8 Initialize the SDK

Parameters
contextContext
sdkAppIDApp ID. This field is required. You can obtain the app ID from the console.
configConfiguration information
listenerSDK callback
Returns
true: successful; false: failed. If context is empty, false is returned.

◆ login()

abstract void login ( String  userID,
String  userSig,
V2TIMCallback  callback 
)
abstract

2.1 Login

userID and userSig must be set for login. For the generation of userSig, please see UserSig backend API.

Attention
Note the following special logic:
  • The ticket expires before login: the callback of the login function returns the error ERR_USER_SIG_EXPIRED (6206) or ERR_SVR_ACCOUNT_USERSIG_EXPIRED (70001), and the user needs to generate a new userSig and log in again.
  • The ticket expires when the user is online: the user can receive the V2TIMListener -> onUserSigExpired callback when online, and the user also needs to generate a new userSig and log in again.
  • An online user is kicked offline: the SDK notifies the user of the logout via the V2TIMListener -> onKickedOffline callback and displays the logout notification on the UI, and the user can call login() to log in again.

◆ logout()

abstract void logout ( V2TIMCallback  callback)
abstract

2.2 Logout

If the user logs out and switches the account, the user can log in again after the logout function calls back success or failure. Otherwise, login may fail.

◆ getLoginUser()

abstract String getLoginUser ( )
abstract

2.3 Get the login user

◆ getLoginStatus()

abstract int getLoginStatus ( )
abstract

2.4 Get the login status

If the user is already in the "logged in" or "logging in" state, do not frequently call the login API to log in.

Returns
Login status
  • V2TIM_STATUS_LOGINED: logged in
  • V2TIM_STATUS_LOGINING: logging in
  • V2TIM_STATUS_LOGOUT: logged out

◆ addSimpleMsgListener()

abstract void addSimpleMsgListener ( V2TIMSimpleMsgListener  v2TIMSimpleMsgListener)
abstract

3.1 Set the event listener for simple messages (text messages and custom messages)

Attention
For the event listener for advanced messages such as image, video, and voice messages, please see V2TIMMessageManager.addAdvancedMsgListener(V2TIMAdvancedMsgListener).

◆ removeSimpleMsgListener()

abstract void removeSimpleMsgListener ( V2TIMSimpleMsgListener  v2TIMSimpleMsgListener)
abstract

3.2 Remove the event listener for simple messages (text messages and custom messages)

◆ sendC2CTextMessage()

abstract String sendC2CTextMessage ( String  text,
String  userID,
V2TIMValueCallback< V2TIMMessage callback 
)
abstract

3.3 Send a one-to-one text message (up to 8 KB)

Text messages support sensitive word filtering on the cloud. For example, if a text message sent by a user contains sensitive words, the callback will return the 80001 error code.

Returns
Unique ID of the message
Attention
Messages sent via this API are pushed by default (provided that the push feature is enabled in V2TIMOfflinePushManager). If you need to customize the push (title and content), call the V2TIMMessageManager.sendMessage API.

◆ sendC2CCustomMessage()

abstract String sendC2CCustomMessage ( byte[]  customData,
String  userID,
V2TIMValueCallback< V2TIMMessage callback 
)
abstract

3.4 Send a one-to-one custom (signaling) message (up to 8 KB)

A custom message is essentially a binary buffer on which you can freely organize your message format (often used to send signaling). However, custom messages do not support sensitive word filtering on the cloud.

Returns
Unique ID of the message
Attention
Messages sent via this API are not pushed by default. To push the messages, call the V2TIMMessageManager.sendMessage API.

◆ sendGroupTextMessage()

abstract String sendGroupTextMessage ( String  text,
String  groupID,
int  priority,
V2TIMValueCallback< V2TIMMessage callback 
)
abstract

3.5 Send a group text message (up to 8 KB)

Parameters
priorityMessage priority. Though there is no way for all messages to 100% reach every user, higher-priority messages will have a higher delivery success rate.
  • V2TIMMessage.V2TIM_PRIORITY_HIGH: the message will be transferred with high priority on the cloud. This setting is suitable for sending important messages in the group, such as text messages sent by host.
  • V2TIMMessage.V2TIM_PRIORITY_NORMAL: the message will be transferred with the default priority on the cloud. This setting is suitable for sending unimportant messages in the group, such as on-screen comments sent by viewers.
Returns
Unique ID of the message
Attention
Messages sent via this API are pushed by default (provided that the push feature is enabled in V2TIMOfflinePushManager). If you need to customize the push (title and content), call the V2TIMMessageManager.sendMessage API.

◆ sendGroupCustomMessage()

abstract String sendGroupCustomMessage ( byte[]  customData,
String  groupID,
int  priority,
V2TIMValueCallback< V2TIMMessage callback 
)
abstract

3.6 Send a group custom (signaling) message (up to 8 KB)

Parameters
priorityMessage priority. Though there is no way for all messages to 100% reach every user, higher-priority messages will have a higher delivery success rate.
  • V2TIMMessage.V2TIM_PRIORITY_HIGH: the message will be transferred with high priority on the cloud. This setting is suitable for sending important messages in the group, such as mic connect invitations, competition invitation, gift-giving, and other key signaling.
  • V2TIMMessage.V2TIM_PRIORITY_NORMAL: the message will be transferred with the default priority on the cloud. This setting is suitable for sending unimportant signaling in the group, such as audience's like notifications.
Returns
Unique ID of the message
Attention
Messages sent via this API are not pushed by default. To push the messages, call the V2TIMMessageManager.sendMessage API.

◆ setGroupListener()

abstract void setGroupListener ( V2TIMGroupListener  listener)
abstract

4.1 Set the group listener

◆ addGroupListener()

abstract void addGroupListener ( V2TIMGroupListener  listener)
abstract

4.2 Add the group listener

◆ removeGroupListener()

abstract void removeGroupListener ( V2TIMGroupListener  listener)
abstract

4.3 Remove the group listener

◆ createGroup()

abstract void createGroup ( String  groupType,
String  groupID,
String  groupName,
V2TIMValueCallback< String >  callback 
)
abstract

4.4 Create a group

Parameters
groupTypeGroup type. The following several common group types are preset in the SDK. You can also customize desired group types in the console:
  • Work group (Work): supports up to 200 members; does not allow proactive group joining and only allows users to be invited to join the group by group members; suitable for groups like work groups created in WeChat (corresponding to Private groups in the earlier version)
  • Public group (Public): supports up to 2,000 members; allows anyone to apply to join the group, but requires group owner or admin approval for group joining; suitable for groups like interest groups managed by group owners in QQ
  • Meeting group (Meeting): supports up to 6,000 members; allows anyone to join and leave the group freely, without approval; suitable for scenarios such as video conference and online training (corresponding to ChatRoom groups in the earlier version)
  • Community : supports up to 100,000 members; allows anyone to join and leave the group freely, without approval; suitable for large community group chat scenarios such as knowledge sharing and game communication. supported only in 5.8 and later versions, need to buy Flagship Edition.
  • Audio-video group (AVChatRoom): supports an unlimited number of members; allows anyone to join and leave the group freely; features high message throughput and is suitable for use as a chat room with high-concurrency on-screen comments in live streaming scenarios
groupIDCustom group ID. "null" can be passed in. When "null" is passed in, the system automatically assigns a group ID and calls back the group ID via callback. Custom group ID of "Community" must be prefixed with "@TGS#_".
groupNameGroup name. The value cannot be "null" and can contain up to 30 bytes.
Attention
Note the following special logic:
  • Do not create groups with the same group ID under the same SDKAppID.

◆ joinGroup()

abstract void joinGroup ( String  groupID,
String  message,
V2TIMCallback  callback 
)
abstract

4.5 Join a group

Attention
Note the following special logic:
  • Work group (Work): users cannot proactively join a Work group. Only group members can call the V2TIMManager.getGroupManager().inviteUserToGroup() API to invite users to join the group.
  • Public group (Public): admin approval is required for users to join a Public group. When receiving the V2TIMGroupListener -> onReceiveJoinApplication callback, the admin needs to call the V2TIMManager.getGroupManager().getGroupApplicationList() API to handle group joining requests.
  • Other groups: users can directly join such groups.

◆ quitGroup()

abstract void quitGroup ( String  groupID,
final V2TIMCallback  callback 
)
abstract

4.6 Quit a group

Attention
For public groups (Public), meeting groups (Meeting), and audio-video groups (AVChatRoom), the group owner cannot quit the group and can only call dismissGroup to delete the group.

◆ dismissGroup()

abstract void dismissGroup ( String  groupID,
final V2TIMCallback  callback 
)
abstract

4.7 Delete a group

Attention
Note the following special logic:
  • For a work group (Work), even the group owner does not have the privilege to delete the group. To delete the group, you must have your service server to call the RESTful API Deleting a Group to delete the group.
  • For other group types, the group owner can delete the group.

◆ getUsersInfo()

abstract void getUsersInfo ( List< String >  userIDList,
V2TIMValueCallback< List< V2TIMUserFullInfo >>  callback 
)
abstract

5.1 Get user profiles

Attention
Notes:
  • To get your own profile, pass in your user ID.
  • You are advised to specify no more than 100 user IDs in userIDList at a time. A larger number may cause the request to be rejected by the backend due to an excessively large data packet. The maximum size of a data packet supported by the backend is 1 MB.

◆ setSelfInfo()

abstract void setSelfInfo ( V2TIMUserFullInfo  info,
V2TIMCallback  callback 
)
abstract

5.2 Modify one's own user profile

◆ getMessageManager()

static V2TIMMessageManager getMessageManager ( )
inlinestatic

Advanced message feature entry

Returns
Advanced message management class instance

◆ getGroupManager()

static V2TIMGroupManager getGroupManager ( )
inlinestatic

Advanced group feature entry

Returns
Advanced group management class instance

◆ getConversationManager()

static V2TIMConversationManager getConversationManager ( )
inlinestatic

Conversation feature entry

Returns
Conversation management class instance

◆ getFriendshipManager()

static V2TIMFriendshipManager getFriendshipManager ( )
inlinestatic

Relationship chain feature entry

Returns
Relationship chain management class instance

◆ getOfflinePushManager()

static V2TIMOfflinePushManager getOfflinePushManager ( )
inlinestatic

Offline push feature entry

Returns
Offline push feature class instance

◆ getSignalingManager()

static V2TIMSignalingManager getSignalingManager ( )
inlinestatic

Signaling entry

Returns
Signaling management class instance

◆ callExperimentalAPI()

abstract void callExperimentalAPI ( String  api,
Object  param,
V2TIMValueCallback< Object >  callback 
)
abstract

Experimental API

Parameters
apiAPI name
paramAPI parameter
Attention
This API provides some experimental features.

Field Documentation

◆ V2TIM_STATUS_LOGINED

final int V2TIM_STATUS_LOGINED = 1
static

Logged in

◆ V2TIM_STATUS_LOGINING

final int V2TIM_STATUS_LOGINING = 2
static

Logging in

◆ V2TIM_STATUS_LOGOUT

final int V2TIM_STATUS_LOGOUT = 3
static

Logged out

◆ GROUP_TYPE_WORK

final String GROUP_TYPE_WORK = "Work"
static

Work group

◆ GROUP_TYPE_PUBLIC

final String GROUP_TYPE_PUBLIC = "Public"
static

Public group

◆ GROUP_TYPE_MEETING

final String GROUP_TYPE_MEETING = "Meeting"
static

Meeting group

◆ GROUP_TYPE_AVCHATROOM

final String GROUP_TYPE_AVCHATROOM = "AVChatRoom"
static

Audio-video group

◆ GROUP_TYPE_COMMUNITY

final String GROUP_TYPE_COMMUNITY = "Community"
static

Community