Rongcloud IMLib for Flutter

https://docs.rongcloud.cn/flutter-imlib/
Admin
Rongcloud IMLib for Flutter is an instant messaging SDK library that provides core communication...
Tokens:141,283
Snippets:989
Trust Score:9.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Import RongCloud IM Wrapper Plugin

Source: https://docs.rongcloud.cn/flutter-imlib/import

Import the main plugin file in your Dart code to start using the SDK's functionalities.

```dart
import 'package:rongcloud_im_wrapper_plugin/rongcloud_im_wrapper_plugin.dart';
```

--------------------------------

### Configure and Initialize Engine with Push Options

Source: https://docs.rongcloud.cn/flutter-imlib/push/summary

Create RCIMIWEngineOptions and populate the pushOptions with specific third-party push configurations. Then, initialize the RCIMIWEngine with these options.

```dart
RCIMIWEngineOptions options = RCIMIWEngineOptions.create();
RCIMIWPushOptions pushOptions = RCIMIWPushOptions.create(
    idMI: AndroidPushInfo.idMI,
    appKeyMI: AndroidPushInfo.appKeyMI,
    appIdMeizu: AndroidPushInfo.appIdMeizu,
    appKeyMeizu: AndroidPushInfo.appKeyMeizu,
    appKeyOPPO: AndroidPushInfo.appKeyOPPO,
    appSecretOPPO: AndroidPushInfo.appSecretOPPO,
    enableHWPush: true,
    enableFCM: false,
    enableVIVOPush: true,
);
options.pushOptions = pushOptions;
RCIMIWEngine e = await RCIMIWEngine.create(appkey, options);
```

--------------------------------

### Get Specific Conversation

Source: https://docs.rongcloud.cn/flutter-imlib/conversation/get

Retrieves detailed information for a specific conversation.

```APIDOC
## GET /conversation

### Description
Retrieves detailed information for a specific conversation based on its type, target ID, and channel ID.

### Method
GET

### Endpoint
/conversation

### Parameters
#### Query Parameters
- **type** (RCIMIWConversationType) - Required - The type of the conversation.
- **targetId** (String) - Required - The ID of the conversation target.
- **channelId** (String) - Optional - Channel ID, only applicable for super groups; pass null for other conversation types.
- **callback** (IRCIMIWGetConversationCallback) - Optional - Callback for conversation retrieval events. Supported from SDK version 5.3.1. If provided, only this callback will be triggered.

### Request Example
```dart
// Example usage within a Dart context
Future<void> fetchConversation() async {
    RCIMIWConversationType type = RCIMIWConversationType.message; // Example type
    String targetId = 'someUserId';
    String? channelId = null;

    IRCIMIWGetConversationCallback? callback = IRCIMIWGetConversationCallback(
        onSuccess: (RCIMIWConversation? conversation) {
            print('Successfully fetched conversation: $conversation');
        },
        onError: (int? errorCode) {
            print('Error fetching conversation: $errorCode');
        }
    );

    int? result = await engine?.getConversation(type, targetId, channelId, callback: callback);
    if (result != 0) {
        print('getConversation API call failed with status code: $result');
    }
}
```

### Response
#### Success Response (200)
- **Future<int>** (int) - Operation status code. 0 indicates successful API call; non-zero indicates failure, and the callback will not be triggered. Refer to error codes for details.
```

--------------------------------

### GET /getUnreadMentionedCount

Source: https://docs.rongcloud.cn/flutter-imlib/conversation/unread

Retrieves the count of unread @ mentioned messages for a specified conversation.

```APIDOC
## getUnreadMentionedCount

### Description
Retrieves the count of unread @ mentioned messages in a specific conversation.

### Parameters
#### Arguments
- **type** (RCIMIWConversationType) - Required - 会话类型
- **targetId** (String) - Required - 会话 ID
- **channelId** (String) - Optional - 频道 ID，仅支持超级群使用，其他会话类型传 null 即可。
- **callback** (IRCIMIWGetUnreadMentionedCountCallback) - Required - 获取会话中未读的 @ 消息数量事件回调。

### Response
- **Future<int>** - 当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败。

### Request Example
```dart
IRCIMIWGetUnreadMentionedCountCallback? callback = IRCIMIWGetUnreadMentionedCountCallback(
onSuccess: (int? t) {
//...
}, 
onError: (int? code) {
//...
});

int? ret = await engine?.getUnreadMentionedCount(type, targetId, channelId, callback:callback);
```
```

--------------------------------

### Initialization API

Source: https://docs.rongcloud.cn/flutter-imlib/init

Before using other features of the SDK, you must initialize it. This involves obtaining an App Key and creating an instance of `RCIMIWEngine`.

```APIDOC
## POST /api/initialize

### Description
Initializes the RongCloud IM SDK. This is a mandatory step before using any other SDK functionalities. You need to provide your App Key and engine options.

### Method
POST

### Endpoint
RCIMIWEngine.create

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **appKey** (String) - Required - The App Key obtained from the RongCloud Console.
- **options** (RCIMIWEngineOptions) - Required - Engine-related configuration options.

### Request Example
```dart
RCIMIWEngineOptions options = RCIMIWEngineOptions.create();
RCIMIWEngine engine = await RCIMIWEngine.create(appKey, options);
```

### Response
#### Success Response (200)
- **engine** (RCIMIWEngine) - The initialized IM engine instance.

#### Response Example
```json
{
  "engine": "RCIMIWEngine instance"
}
```
```

--------------------------------

### Get Unread Mentioned Count

Source: https://docs.rongcloud.cn/flutter-imlib/conversation/unread

