- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started with Demos
- Console Guide
- SDK Documentation
- SDK Download
- Quick Integration (Including UI Library)
- General Integration (No UI Library)
- Update Log (Web & Mini Program)
- Update Log (Native)
- Legacy API Tutorials
- Server APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Introduction
- RESTful API List
- Account Management
- One-to-One Message
- Online States
- Profile Management
- Relationship Chain Management
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Muting and Unmuting Group Members
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Deleting Messages Sent by a Specified User
- Getting Historical Group Messages
- Getting the Number of Online Users in an Audio-Video Group
- Operations Management
- Global Mute Management
- Pushing to All Users (in Beta)
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callback Mutual Authentication Configuration Guide
- Best Practices
- FAQs
- General References
- Error Codes
- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started with Demos
- Console Guide
- SDK Documentation
- SDK Download
- Quick Integration (Including UI Library)
- General Integration (No UI Library)
- Update Log (Web & Mini Program)
- Update Log (Native)
- Legacy API Tutorials
- Server APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Introduction
- RESTful API List
- Account Management
- One-to-One Message
- Online States
- Profile Management
- Relationship Chain Management
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Muting and Unmuting Group Members
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Deleting Messages Sent by a Specified User
- Getting Historical Group Messages
- Getting the Number of Online Users in an Audio-Video Group
- Operations Management
- Global Mute Management
- Pushing to All Users (in Beta)
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callback Mutual Authentication Configuration Guide
- Best Practices
- FAQs
- General References
- Error Codes
IM SDK Concepts
Conversation: there are two types of conversations in the IM SDK. One is the C2C conversation, which is a one-to-one chat between users with messages read and sent within the conversation. The other is the group conversation, which is a group chat where all group members can receive messages.
Message: a message in the IM SDK is the information to be sent to the recipient. A message includes properties such as whether it was read by yourself, whether it was sent successfully, the sender’s account, and the message generation time. A message consists of several Elems, which can be text, images, emojis, and others. A message can contain multiple Elems.
Group ID: a group ID uniquely identifies a group. It is generated by the backend and returned when a group is created.
Introduction to IM SDK Objects
iOS IM SDK objects include the communication manager, conversation, message, and group management. The following table describes them in detail.
| Object | Description | Features |
|---|---|---|
| TIMManager | Manager | Responsible for basic IM SDK operations such as initialization, login, logout, and creating conversations |
| TIMConversation | Conversation | Responsible for conversation-related operations such as sending messages, obtaining cached conversation messages, and obtaining the unread count |
| TIMMessage | Message | Support various message types including text and image messages |
| TIMGroupManager | Group manager | Responsible for creating groups, adding and deleting members, and modifying group profiles |
| TIMFriendshipManager | Friend relationship chain manager | Responsible for adding and deleting friends and managing friend profiles |
Calling Sequence
The IM SDK calls APIs in the following sequence, and other methods will be called after login succeeds.
| Step | Function | Description |
|---|---|---|
| Initialization | TIMManager:initSdk | Configure SDK settings |
| Initialization | TIMManager:setUserConfig | Configure user settings |
| Login | TIMManager:login | Log users in |
| Receiving and sending messages | TIMManager:getConversation | Obtain conversations |
| Receiving and sending messages | TIMConversation:sendMessage | Send messages |
| Group management | TIMGroupManager | Manage groups |
| Relationship chain management | TIMFriendshipManager | Manage relationship chains |
| Logout | TIMManager:logout | Log users out (optional for users) |
Was this page helpful?