SDK APIs (Web & Mini Program)
Last updated: 2021-01-05 10:04:44
TIM
TIM is the namespace of the IM Web SDK and provides the static method create() for creating SDK instances, the event constant EVENT, and the type constant TYPES.
Initialization
API |
Description |
create |
Creates an SDK instance. |
SDK Instance
Term |
Description |
Message |
Message indicates the content to be sent and carries multiple attributes which specify whether you are the sender, the sender account, the message generation time, and so on. |
Conversation |
Two types of Conversation are available:Client to Client (C2C): a one-to-one chat, involving only 2 participants.GROUP: a group chat, involving more than 2 participants. |
Profile |
Profile describes the basic information of a user, including the nickname, gender, personal signature, and profile photo address. |
Group |
Group in IM SDK is a communication system for group chatting, including Work, Public, Meeting, and AVChatRoom. |
GroupMember (Group member) |
GroupMember indicates the basic information of each group member, such as the ID, nickname, role, and the time of joining the group. |
Group notification |
A group notification is generated when an event such as group member addition or deletion occurs. You can configure whether to display group notifications to group members. For more information about group notification types, see Message.GroupTipPayload. |
Group system message |
For example, when a user applies for joining a group, the group admin receives a system message. After the admin accepts or denies the application, the IM SDK returns the application result to the access terminal, and then the user can view the result displayed on the access terminal. For more information about types of group system messages, see Message.GroupSystemNoticePayload. |
Message display on screen |
This is the process by which messages, including text and images, are displayed on the computer or phone screen after the user clicks send. |
Login
API |
Description |
login |
Logs in to the IM. |
logout |
Logs out of the IM console. |
Message
Conversation
Profile
Group
Group member
Others
Was this page helpful?