Loads the unread mention count for a conversation.

```APIDOC
## GET /getUnreadMentionedCount

### Description
Loads the unread mention count for a conversation.

### Method
GET

### Endpoint
`/getUnreadMentionedCount`

### Parameters
#### Query Parameters
- **type** (RCIMIWConversationType) - Required - Conversation type.
- **targetId** (String) - Required - Conversation ID.
- **channelId** (String) - Optional - Channel ID, only supported for super groups, pass null for other conversation types.
- **callback** (IRCIMIWGetUnreadMentionedCountCallback) - Optional - Callback for events.

### Response
#### Success Response (200)
- **Future<int>** - Returns 0 for successful operation, actual results via callback. Non-zero indicates an operation failure.
```

--------------------------------

### 添加 SDK 依赖

Source: https://docs.rongcloud.cn/flutter-imlib/quickstart

在项目的 pubspec.yaml 文件中添加 rongcloud_im_wrapper_plugin 依赖。

```yaml
dependencies:
  flutter:
    sdk: flutter

rongcloud_im_wrapper_plugin: x.y.z
```

--------------------------------

### Setting up Subscription Listeners

Source: https://docs.rongcloud.cn/flutter-imlib/user/subscribe_online

Configures listeners for subscription event changes, synchronization completion, and updates from other devices.

```APIDOC
## Subscription Event Listeners

### Description
Sets up listeners to receive notifications for subscription event changes. It is recommended to set these listeners before establishing a connection.

### Parameters
- **onEventChange** (Function(List<RCIMIWSubscribeInfoEvent>?)) - Required - Callback triggered when subscription events change.
- **onSubscriptionSyncCompleted** (Function(RCIMIWSubscribeType?)) - Required - Callback triggered when subscription data synchronization is complete.
- **onSubscriptionChangedOnOtherDevices** (Function(List<RCIMIWSubscribeEvent>?)) - Required - Callback triggered when subscription information changes on other devices.

### Supported Types
- **onlineStatus** (1): Online status tracking.
- **userProfile** (2): User profile hosting.

### Implementation Example
```dart
engine.onEventChange = (List<RCIMIWSubscribeInfoEvent>? subscribeEvents) {
  // Handle online status changes
};

engine.onSubscriptionSyncCompleted = (RCIMIWSubscribeType? type) {
  // Handle sync completion
};

engine.onSubscriptionChangedOnOtherDevices = (List<RCIMIWSubscribeEvent>? subscribeEvents) {
  // Handle cross-device changes
};
```
```

--------------------------------

### Get List of Blocked Conversations

Source: https://docs.rongcloud.cn/flutter-imlib/conversation/do-not-disturb-by-target-id

Fetches a list of all conversations for which Do Not Disturb has been enabled.

```APIDOC
## GET /api/conversations/blocked

### Description
Fetches a list of all conversations for which Do Not Disturb has been enabled.

### Method
GET

### Endpoint
/api/conversations/blocked

### Parameters
#### Query Parameters
- **conversationTypes** (List<RCIMIWConversationType>) - Required - A list of conversation types to filter by.
- **channelId** (String) - Optional - The channel ID for super groups. If not specified, it applies to all super group messages.
- **callback** (IRCIMIWGetBlockedConversationsCallback) - Optional - Callback for handling the result of the operation.

### Request Example
```dart
// Assuming 'engine' is an instance of your IM client
List<RCIMIWConversationType> types = [RCIMIWConversationType.single, RCIMIWConversationType.group];
int? ret = await engine?.getBlockedConversations(types, null, callback: IRCIMIWGetBlockedConversationsCallback(
  onSuccess: (List<RCIMIWConversation>? conversations) => print("Blocked conversations: $conversations"),
  onError: (int? code) => print("Error getting blocked conversations: $code")
));
```

### Response
#### Success Response (200)
- **conversations** (List<RCIMIWConversation>) - A list of conversations that are currently blocked (Do Not Disturb enabled).

#### Response Example
```json
{
  "conversations": [
    {
      "type": "RCIMIWConversationType.single",
      "targetId": "user456",
      "channelId": null
    },
    {
      "type": "RCIMIWConversationType.group",
      "targetId": "group789",
      "channelId": "channelA"
    }
  ]
}
```
```

--------------------------------

### Get Tags from Conversation

Source: https://docs.rongcloud.cn/flutter-imlib/conversation/tag

Retrieves all tags associated with a specific conversation, including their pinning status.

```APIDOC
## GET /api/conversations/tags/get

### Description
Retrieves all tags associated with a specific conversation. The callback returns a list of `RCConversationTagInfo`, each containing tag information and pinning status.

### Method
GET

### Endpoint
/api/conversations/tags/get

### Parameters
#### Path Parameters
- **type** ([RCIMIWConversationType](https://pub.dev/documentation/rongcloud_im_wrapper_plugin/latest/rongcloud_im_wrapper_plugin/RCIMIWConversationType.html)) - Required - The type of the conversation.
- **targetId** (String) - Required - The ID of the conversation.

#### Query Parameters
None

#### Request Body
None

### Request Example
```dart
// Example usage within a Dart environment
Future<void> getConversationTags(RCIMIWConversationType type, String targetId) async {
  IRCIMIWGetTagsFromConversationCallback? callback = IRCIMIWGetTagsFromConversationCallback(
    onSuccess: (List<RCIMIWConversationTagInfo>? tags) {
      if (tags != null) {
        print('Successfully retrieved tags for conversation.');
        // Process the list of tags
        tags.forEach((tagInfo) {
          print('Tag ID: ${tagInfo.tagInfo?.tagId}, Pinned: ${tagInfo.isTop}');
        });
      } else {
        print('No tags found for the conversation.');
      }
    },
    onError: (int? code) {
      print('Failed to retrieve tags for conversation. Error code: $code');
    }
  );

  int? ret = await engine?.getTagsFromConversation(type, targetId, callback: callback);
  if (ret != 0) {
    print('API call to get tags from conversation failed. Error code: $ret');
  }
}
```

### Response
#### Success Response (200)
- **code** (int) - Status code indicating the result of the operation. 0 for success, non-zero for failure.
- **tags** (List<RCIMIWConversationTagInfo>) - A list of conversation tag information objects, including tag details and pinning status.
```

--------------------------------

### Listen for Subscription Events

Source: https://docs.rongcloud.cn/flutter-imlib/user/user_profiles

Sets up listeners for various subscription-related events, recommended to be set before connection.

```APIDOC
## Event Listeners

### Description
Sets up listeners for various subscription-related events. It is recommended to configure these listeners before establishing a connection. The `userProfile` type indicates user profile subscription events.

### Parameters/Properties
- **onEventChange** (Function(List<RCIMIWSubscribeInfoEvent>? subscribeEvents)) - Callback triggered when subscription events change.
- **onSubscriptionSyncCompleted** (Function(RCIMIWSubscribeType? type)) - Callback triggered when subscription data synchronization is completed.
- **onSubscriptionChangedOnOtherDevices** (Function(List<RCIMIWSubscribeEvent>? subscribeEvents)) - Callback triggered when subscription information changes on other devices.

:::tip
Currently supported subscription types:
- Online Status: `onlineStatus(1)`
- User Profile Management: `userProfile(2)`
:::

### Code Example
```dart
engine.onEventChange = (List<RCIMIWSubscribeInfoEvent>? subscribeEvents) {
  // Handle user profile changes
};

engine.onSubscriptionSyncCompleted = (RCIMIWSubscribeType? type) {
  // Handle subscription data sync completion
};

engine.onSubscriptionChangedOnOtherDevices = (
  List<RCIMIWSubscribeEvent>? subscribeEvents,
) {
  // Handle subscription info changes on other devices
};
```
```

--------------------------------

### RongIMClient Initialization and Connection

Source: https://docs.rongcloud.cn/flutter-imlib/migrate-api-quick-reference

Core methods for initializing the RongCloud IM client, configuring server information, and managing the connection lifecycle.

```APIDOC
## RongIMClient Lifecycle Management

### Description
Methods to initialize the SDK, set server configurations, and connect/disconnect from the RongCloud IM service.

### Methods
- **init**: [RongIMClient/init](https://pub.dev/documentation/rongcloud_im_plugin/latest/rongcloud_im_plugin/RongIMClient/init.html)
- **connect**: [RongIMClient/connect](https://pub.dev/documentation/rongcloud_im_plugin/latest/rongcloud_im_plugin/RongIMClient/connect.html)
- **disconnect**: [RongIMClient/disconnect](https://pub.dev/documentation/rongcloud_im_plugin/latest/rongcloud_im_plugin/RongIMClient/disconnect.html)
- **setServerInfo**: [RongIMClient/setServerInfo](https://pub.dev/documentation/rongcloud_im_plugin/latest/rongcloud_im_plugin/RongIMClient/setServerInfo.html)
```

--------------------------------

### Get Conversation Do Not Disturb Status

Source: https://docs.rongcloud.cn/flutter-imlib/conversation/do-not-disturb-by-target-id

Retrieves the current Do Not Disturb level set for a specific conversation.

```APIDOC
## GET /api/conversations/notification/level

### Description
Retrieves the current Do Not Disturb level set for a specific conversation.

### Method
GET

### Endpoint
/api/conversations/notification/level

### Parameters
#### Query Parameters
- **type** (RCIMIWConversationType) - Required - The type of conversation. Special considerations apply to super groups and chat rooms.
- **targetId** (String) - Required - The conversation ID or super group ID.
- **channelId** (String) - Optional - The channel ID for super groups. If not specified, it applies to all super group messages. For older super group implementations, an empty string might be required for messages not belonging to any channel.
- **callback** (IRCIMIWGetConversationNotificationLevelCallback) - Optional - Callback for handling the result of the operation.

### Request Example
```dart
// Assuming 'engine' is an instance of your IM client
int? ret = await engine?.getConversationNotificationLevel(type, targetId, channelId, callback: IRCIMIWGetConversationNotificationLevelCallback(
  onSuccess: (RCIMIWPushNotificationLevel? level) => print("Do Not Disturb Level: $level"),
  onError: (int? code) => print("Error getting level: $code")
));
```

### Response
#### Success Response (200)
- **level** (RCIMIWPushNotificationLevel) - The Do Not Disturb level for the conversation.

#### Response Example
```json
{
  "level": "RCIMIWPushNotificationLevel.blocked"
}
```
```

--------------------------------

### GET /getMessages

Source: https://docs.rongcloud.cn/flutter-imlib/ultragroup/get-history-message

Retrieves historical messages, prioritizing local storage and syncing missing parts from the server.

```APIDOC
## GET /getMessages

### Description
Retrieves historical messages. The SDK first attempts to fetch from local storage, syncing missing parts from the server if necessary. When no more local messages exist, it fetches from the server.

### Method
GET

### Parameters
#### Request Body
- **type** (RCIMIWConversationType) - Required - Conversation type
- **targetId** (String) - Required - Target ID
- **channelId** (String) - Optional - Channel ID
- **sentTime** (int) - Required - Reference time for message retrieval
- **order** (RCIMIWTimeOrder) - Required - Time order for retrieval
- **policy** (RCIMIWMessageOperationPolicy) - Required - Operation policy
- **count** (int) - Required - Number of messages to retrieve
- **callback** (IRCIMIWGetMessagesCallback) - Optional - Result callback

### Response
#### Success Response (200)
- **result** (Future<int>) - Status code of the operation (0 for success)
```

--------------------------------

### Set Up Chatroom Event Listeners in Dart

Source: https://docs.rongcloud.cn/flutter-imlib/chatroom/monitor-events

Set up listeners for multi-device login sync, member block, and member ban events directly on the RCIMIWEngine instance. Ensure you have created and saved your engine instance. To stop listening, set the callbacks to null.

```dart
RCIMIWEngine? engine = yourEngineInstance; // Replace with your engine instance

// Multi-device login chatroom sync event callback
engine?.onChatRoomNotifyMultiLoginSync = (RCIMIWChatRoomSyncEvent? event) {
  // Handle multi-device login sync events
  if (event != null) {
    print('Chatroom multi-device sync event: chatroomId=${event.chatroomId}, status=${event.status}, reason=${event.reason}');
  }
};

// Chatroom member block/unblock event callback
engine?.onChatRoomNotifyBlock = (RCIMIWChatRoomMemberBlockEvent? event) {
  // Handle chatroom member block/unblock events
  if (event != null) {
    print('Chatroom member block event: chatroomId=${event.chatroomId}, type=${event.operateType}');
  }
};

// Chatroom member mute/unmute event callback
engine?.onChatRoomNotifyBan = (RCIMIWChatRoomMemberBanEvent? event) {
  // Handle chatroom member mute/unmute events
  if (event != null) {
    print('Chatroom member mute event: chatroomId=${event.chatroomId}, banType=${event.banType}');
  }
};

// If no longer needed, set callbacks to null
// engine?.onChatRoomNotifyMultiLoginSync = null;
// engine?.onChatRoomNotifyBlock = null;
// engine?.onChatRoomNotifyBan = null;
```

--------------------------------

### Configure Compression Strategy

Source: https://docs.rongcloud.cn/flutter-imlib/engine_config

Define compression settings for sending images and short videos, including quality, maximum size, and dimensions for original images and thumbnails. Also includes parameters for short video compression.

```dart
RCIMIWEngineOptions options = RCIMIWEngineOptions.create();
RCIMIWCompressOptions compressOptions = RCIMIWCompressOptions.create(
  originalImageQuality: 80,
  originalImageMaxSize: 1080,
  originalImageSize: 200,
  thumbnailQuality: 80,
  thumbnailMaxSize: 500,
  thumbnailMinSize: 200,
  sightCompressHeight: 160,
  sightCompressWidth: 160,
);
options.compressOptions = compressOptions;
```

--------------------------------

### Get Message Read Receipt by Users

Source: https://docs.rongcloud.cn/flutter-imlib/message/read-receipt-v5

Queries the read status of a specific message for a list of users.

```APIDOC
## GET /messages/readReceipt/users

### Description
Queries the read status of a specific message for a given list of users. This is typically called by the message sender.

### Method
GET

### Endpoint
/messages/readReceipt/users

### Parameters
#### Path Parameters
- **type** (RCIMIWConversationType) - Required - The type of the conversation.
- **targetId** (String) - Required - The target ID of the conversation.
- **channelId** (String?) - Optional - The channel ID of the conversation.
- **messageUId** (String) - Required - The unique identifier of the message.

#### Query Parameters
- **userIds** (List<String>) - Required - A list of user IDs (up to 100) for whom to check the read status.

### Request Example
```dart
await engine.getMessagesReadReceiptByUsersV5(
  RCIMIWConversationType.group,
  "groupId",
  null,
  "messageUId1",
  ["user1", "user2"],
  callback: IRCIMIWGetMessagesReadReceiptByUsersV5Callback(
    onSuccess: (result) {},
    onError: (code) {},
  ),
);
```

### Response
#### Success Response (200)
- **result** (RCIMIWReadReceiptUsersResult?) - The result containing the read status for the queried users.
  - **users** (List<RCIMIWReadReceiptUser>?) - A list of users and their read status for the message.
    - **userId** (String?) - The user ID.
    - **timestamp** (int?) - The timestamp (in milliseconds) when the user read the message. If the user has not read the message, this might be null or indicate an unread status.

*Note: `pageToken` and `totalCount` are not applicable for this endpoint and can be ignored.*

#### Response Example
```json
{
  "users": [
    {
      "userId": "user1",
      "timestamp": 1678886400000
    },
    {
      "userId": "user2",
      "timestamp": null
    }
  ]
}
```
```

--------------------------------

### Get Friend Information by User IDs

Source: https://docs.rongcloud.cn/flutter-imlib/user/friend_manager

Retrieves detailed information for a list of friends specified by their user IDs.

```APIDOC
## GET /api/friends/info/batch

### Description
Retrieves detailed information for a list of friends specified by their user IDs. The maximum number of user IDs that can be queried at once is 100.

### Method
GET

### Endpoint
`/api/friends/info/batch`

### Parameters
#### Query Parameters
- **userIds** (List<String>) - Required - A list of user IDs for the friends to query. Maximum 100 IDs.
- **callback** (IRCIMIWGetFriendsInfoCallback?) - Optional - Callback for handling the response, returning `List<RCIMIWFriendInfo>` on success or an error code.

### Request Example
```dart
await IMEngineManager().engine?.getFriendsInfo(
  <String>['user1', 'user2'],
  callback: IRCIMIWGetFriendsInfoCallback(
    onSuccess: (List<RCIMIWFriendInfo>? infos) => debugPrint('infos => ${infos?.map((e) => e.toJson())}'),
    onError: (int? code) => debugPrint('getFriendsInfo failed => $code'),
  ),
);
```

### Response
#### Success Response (200)
- **infos** (List<RCIMIWFriendInfo>) - A list of friend information objects for the requested user IDs.

#### Response Example
```json
{
  "infos": [
    {
      "userId": "user1",
      "remark": "Friend Remark 1",
      "extFields": {}
    },
    {
      "userId": "user2",
      "remark": "Friend Remark 2",
      "extFields": {}
    }
  ]
}
```
```

--------------------------------

### 获取本地超级群频道列表

Source: https://docs.rongcloud.cn/flutter-imlib/ultragroup/get-channel-list

使用客户端 SDK 获取指定超级群下所有频道的会话列表。此方法会从本地数据库检索，并按时间倒序排列。仅当 SDK 收到过频道消息时，该频道才会出现在列表中。

```dart
IRCIMIWGetConversationsForAllChannelCallback? callback = IRCIMIWGetConversationsForAllChannelCallback(
  onSuccess: (List<RCIMIWConversation>? t) {
    //... 
  },
  onError: (int? code) {
    //...
  }
);

int? ret = await engine?.getConversationsForAllChannel(type, targetId, callback:callback);
```

--------------------------------

### 设置会话置顶状态

Source: https://docs.rongcloud.cn/flutter-imlib/conversation/conversationTop

调用此方法设置指定会话的置顶状态。状态会同步到服务端，并可通过回调获取操作结果。SDK 从 5.3.1 版本开始支持 callback 方式回调。

```dart
IRCIMIWChangeConversationTopStatusCallback? callback = IRCIMIWChangeConversationTopStatusCallback(
  onConversationTopStatusChanged: (int? code) {
    //... 
  },
);

int? ret = await engine?.changeConversationTopStatus(type, targetId, channelId, top, callback:callback);
```

--------------------------------

### Get Friend List

Source: https://docs.rongcloud.cn/flutter-imlib/user/friend_manager

Retrieves the friend list based on the specified friend type. Currently, only 'both' is supported.

```APIDOC
## GET /api/friends

### Description
Retrieves the friend list. Currently, only `RCIMIWFriendType.both` is supported for querying friends in both directions.

### Method
GET

### Endpoint
`/api/friends`

### Parameters
#### Query Parameters
- **friendType** (RCIMIWFriendType) - Required - Specifies the direction of friends to query. Only `both` is supported.
- **callback** (IRCIMIWGetFriendsCallback?) - Optional - Callback for handling the response, returning `List<RCIMIWFriendInfo>` on success or an error code.

### Request Example
```dart
await IMEngineManager().engine?.getFriends(
  RCIMIWFriendType.both,
  callback: IRCIMIWGetFriendsCallback(
    onSuccess: (List<RCIMIWFriendInfo>? infos) => debugPrint('friend count=${infos?.length ?? 0}'),
    onError: (int? code) => debugPrint('getFriends failed => $code'),
  ),
);
```

### Response
#### Success Response (200)
- **infos** (List<RCIMIWFriendInfo>) - A list of friend information objects.

#### Response Example
```json
{
  "infos": [
    {
      "userId": "user1",
      "remark": "Friend Remark",
      "extFields": {
        "custom_key": "custom_value"
      }
    }
  ]
}
```
```

--------------------------------

### Get Friend Applications

Source: https://docs.rongcloud.cn/flutter-imlib/user/friend_manager

Retrieves a paginated list of friend requests. Server retains data for 7 days.

```dart
getFriendApplications(
  List<RCIMIWFriendApplicationType> applicationTypes,
  List<RCIMIWFriendApplicationStatus> status,
  RCIMIWPagingQueryOption queryOption,
  {IRCIMIWGetFriendApplicationsCallback? callback}
)
```

```dart
final RCIMIWPagingQueryOption option = RCIMIWPagingQueryOption.create(
  pageToken: '',
  count: 20,
  order: false,
);

final IRCIMIWGetFriendApplicationsCallback callback = IRCIMIWGetFriendApplicationsCallback(
  onSuccess: (RCIMIWPagingQueryResult<RCIMIWFriendApplicationInfo>? page) {
    debugPrint('getFriendApplications => ${page?.records.length}');
    final String? nextPageToken = page?.pageToken;
    // 根据 pageToken 再次调用以继续拉取
  },
  onError: (int? code) => debugPrint('getFriendApplications failed => $code'),
);

await IMEngineManager().engine?.getFriendApplications(
  <RCIMIWFriendApplicationType>[RCIMIWFriendApplicationType.sent, RCIMIWFriendApplicationType.received],
  <RCIMIWFriendApplicationStatus>[
    RCIMIWFriendApplicationStatus.unhandled,
    RCIMIWFriendApplicationStatus.accepted,
    RCIMIWFriendApplicationStatus.refused,
  ],
  option,
  callback: callback,
);
```

--------------------------------

### Connect to IM Server

Source: https://docs.rongcloud.cn/flutter-imlib/connection/connect

Initiates a connection to the RongCloud IM server. Ensure you have obtained a valid token from your server and have initialized the SDK. The callback parameter is used for receiving connection events.

```dart
RCIMIWConnectCallback? callback = RCIMIWConnectCallback(
  onDatabaseOpened: (int? code) {
    //...
  },
  onConnected: (int? code, String? userId) {
    //...
  }
);

int? ret = await engine?.connect(token, timeout, callback);
```

--------------------------------

### joinChatRoom

Source: https://docs.rongcloud.cn/flutter-imlib/chatroom/join

加入聊天室接口，支持指定拉取消息数量及自动创建聊天室配置。

```APIDOC
## joinChatRoom

### Description
加入聊天室。默认同一用户不能同时加入多个聊天室，加入新的聊天室后，会自动退出之前的聊天室。如需支持单个用户加入多个聊天室，请在控制台打开该配置。

### Method
Future<int> joinChatRoom(String targetId, int messageCount, bool autoCreate, {IRCIMIWJoinChatRoomCallback? callback})

### Parameters
#### Path Parameters
- **targetId** (String) - Required - 聊天室会话 ID
- **messageCount** (int) - Required - 进入聊天室拉取消息数目，-1 时不拉取任何消息，0 时拉取 10 条消息，最多只能拉取 50
- **autoCreate** (bool) - Required - 是否创建聊天室，TRUE 如果聊天室不存在，sdk 会创建聊天室并加入，如果已存在，则直接加入
- **callback** (IRCIMIWJoinChatRoomCallback) - Optional - 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。

### Response
#### Success Response (0)
- **Future<int>** - 当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败。

### Request Example
```dart
IRCIMIWJoinChatRoomCallback? callback = IRCIMIWJoinChatRoomCallback(
onChatRoomJoined: (int? code, String? targetId) {
//...
});

int? ret = await engine?.joinChatRoom(targetId, messageCount, autoCreate, callback:callback);
```
```

--------------------------------

### Get Unread Count by Tag

Source: https://docs.rongcloud.cn/flutter-imlib/conversation/tag

Retrieves the total unread message count for all conversations associated with a specific tag.

```APIDOC
## GET /api/conversations/tag/unreadCount

### Description
Retrieves the total unread message count for all conversations that have the specified tag.

### Method
GET

### Endpoint
/api/conversations/tag/unreadCount

### Parameters
#### Path Parameters
None

#### Query Parameters
- **tagId** (String) - Required - The unique identifier for the tag.
- **contain** (Boolean) - Required - Whether to include conversations with Do Not Disturb enabled.
- **callback** (IRCIMIWGetUnreadCountCallback) - Optional - Callback for the operation result.

### Request Example
```dart
IRCIMIWGetUnreadCountCallback? callback = IRCIMIWGetUnreadCountCallback(
  onSuccess: (int? t) {
    //...
  },
  onError: (int? code) {
    //...
  }
);

int? ret = await engine?.getUnreadCountByTag(tagId, contain, callback:callback);
```

### Response
#### Success Response (200)
- **unreadCount** (Integer) - The total number of unread messages for conversations with the specified tag.
- **code** (int) - Status code indicating the result of the operation. 0 for success.

#### Response Example
```json
{
  "unreadCount": 15,
  "code": 0
}
```
```

--------------------------------

### Get Friend Applications

Source: https://docs.rongcloud.cn/flutter-imlib/user/friend_manager

Retrieves a paginated list of friend application requests, allowing filtering by application type and status.

```APIDOC
## GET /api/friend-applications

### Description
Retrieves a paginated list of friend application requests.

### Method
GET

### Endpoint
/api/friend-applications

### Parameters
#### Path Parameters
None

#### Query Parameters
- **applicationTypes** (List<RCIMIWFriendApplicationType>) - Required - Types of applications to query (e.g., sent, received).
- **status** (List<RCIMIWFriendApplicationStatus>) - Required - Status of applications to filter by (e.g., unhandled, accepted, refused).
- **queryOption** (RCIMIWPagingQueryOption) - Required - Pagination settings including `pageToken`, `count` (1-100), and `order`.
- **callback** (IRCIMIWGetFriendApplicationsCallback?) - Optional - Callback that returns `RCIMIWPagingQueryResult<RCIMIWFriendApplicationInfo>`.

:::tip
Friend requests are valid for 7 days. The server stores data for the last 7 days. For pagination, leave `pageToken` empty for the first page. Use the `pageToken` from the previous response for subsequent pages. An empty string for `pageToken` indicates no more data.
:::

### Request Example
```dart
final RCIMIWPagingQueryOption option = RCIMIWPagingQueryOption.create(
  pageToken: '',
  count: 20,
  order: false,
);

final IRCIMIWGetFriendApplicationsCallback callback = IRCIMIWGetFriendApplicationsCallback(
  onSuccess: (RCIMIWPagingQueryResult<RCIMIWFriendApplicationInfo>? page) {
    debugPrint('getFriendApplications => ${page?.records.length}');
    final String? nextPageToken = page?.pageToken;
    // Call again with nextPageToken to fetch more data
  },
  onError: (int? code) => debugPrint('getFriendApplications failed => $code'),
);

await IMEngineManager().engine?.getFriendApplications(
  <RCIMIWFriendApplicationType>[RCIMIWFriendApplicationType.sent, RCIMIWFriendApplicationType.received],
  <RCIMIWFriendApplicationStatus>[
    RCIMIWFriendApplicationStatus.unhandled,
    RCIMIWFriendApplicationStatus.accepted,
    RCIMIWFriendApplicationStatus.refused,
  ],
  option,
  callback: callback,
);
```

### Response
#### Success Response (200)
- **records** (List<RCIMIWFriendApplicationInfo>) - A list of friend application details.
- **pageToken** (String?) - Token for the next page of results. Empty string if no more data.

#### Response Example
```json
{
  "records": [
    {
      "userId": "user1",
      "status": "unhandled",
      "direction": "received"
    }
  ],
  "pageToken": "next_page_token"
}
```
```

--------------------------------

### 获取会话列表接口定义

Source: https://docs.rongcloud.cn/flutter-imlib/conversation/get

分页获取 SDK 在本地数据库生成的会话列表。

```dart
Future<int> getConversations(List<RCIMIWConversationType> conversationTypes, String? channelId, int startTime, int count, {IRCIMIWGetConversationsCallback? callback});
```

--------------------------------

### 获取置顶会话列表

Source: https://docs.rongcloud.cn/flutter-imlib/conversation/conversationTop

获取指定会话类型集合中的所有置顶会话。回调函数用于处理成功获取列表或失败的情况。SDK 从 5.3.1 版本开始支持 callback 方式回调。

```dart
IRCIMIWGetTopConversationsCallback? callback = IRCIMIWGetTopConversationsCallback(
  onSuccess: (List<RCIMIWConversation>? t) {
    //...
  },
  onError: (int? code) {
    //...
  },
);

int? ret = await engine?.getTopConversations(conversationTypesInt, channelId, callback:callback);
```

--------------------------------

### Get Message Read Receipt Info by Identifiers

Source: https://docs.rongcloud.cn/flutter-imlib/message/read-receipt-v5

Retrieves read receipt information for multiple messages using their identifiers.

```APIDOC
## GET /messages/readReceiptInfo/identifiers

### Description
Retrieves read receipt information for multiple messages specified by their unique identifiers.

### Method
GET

### Endpoint
/messages/readReceiptInfo/identifiers

### Parameters
#### Query Parameters
- **identifiers** (List<RCIMIWMessageIdentifier>) - Required - A list of message identifiers for which to retrieve read receipt information.

### Request Example
```dart
final identifiers = <RCIMIWMessageIdentifier>[
  RCIMIWMessageIdentifier.create(
    conversationType: RCIMIWConversationType.private,
    targetId: "targetId1",
    channelId: null,
    messageUId: "messageUId1",
  ),
  RCIMIWMessageIdentifier.create(
    conversationType: RCIMIWConversationType.group,
    targetId: "groupId1",
    channelId: null,
    messageUId: "messageUId2",
  ),
];

await engine.getMessageReadReceiptInfoV5ByIdentifiers(
  identifiers,
  callback: IRCIMIWGetMessageReadReceiptInfoV5Callback(
    onSuccess: (infos) {},
    onError: (code) {},
  ),
);
```

### Response
#### Success Response (200)
- **infos** (Map<String, RCIMIWMessageReadReceiptInfo>) - A map where keys are message UIDs and values are RCIMIWMessageReadReceiptInfo objects containing read receipt details.

#### Response Example
```json
{
  "messageUId1": {
    "readCount": 10,
    "unreadCount": 5
  },
  "messageUId2": {
    "readCount": 20,
    "unreadCount": 0
  }
}
```
```

--------------------------------

### iOSPushOptions Configuration

Source: https://docs.rongcloud.cn/flutter-imlib/push/msg-pushconfig

Defines the structure and parameters for the iOSPushOptions object.

```APIDOC
## iOSPushOptions

### Description
Configuration object for iOS-specific push notification settings.

### Parameters
- **threadId** (String) - Optional - Notification grouping ID.
- **category** (String) - Optional - iOS rich media push category.
- **apnsCollapseId** (String) - Optional - Notification collapse ID.
- **richMediaUri** (String) - Optional - URL for rich media push content.
```

--------------------------------

### Get Unread Count for Specific Conversation

Source: https://docs.rongcloud.cn/flutter-imlib/conversation/unread

Retrieves the unread message count for a specific conversation (excluding chat rooms).

```APIDOC
## GET /getUnreadCount

### Description
Retrieves the unread message count for a specific conversation (excluding chat rooms).

### Method
GET

### Endpoint
`/getUnreadCount`

### Parameters
#### Query Parameters
- **type** (RCIMIWConversationType) - Required - Conversation type.
- **targetId** (String) - Required - Conversation ID.
- **channelId** (String) - Optional - Channel ID, only supported for super groups, pass null for other conversation types.
- **callback** (IRCIMIWGetUnreadCountCallback) - Optional - Callback for retrieving unread count events for a specific conversation. Supported from SDK version 5.3.1. If a callback is provided, only the callback will be triggered.

### Response
#### Success Response (200)
- **Future<int>** - Returns 0 for successful operation, actual results via callback. Non-zero indicates an operation failure.

### Request Example
```dart
IRCIMIWGetUnreadCountCallback? callback = IRCIMIWGetUnreadCountCallback(
  onSuccess: (int? t) {
    // ...
  },
  onError: (int? code) {
    // ...
  }
);

int? ret = await engine?.getUnreadCount(type, targetId, channelId, callback: callback);
```
```

--------------------------------

### Getting Message Read Information (Batch V5)

Source: https://docs.rongcloud.cn/flutter-imlib/message/read-receipt-v5

The message sender can call `getMessageReadReceiptInfoV5` to batch query message read statistics.

```APIDOC
## Getting Message Read Information (Batch V5)

### Description
The message sender can call `getMessageReadReceiptInfoV5` to batch query message read statistics.

### Method
`Future<int> getMessageReadReceiptInfoV5(...)`

### Parameters
#### Path Parameters
- **`type`** (RCIMIWConversationType) - Required - Conversation type.
- **`targetId`** (String) - Required - Target ID of the conversation.
- **`channelId`** (String?) - Optional - Channel ID.
- **`messageUIds`** (List<String>) - Required - List of message UIDs to query, up to 100 messages.
- **`callback`** (IRCIMIWGetMessageReadReceiptInfoV5Callback) - Optional - Result callback (`onSuccess` returns `List<RCIMIWReadReceiptInfoV5>?`).

### Result Object Description (`RCIMIWReadReceiptInfoV5`)
- **`messageUId`** (String?) - Message UID.
- **`readCount`** (int?) - Number of read messages.
- **`unreadCount`** (int?) - Number of unread messages.
- **`totalCount`** (int?) - Total number of users.

### Request Example
```dart
await engine.getMessageReadReceiptInfoV5(
  RCIMIWConversationType.group,
  "groupId",
  null,
  ["messageUId1", "messageUId2"],
  callback: IRCIMIWGetMessageReadReceiptInfoV5Callback(
    onSuccess: (infos) {},
    onError: (code) {},
  ),
);
```
```

--------------------------------

### connect

Source: https://docs.rongcloud.cn/flutter-imlib/connection/connect

Initiates a connection to the RongCloud IM server using a valid authentication token.

```APIDOC
## connect

### Description
Initiates a connection to the RongCloud IM server. This should be called after SDK initialization and setting up connection listeners.

### Method
Dart Method

### Parameters
#### Path Parameters
- **token** (String) - Required - The authentication token obtained from your server API.
- **timeout** (int) - Required - Connection timeout duration in seconds.
- **callback** (RCIMIWConnectCallback) - Optional - Connection event callback.

### Response
- **Future<int>** - Returns the status code of the operation. 0 indicates success, non-zero indicates failure.

### Request Example
```dart
RCIMIWConnectCallback? callback = RCIMIWConnectCallback(
  onDatabaseOpened: (int? code) {},
  onConnected: (int? code, String? userId) {}
);

int? ret = await engine?.connect(token, timeout, callback);
```
```

--------------------------------

### 接收已读回执回调

Source: https://docs.rongcloud.cn/flutter-imlib/message/read-receipt-v5

消息发送方可通过监听 `onMessageReadReceiptV5Received` 接收已读回执响应。监听器应在 SDK 初始化完成后、连接成功前注册。

```dart
// 监听远端会话列表同步完成
engine.onMessageReadReceiptV5Received = (responses) {
  // 处理回执响应
};
```

--------------------------------

### Get Paginated Group Applications

Source: https://docs.rongcloud.cn/flutter-imlib/group/join-group

Retrieve a list of group applications using pagination. Note that data is only stored for 7 days.

```dart
// 分页拉取参数（设置null与设置""，效果等同）
String pageToken = "";

Future<void> getGroupApplications(String pageToken) async {
  // 分页请求参数
  RCIMIWPagingQueryOption option = RCIMIWPagingQueryOption.create(
    count: 20,  // 设置分页大小，取值范围为 [1~100]
    pageToken: pageToken,  // 分页拉取参数
    order: false,  // 按操作时间正序、倒序获取。true：正序；false：倒序
  );
  
  // 查询发出的申请 + 收到的申请类型的请求
  List<RCIMIWGroupApplicationDirection> directions = [
    RCIMIWGroupApplicationDirection.applicationSent,
    RCIMIWGroupApplicationDirection.applicationReceived
  ];
  
  // 查询管理员待处理 + 管理员拒绝 + 已加入类型的申请
  List<RCIMIWGroupApplicationStatus> status = [
    RCIMIWGroupApplicationStatus.managerUnHandled,
    RCIMIWGroupApplicationStatus.managerRefused,
    RCIMIWGroupApplicationStatus.joined
  ];
  
  // 创建回调
  IRCIMIWGetGroupApplicationsCallback callback = IRCIMIWGetGroupApplicationsCallback(
    onSuccess: (RCIMIWPagingQueryResult<RCIMIWGroupApplicationInfo>? result) {
      if (result != null && result.pageToken.isNotEmpty) {
        // 使用返回的 pageToken 拉取下一页
        getGroupApplications(result.pageToken);
      } else {
        // 拉取结束
        print("群申请列表拉取完成");
      }
    },
    onError: (RCIMIWCoreErrorCode? code) {
      // 拉取失败
      print("拉取失败，code: $code");
    },
  );
  
  // 调用分页获取群申请列表方法
  int? code = await engine?.getGroupApplications(
    option,
    directions,
    status,
    callback: callback,
  );
} 
```

--------------------------------

### Get Total Unread Count

Source: https://docs.rongcloud.cn/flutter-imlib/conversation/unread

Retrieves the total number of unread messages across all conversation types (excluding chat rooms).

```APIDOC
## GET /getTotalUnreadCount

### Description
Retrieves the total number of unread messages across all conversation types (excluding chat rooms).

### Method
GET

### Endpoint
`/getTotalUnreadCount`

### Parameters
#### Query Parameters
- **channelId** (String) - Optional - Channel ID, only supported for super groups, pass null for other conversation types.
- **callback** (IRCIMIWGetTotalUnreadCountCallback) - Optional - Callback for retrieving total unread count events. Supported from SDK version 5.3.1. If a callback is provided, only the callback will be triggered.

### Response
#### Success Response (200)
- **Future<int>** - Returns 0 for successful operation, actual results via callback. Non-zero indicates an operation failure.

### Request Example
```dart
IRCIMIWGetTotalUnreadCountCallback? callback = IRCIMIWGetTotalUnreadCountCallback(
  onSuccess: (int? t) {
    // ...
  },
  onError: (int? code) {
    // ...
  }
);

int? ret = await engine?.getTotalUnreadCount(channelId, callback: callback);
```
```
Tokens:
Raw