API参考
初始化
初始化SDK
Future<dynamic> initSDK({
required String sdkServer,
required String dataDir,
required OnConnectListener listener,
int logLevel = 6,
bool isCompression = false,
bool isLogStandardOutput = false,
String? logFilePath,
bool skipVerifyCert = false,
String? operationID,
});
-
返回值:
Future<dynamic>初始化结果 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| sdkServer | String | 是 | SDK 服务器地址 |
| dataDir | String | 是 | 客户端数据存放目录 |
| listener | OnConnectListener | 是 | 连接状态监听器 |
| logLevel | int | 否 | 日志级别,默认 6 |
| isCompression | bool | 否 | 是否开启压缩,默认 false |
| isLogStandardOutput | bool | 否 | 是否将日志打印到控制台,默认 false |
| logFilePath | String? | 否 | 本地日志文件路径 |
| skipVerifyCert | bool | 否 | 是否跳过 HTTPS 证书校验 |
| operationID | String? | 否 | 操作 ID,用于问题追踪 |
反初始化SDK
Future<dynamic> unInitSDK();
- 返回值:无
登录
登录
Future<UserInfo> login({
required String appID,
required String appSecret,
required String token,
required String userID,
String? operationID,
});
-
返回值:
Future<UserInfo>登录用户信息 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| appID | String | 是 | APP ID,可在管理后台【项目管理】获取 |
| appSecret | String | 是 | APP Secret,可在管理后台获取 |
| token | String | 是 | token 生成器返回的 token |
| userID | String | 是 | 用户 ID,来自于自身业务服务器 |
| operationID | String? | 否 | 操作 ID |
获取登录状态
Future<int?> getLoginStatus({String? operationID});
- 返回值:
Future<int?>登录状态:1 未登录,2 登录中,3 已登录
登出
Future<dynamic> logout({String? operationID});
- 返回值:
Future<dynamic>
获取当前已登录用户的userID
Future<String> getLoginUserID();
- 返回值:
Future<String>登录用户的 userID
获取当前登录用户信息
Future<UserInfo> getLoginUserInfo();
- 返回值:
Future<UserInfo>当前登录用户信息
用户
根据userID批量查询用户信息
Future<List<UserInfo>> getUsersInfo({
required List<String> userIDList,
String? operationID,
});
-
返回值:
Future<List<UserInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userIDList | List<String> | 是 | 用户 ID 列表 |
| operationID | String? | 否 | 操作 ID |
修改当前登录用户信息
Future<String?> setSelfInfo({
String? nickname,
String? faceURL,
int? appManagerLevel,
String? ex,
String? operationID,
});
-
返回值:
Future<String?> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| nickname | String? | 否 | 昵称 |
| faceURL | String? | 否 | 头像 URL |
| appManagerLevel | int? | 否 | 应用管理级别 |
| ex | String? | 否 | 扩展信息 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
获取当前登录用户信息
Future<UserInfo> getSelfUserInfo({String? operationID});
- 返回值:
Future<UserInfo>
订阅指定用户的在线状态
调用订阅用户的在线状态接口,可以订阅用户的在线状态,触发订阅者的 userStatusChanged 回调。
Future<List<UserStatusInfo>> subscribeUsersStatus(
List<String> userIDs, {
String? operationID,
});
-
返回值:
Future<List<UserStatusInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userIDs | List<String> | 是 | 用户 ID 列表 |
| operationID | String? | 否 | 操作 ID |
取消订阅用户的在线状态
Future unsubscribeUsersStatus(
List<String> userIDs, {
String? operationID,
});
-
返回值:
Future -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userIDs | List<String> | 是 | 用户 ID 列表 |
| operationID | String? | 否 | 操作 ID |
获取所有已订阅用户的在线状态
Future<List<UserStatusInfo>> getSubscribeUsersStatus({String? operationID});
- 返回值:
Future<List<UserStatusInfo>>
获取指定用户的在线状态
Future<List<UserStatusInfo>> getUserStatus(
List<String> userIDs, {
String? operationID,
});
-
返回值:
Future<List<UserStatusInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userIDs | List<String> | 是 | 用户 ID 列表 |
| operationID | String? | 否 | 操作 ID |
会话
获取会话列表
Future<List<ConversationInfo>> getAllConversationList({String? operationID});
- 返回值:
Future<List<ConversationInfo>>
分页获取会话列表
Future<List<ConversationInfo>> getConversationListSplit({
int offset = 0,
int count = 20,
String? operationID,
});
-
返回值:
Future<List<ConversationInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| offset | int | 否 | 起始偏移量,默认 0 |
| count | int | 否 | 拉取会话的数量,默认 20 |
| operationID | String? | 否 | 操作 ID |
获取一个会话
如果不存在会自动创建
Future<ConversationInfo> getOneConversation({
required String sourceID,
required int sessionType,
String? operationID,
});
-
返回值:
Future<ConversationInfo> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| sourceID | String | 是 | 单聊为用户 ID,群聊为群 ID |
| sessionType | int | 是 | 会话类型,参考 ConversationType |
| operationID | String? | 否 | 操作 ID |
获取多个会话列表
Future<List<ConversationInfo>> getMultipleConversation({
required List<String> conversationIDList,
String? operationID,
});
-
返回值:
Future<List<ConversationInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationIDList | List<String> | 是 | 会话 ID 列表 |
| operationID | String? | 否 | 操作 ID |
删除一个会话及其所有消息
本地 & 服务器
Future<dynamic> deleteConversationAndDeleteAllMsg({
required String conversationID,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| operationID | String? | 否 | 操作 ID |
清空一个会话的消息
本地 & 服务器,保留会话
Future<dynamic> clearConversationAndDeleteAllMsg({
required String conversationID,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
设置会话的草稿
Future setConversationDraft({
required String conversationID,
required String draftText,
String? operationID,
});
-
返回值:
Future -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| draftText | String | 是 | 草稿文本,如果为 "" 则删除草稿 |
| operationID | String? | 否 | 操作 ID |
置顶会话
Future pinConversation({
required String conversationID,
required bool isPinned,
String? operationID,
});
-
返回值:
Future -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| isPinned | bool | 是 | true 置顶,false 取消置顶 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
获取总的消息未读数
Future<dynamic> getTotalUnreadMsgCount({String? operationID});
- 返回值:
Future<dynamic>未读消息总数
设置会话免打扰状态
Future<dynamic> setConversationRecvMsgOpt({
required String conversationID,
required int status,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| status | int | 是 | 免打扰状态,参考 ReceiveMessageOpt |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
设置私聊(阅后即焚)
Future<dynamic> setConversationPrivateChat({
required String conversationID,
required bool isPrivateChat,
required int burnDuration,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| isPrivateChat | bool | 是 | 是否开启私聊(阅后即焚) |
| burnDuration | int | 是 | 阅后即焚时间间隔(秒) |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
设置会话信息
可一次性设置多个会话属性(免打扰、置顶、阅后即焚等)
Future<void> setConversation({
required String conversationID,
String? userID,
String? groupID,
int? receiveMessageOpt,
int? groupAtType,
bool? isPinned,
bool? isPrivateChat,
int? burnDuration,
String? ex,
String? operationID,
});
- 返回值:
Future<void>
重置at标志位
Future<dynamic> resetConversationGrpAtType({
required String conversationID,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| operationID | String? | 否 | 操作 ID |
隐藏指定会话
不删除聊天记录;如果有新消息到达,会话会再次出现。
Future<dynamic> hideConversation({
required String conversationID,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| operationID | String? | 否 | 操作 ID |
隐藏指定会话
隐藏所有本地会话。不会删除会话及会话内的消息,收到新消息时对应会话隐藏将自动取消。
Future<dynamic> hideAllConversations({
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| operationID | String? | 否 | 操作 ID |
清空未读数
调用标记已读接口,可以把会话内的消息标记为已读,对于群聊和通知会话,调用该接口可以清除未读计数,对于单聊会话,不仅会清除未读计数,还会给消息的发送方发送已读回执,触发发送方的 recv1v1ReadReceipt 回调。
Future markConversationMsgAsRead({
required String conversationID,
String? operationID,
});
-
返回值:
Future -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
标记所有会话消息为已读
Future markAllConversationMsgAsRead({String? operationID});
- 返回值:
Future
获取@所有人标识
Future<dynamic> getAtAllTag({String? operationID});
- 返回值:
Future<dynamic>@所有人的标识字符串
设置会话阅后即焚时长
Future<dynamic> setConversationBurnDuration({
required String conversationID,
int burnDuration = 30,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| burnDuration | int | 否 | 阅后即焚时长(秒),默认 30 |
| operationID | String? | 否 | 操作 ID |
好友
添加好友
Future<dynamic> addFriend({
required String userID,
String? reason,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | String | 是 | 对方 userID |
| reason | String? | 否 | 申请消息 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
获取收到的好友申请
即哪些人申请加我为好友
Future<List<FriendApplicationInfo>> getFriendReqListAsRecipient({
String? operationID,
int? offset,
int? count,
});
-
返回值:
Future<List<FriendApplicationInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| offset | int? | 否 | 起始偏移 |
| count | int? | 否 | 每页数量 |
| operationID | String? | 否 | 操作 ID |
获取发出的好友申请
Future<List<FriendApplicationInfo>> getFriendReqListAsApplicant({
String? operationID,
int? offset,
int? count,
});
-
返回值:
Future<List<FriendApplicationInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| offset | int? | 否 | 起始偏移 |
| count | int? | 否 | 每页数量 |
| operationID | String? | 否 | 操作 ID |
同意某人的好友申请
Future<dynamic> acceptFriendReq({
required String userID,
String? handleMsg,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | String | 是 | 申请者用户 ID |
| handleMsg | String? | 否 | 处理消息 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
拒绝好友申请
Future<dynamic> refuseFriendReq({
required String userID,
String? handleMsg,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | String | 是 | 申请者用户 ID |
| handleMsg | String? | 否 | 处理消息 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
加入黑名单
Future<dynamic> addBlacklist({
required String userID,
String? ex,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | String | 是 | 用户 ID |
| ex | String? | 否 | 扩展信息 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
获取黑名单
Future<List<BlacklistInfo>> getBlacklist({String? operationID});
- 返回值:
Future<List<BlacklistInfo>>
移除黑名单
Future<dynamic> removeBlacklist({
required String userID,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | String | 是 | 用户 ID |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
获取指定好友的相关信息
Future<List<FullUserInfo>> getFriendsInfo({
required List<String> userIDList,
String? operationID,
bool? filterBlack,
});
-
返回值:
Future<List<FullUserInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userIDList | List<String> | 是 | 用户 ID 列表 |
| filterBlack | bool? | 否 | 是否过滤黑名单用户 |
| operationID | String? | 否 | 操作 ID |
获取所有好友的相关信息
Future<List<FriendInfo>> getFriendList({
String? operationID,
bool? filterBlack,
});
-
返回值:
Future<List<FriendInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| filterBlack | bool? | 否 | 是否过滤黑名单用户 |
| operationID | String? | 否 | 操作 ID |
分页获取好友的相关信息
Future<List<FriendInfo>> getFriendListPage({
String? operationID,
int? offset,
int? count,
bool? filterBlack,
});
-
返回值:
Future<List<FriendInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| offset | int? | 否 | 起始偏移 |
| count | int? | 否 | 每页数量 |
| filterBlack | bool? | 否 | 是否过滤黑名单用户 |
| operationID | String? | 否 | 操作 ID |
检查是否好友关系
即是否在登录用户的好友列表中。result 为 1 表示好友(并且不是黑名单)
Future<List<FriendshipInfo>> checkFriend({
required List<String> userIDList,
String? operationID,
});
-
返回值:
Future<List<FriendshipInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userIDList | List<String> | 是 | 用户 ID 列表 |
| operationID | String? | 否 | 操作 ID |
设置好友备注
Future<dynamic> setFriendRemark({
required String friendUserID,
required String remark,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| friendUserID | String | 是 | 好友用户 ID |
| remark | String | 是 | 备注信息 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
更新好友信息
批量更新好友的备注、是否置顶、扩展信息等
Future<dynamic> updateFriends({
required String ownerUserID,
required List<String> friendUserIDs,
String? ex,
String? remark,
bool? isPinned,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| ownerUserID | String | 是 | 本人用户 ID |
| friendUserIDs | List<String> | 是 | 好友用户 ID 列表 |
| ex | String? | 否 | 扩展信息 |
| remark | String? | 否 | 备注 |
| isPinned | bool? | 否 | 是否置顶 |
| operationID | String? | 否 | 操作 ID |
删除好友
好友关系是相互的,删除时将导致双方都互不为好友
Future<dynamic> deleteFriend({
required String userID,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | String | 是 | 好友用户 ID |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
本地搜索好友
Future<List<SearchFriendsInfo>> searchFriends({
List<String>? keywordList,
bool? isSearchUserID,
bool? isSearchNickname,
bool? isSearchRemark,
String? operationID,
});
-
返回值:
Future<List<SearchFriendsInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| keywordList | List<String>? | 否 | 关键词列表 |
| isSearchUserID | bool? | 否 | 是否以关键词搜索 userID |
| isSearchNickname | bool? | 否 | 是否以关键词搜索昵称 |
| isSearchRemark | bool? | 否 | 是否以关键词搜索备注 |
| operationID | String? | 否 | 操作 ID |
群组
创建群
Future<GroupInfo> createGrp({
required GroupInfo groupInfo,
List<String>? memberUserIDs,
List<String>? adminUserIDs,
String? ownerUserID,
String? operationID,
});
-
返回值:
Future<GroupInfo>新建群的群信息 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupInfo | GroupInfo | 是 | 群基础信息 |
| memberUserIDs | List<String>? | 否 | 初始成员 userID 列表 |
| adminUserIDs | List<String>? | 否 | 初始管理员 userID 列表 |
| ownerUserID | String? | 否 | 指定群主 userID(不填则为当前登录用户) |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
申请加入群组
Future<dynamic> joinGrp({
required String groupID,
String? reason,
String? operationID,
int? joinSource,
String? ex,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群组 ID |
| reason | String? | 否 | 进群申请消息 |
| joinSource | int? | 否 | 进群方式,参考 JoinSource |
| ex | String? | 否 | 进群扩展消息 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
退群
Future<dynamic> quitGrp({
required String groupID,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
获取已加入的群列表
Future<List<GroupInfo>> getJoinedGrpList({String? operationID});
- 返回值:
Future<List<GroupInfo>>
获取指定群资料
获取指定群的资料,支持批量获取。
Future<List<GroupInfo>> getGrpsInfo({
required List<String> groupIDList,
String? operationID,
});
-
返回值:
Future<List<GroupInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupIDList | List<String> | 是 | 群 ID 列表 |
| operationID | String? | 否 | 操作 ID |
更新群资料
更新群头像、群名称、群公告、群简介等群资料,仅群主和管理员有权限。
Future<dynamic> setGrpInfo(
GroupInfo groupInfo, {
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupInfo | GroupInfo | 是 | 群信息结构体 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
获取群成员列表
Future<List<GroupMembersInfo>> getGrpMemberList({
required String groupID,
int? filter,
int? offset,
int? count,
String? operationID,
});
-
返回值:
Future<List<GroupMembersInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群组 ID |
| filter | int? | 否 | 过滤成员,参考 GroupMemberFilter |
| offset | int? | 否 | 起始偏移 |
| count | int? | 否 | 成员个数 |
| operationID | String? | 否 | 操作 ID |
获取群内指定群成员信息
获取群内指定的群成员信息,仅本群成员可调用。
Future<List<GroupMembersInfo>> getGrpMembersInfo({
required String groupID,
required List<String> userIDList,
String? operationID,
});
-
返回值:
Future<List<GroupMembersInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群组 ID |
| userIDList | List<String> | 是 | 群成员 userID 列表 |
| operationID | String? | 否 | 操作 ID |
踢出群
Future<List<GroupInviteResult>> kickGrpMember({
required String groupID,
required List<String> userIDList,
String? reason,
String? operationID,
});
-
返回值:
Future<List<GroupInviteResult>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群组 ID |
| userIDList | List<String> | 是 | 被踢出的用户 ID 列表 |
| reason | String? | 否 | 说明 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
转让群主
只有群主能操作
Future<dynamic> transferGrpOwner({
required String groupID,
required String userID,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群组 ID |
| userID | String | 是 | 新群主用户 ID |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
邀请入群
群组成员可邀请其他用户加入群组,无须对方同意,支持批量邀请。
Future<List<GroupInviteResult>> inviteUserToGrp({
required String groupID,
required List<String> userIDList,
String? reason,
String? operationID,
});
-
返回值:
Future<List<GroupInviteResult>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群组 ID |
| userIDList | List<String> | 是 | 被邀请用户 ID 列表 |
| reason | String? | 否 | 邀请说明 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
获取收到的群成员申请进群列表
作为群主或者管理员可操作
Future<List<GroupApplicationInfo>> getGrpReqListAsRecipient({
String? operationID,
List<String>? groupIDs,
List<int>? handleResults,
int? offset,
int? count,
});
-
返回值:
Future<List<GroupApplicationInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupIDs | List<String>? | 否 | 指定群 ID 列表 |
| handleResults | List<int>? | 否 | 处理结果过滤(1 已同意/-1 已拒绝/0 未处理) |
| offset | int? | 否 | 起始偏移 |
| count | int? | 否 | 每页数量 |
| operationID | String? | 否 | 操作 ID |
获取发出的入群申请
Future<List<GroupApplicationInfo>> getGrpReqListAsApplicant({
String? operationID,
List<String>? groupIDs,
List<int>? handleResults,
int? offset,
int? count,
});
-
返回值:
Future<List<GroupApplicationInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupIDs | List<String>? | 否 | 指定群 ID 列表 |
| handleResults | List<int>? | 否 | 处理结果过滤 |
| offset | int? | 否 | 起始偏移 |
| count | int? | 否 | 每页数量 |
| operationID | String? | 否 | 操作 ID |
同意某人进入某群
管理员或者群主操作
Future<dynamic> acceptGrpReq({
required String groupID,
required String userID,
String? handleMsg,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| userID | String | 是 | 申请进群的用户 ID |
| handleMsg | String? | 否 | 处理的消息 |
| operationID | String? | 否 | 操作 ID |
拒绝某人进入某群
管理员或者群主操作
Future<dynamic> refuseGrpReq({
required String groupID,
required String userID,
String? handleMsg,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| userID | String | 是 | 申请进群的用户 ID |
| handleMsg | String? | 否 | 处理的消息 |
| operationID | String? | 否 | 操作 ID |
解散群
Future<dynamic> dismissGrp({
required String groupID,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
禁言群成员
Future<dynamic> changeGrpMemberMute({
required String groupID,
required String userID,
int? seconds,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群组 ID |
| userID | String | 是 | 用户 ID |
| seconds | int? | 否 | 禁言时间(秒),为 0 时取消禁言 |
| operationID | String? | 否 | 操作 ID |
设置群禁言状态
群主或管理员可以设置群禁言状态,禁言后仅群主和管理员可以发言。
Future<dynamic> changeGrpMute({
required String groupID,
required bool mute,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| mute | bool | 是 | 是否禁言 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
搜索群
通过群名称或者群 ID
Future<List<GroupInfo>> searchGrps({
List<String>? keywordList,
bool? isSearchGroupID,
bool? isSearchGroupName,
String? operationID,
});
-
返回值:
Future<List<GroupInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| keywordList | List<String>? | 否 | 关键词列表 |
| isSearchGroupID | bool? | 否 | 是否以关键词搜索群组 ID,默认 false |
| isSearchGroupName | bool? | 否 | 是否以关键词搜索群名字,默认 false |
| operationID | String? | 否 | 操作 ID |
设置群成员昵称
群主可以修改管理员和普通成员的昵称,管理员可以修改普通成员的昵称。
Future<dynamic> setGrpMemberNickname({
required String groupID,
required String userID,
String? groupNickname,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| userID | String | 是 | 用户 ID |
| groupNickname | String? | 否 | 昵称 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
修改群成员身份
群主可以修改管理员和普通成员的身份,管理员可以修改普通成员的身份。
Future<dynamic> setGrpMemberRoleLevel({
required String groupID,
required String userID,
required int roleLevel,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| userID | String | 是 | 用户 ID |
| roleLevel | int | 是 | 成员身份,参考 GroupRoleLevel |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
根据加入时间分页获取群成员列表
Future<List<GroupMembersInfo>> getGrpMemberListByJoinTime({
required String groupID,
int? offset,
int? count,
int? joinTimeBegin,
int? joinTimeEnd,
List<String>? filterUserIDList,
String? operationID,
});
-
返回值:
Future<List<GroupMembersInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| offset | int? | 否 | 起始偏移 |
| count | int? | 否 | 总数 |
| joinTimeBegin | int? | 否 | 加入开始时间(Unix 时间戳秒) |
| joinTimeEnd | int? | 否 | 加入结束时间(Unix 时间戳秒) |
| filterUserIDList | List<String>? | 否 | 过滤的用户 ID 列表 |
| operationID | String? | 否 | 操作 ID |
设置进群验证选项
Future<dynamic> setGrpVerification({
required String groupID,
required int needVerification,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| needVerification | int | 是 | 进群验证设置,参考 GroupVerification |
| operationID | String? | 否 | 操作 ID |
获取群主和管理员
Future<List<GroupMembersInfo>> getGrpOwnerAndAdmin({
required String groupID,
String? operationID,
});
-
返回值:
Future<List<GroupMembersInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| operationID | String? | 否 | 操作 ID |
设置群成员之间是否可添加好友
Future<dynamic> setGrpApplyMemberFriend({
required String groupID,
required int status,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| status | int | 是 | 0:默认可行,1:不可行 |
| operationID | String? | 否 | 操作 ID |
设置能否查看群成员信息
Future<dynamic> setGrpLookMemberInfo({
required String groupID,
required int status,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| status | int | 是 | 0:默认可行,1:不可行 |
| operationID | String? | 否 | 操作 ID |
搜索群成员
Future<List<GroupMembersInfo>> searchGrpMembers({
required String groupID,
List<String>? keywordList,
bool? isSearchUserID,
bool? isSearchMemberNickname,
int? offset,
int? count,
String? operationID,
});
-
返回值:
Future<List<GroupMembersInfo>> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String | 是 | 群 ID |
| keywordList | List<String>? | 否 | 关键词列表 |
| isSearchUserID | bool? | 否 | 是否以关键词搜索用户 ID,默认 false |
| isSearchMemberNickname | bool? | 否 | 是否以关键词搜索昵称,默认 false |
| offset | int? | 否 | 起始偏移 |
| count | int? | 否 | 每页数量 |
| operationID | String? | 否 | 操作 ID |
设置群成员信息
Future<dynamic> setGrpMemberInfo({
required GroupMembersInfo groupMembersInfo,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupMembersInfo | GroupMembersInfo | 是 | 群成员信息 |
| operationID | String? | 否 | 操作 ID |
是否已加入群组
Future<bool> isJoinedGrp({
required String groupID,
String? operationID,
});
- 返回值:
Future<bool>
消息
创建文本消息
Future<Message> createTextMsg({
required String text,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| text | String | 是 | 文本内容 |
创建@文本消息
Future<Message> createTextAtMsg({
required String text,
required List<String> atUserIDList,
List<AtUserInfo>? atUserInfoList,
Message? quoteMsg,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| text | String | 是 | 内容 |
| atUserIDList | List<String> | 是 | 被 at 的用户 ID 列表 |
| atUserInfoList | List<AtUserInfo>? | 否 | 被 at 的用户在群内的信息列表 |
| quoteMsg | Message? | 否 | 引用消息(引用时使用) |
通过本地图片路径创建图片消息
文件路径参数需用绝对路径
Future<Message> createImageMsgFromFullPath({
required String imagePath,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| imagePath | String | 是 | 图片绝对路径 |
通过图片URL创建图片消息
例如:自行上传的文件,然后使用返回的 url 构造消息
Future<Message> createImageMsgByURL({
required PictureInfo sourcePicture,
required PictureInfo bigPicture,
required PictureInfo snapshotPicture,
String? sourcePath,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| sourcePicture | PictureInfo | 是 | 原图信息 |
| bigPicture | PictureInfo | 是 | 大图信息 |
| snapshotPicture | PictureInfo | 是 | 缩略图信息 |
| sourcePath | String? | 否 | 原图本地路径 |
通过本地音频路径创建音频消息
文件路径参数需用绝对路径
Future<Message> createSoundMsgFromFullPath({
required String soundPath,
required int duration,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| soundPath | String | 是 | 音频绝对路径 |
| duration | int | 是 | 时长(秒) |
通过SoundElem创建音频消息
自行上传文件后使用返回的 url 构造 SoundElem 再创建消息
Future<Message> createSoundMsgByURL({
required SoundElem soundElem,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| soundElem | SoundElem | 是 | 音频元素结构体 |
通过本地视频路径创建视频消息
文件路径参数需用绝对路径
Future<Message> createVideoMsgFromFullPath({
required String videoPath,
required String videoType,
required int duration,
required String snapshotPath,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| videoPath | String | 是 | 视频绝对路径 |
| videoType | String | 是 | MIME 类型 |
| duration | int | 是 | 时长(秒) |
| snapshotPath | String | 是 | 缩略图绝对路径 |
通过VideoElem创建视频消息
自行上传文件后使用返回的 url 构造 VideoElem 再创建消息
Future<Message> createVideoMsgByURL({
required VideoElem videoElem,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| videoElem | VideoElem | 是 | 视频元素结构体 |
通过本地文件路径创建文件消息
文件路径参数需用绝对路径
Future<Message> createFileMsgFromFullPath({
required String filePath,
required String fileName,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| filePath | String | 是 | 文件本地绝对路径 |
| fileName | String | 是 | 文件名 |
通过FileElem创建文件消息
自行上传文件后使用返回的 url 构造 FileElem 再创建消息
Future<Message> createFileMsgByURL({
required FileElem fileElem,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| fileElem | FileElem | 是 | 文件元素结构体 |
创建合并消息
Future<Message> createMergerMsg({
required List<Message> messageList,
required String title,
required List<String> summaryList,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| messageList | List<Message> | 是 | 消息列表 |
| title | String | 是 | 合并消息的标题 |
| summaryList | List<String> | 是 | 合并消息需要显示的消息摘要列表 |
创建转发消息
Future<Message> createForwardMsg({
required Message message,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| message | Message | 是 | 要转发的消息 |
创建位置消息
Future<Message> createLocationMsg({
required double latitude,
required double longitude,
required String description,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| latitude | double | 是 | 纬度 |
| longitude | double | 是 | 经度 |
| description | String | 是 | 描述消息 |
创建自定义消息
Future<Message> createCustomMsg({
required String data,
required String extension,
required String description,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| data | String | 是 | 文本内容,json 字符串 |
| extension | String | 是 | 扩展内容,json 字符串 |
| description | String | 是 | 描述信息 |
创建引用消息
Future<Message> createQuoteMsg({
required String text,
required Message quoteMsg,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| text | String | 是 | 内容 |
| quoteMsg | Message | 是 | 被引用的消息体 |
创建名片消息
Future<Message> createCardMsg({
required String userID,
required String nickname,
String? faceURL,
String? ex,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | String | 是 | 名片用户 ID |
| nickname | String | 是 | 名片昵称 |
| faceURL | String? | 否 | 名片头像 URL |
| ex | String? | 否 | 扩展信息 |
创建动图消息
Future<Message> createFaceMsg({
int? index,
String? data,
String? operationID,
});
-
返回值:
Future<Message>消息结构体 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| index | int? | 否 | 表情下标 |
| data | String? | 否 | 表情内容(如 URL 表情) |
创建富文本消息
Future<Message> createAdvancedTextMsg({
required String text,
List<RichMessageInfo>? list,
String? operationID,
});
- 返回值:
Future<Message>消息结构体
创建富文本引用消息
Future<Message> createAdvancedQuoteMsg({
required String text,
required Message quoteMsg,
List<RichMessageInfo>? list,
String? operationID,
});
- 返回值:
Future<Message>消息结构体
发送消息
发送消息需要先构造消息实例,支持构造的消息类型有普通文本、图片、视频、文件、音频、地理位置、引用、转发、@xxx 等消息,构造完消息后调用 SDK 的发送接口即可完成消息的发送
Future<Message> sendMsg({
required Message message,
required OfflinePushInfo offlinePushInfo,
String? userID,
String? groupID,
String? operationID,
bool? isOnlineOnly,
});
-
返回值:
Future<Message>发送后的消息 -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| message | Message | 是 | 通过 create...Msg 创建的消息体 |
| offlinePushInfo | OfflinePushInfo | 是 | 离线推送信息 |
| userID | String? | 否 | 单聊的用户 ID,群聊时传 null |
| groupID | String? | 否 | 群聊的群 ID,单聊时传 null |
| isOnlineOnly | bool? | 否 | 是否仅在线发送 |
| operationID | String? | 否 | 操作 ID |
撤回一条消息
Future revokeMsg({
required String conversationID,
required String clientMsgID,
String? operationID,
});
-
返回值:
Future -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| clientMsgID | String | 是 | 客户端消息 ID |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
单聊正在输入消息
Future typingStatusUpdate({
required String userID,
String? msgTip,
String? operationID,
});
-
返回值:
Future -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | String | 是 | 接收者的用户 ID |
| msgTip | String? | 否 | 自定义的提示信息 |
| operationID | String? | 否 | 操作 ID |
标记消息已读
调用标记已读接口,可以把消息标记为已读,如果是单聊会话内的消息,还会给消息的发送方发送已读回执,触发发送方的 recv1v1ReadReceipt 回调。
Future markMsgsAsReadByMsgID({
required String conversationID,
required List<String> messageIDList,
String? operationID,
});
-
返回值:
Future -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| messageIDList | List<String> | 是 | 消息 ID 列表 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
从本地删除一条消息
Future deleteMsgFromLocalStorage({
required String conversationID,
required String clientMsgID,
String? operationID,
});
-
返回值:
Future -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| clientMsgID | String | 是 | 客户端消息 ID |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
删除一条消息
本地 & 服务器
Future<dynamic> deleteMsgFromLocalAndSvr({
required String conversationID,
required String clientMsgID,
String? operationID,
});
-
返回值:
Future<dynamic> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| clientMsgID | String | 是 | 客户端消息 ID |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
从本地删除所有消息
Future<dynamic> deleteAllMsgFromLocal({String? operationID});
- 返回值:
Future<dynamic>
删除所有消息
本地 & 服务器
Future<dynamic> deleteAllMsgFromLocalAndSvr({String? operationID});
- 返回值:
Future<dynamic>
相关回调请参考:
插入一条单聊消息到本地
Future<Message> insertSingleMsgToLocalStorage({
String? receiverID,
String? senderID,
Message? message,
String? operationID,
});
-
返回值:
Future<Message> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| receiverID | String? | 否 | 接收用户 ID |
| senderID | String? | 否 | 发送者 ID |
| message | Message? | 否 | 消息体 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
插入一条群聊消息到本地
Future<Message> insertGroupMsgToLocalStorage({
String? groupID,
String? senderID,
Message? message,
String? operationID,
});
-
返回值:
Future<Message> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | String? | 否 | 群 ID |
| senderID | String? | 否 | 发送者 ID |
| message | Message? | 否 | 消息体 |
| operationID | String? | 否 | 操作 ID |
相关回调请参考:
查找本地消息
Future<SearchResult> searchLocalMsgs({
String? conversationID,
List<String>? keywordList,
int? keywordListMatchType,
List<String>? senderUserIDList,
List<int>? messageTypeList,
int? searchTimePosition,
int? searchTimePeriod,
int? pageIndex,
int? count,
String? operationID,
});
-
返回值:
Future<SearchResult> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String? | 否 | 会话 ID,全局搜索时填空串 |
| keywordList | List<String>? | 否 | 关键词列表 |
| keywordListMatchType | int? | 否 | 匹配类型 |
| senderUserIDList | List<String>? | 否 | 发送者 ID 列表 |
| messageTypeList | List<int>? | 否 | 消息类型列表 |
| searchTimePosition | int? | 否 | 起始时间,UTC 时间(秒) |
| searchTimePeriod | int? | 否 | 时间范围(秒) |
| pageIndex | int? | 否 | 起始页,首次传 1 |
| count | int? | 否 | 每页消息数 |
| operationID | String? | 否 | 操作 ID |
根据消息ID查找消息列表
Future<SearchResult> findMsgList({
required SearchParams searchParams,
String? operationID,
});
-
返回值:
Future<SearchResult> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| searchParams | SearchParams | 是 | 查找参数(conversationID + clientMsgIDList) |
| operationID | String? | 否 | 操作 ID |
上传文件
发送多媒体消息不需调用此函数,SDK 内部会自动上传
Future uploadFile({
required String id,
required String filePath,
required String fileName,
String? contentType,
String? cause,
String? operationID,
});
-
返回值:
Future -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| id | String | 是 | 上传任务 ID |
| filePath | String | 是 | 文件在本机的完整路径 |
| fileName | String | 是 | 文件名 |
| contentType | String? | 否 | 文件 MIME 类型 |
| cause | String? | 否 | 文件分类说明 |
| operationID | String? | 否 | 操作 ID |
获取历史消息
从最新一条消息开始获取会话中的历史聊天记录。
Future<AdvancedMessage> getAdvancedHistoryMsgList({
String? conversationID,
Message? startMsg,
int? lastMinSeq,
int? count,
String? operationID,
});
-
返回值:
Future<AdvancedMessage> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String? | 否 | 会话 ID |
| startMsg | Message? | 否 | 起始消息,从此消息往前拉取 |
| lastMinSeq | int? | 否 | 上次拉取返回的 lastMinSeq |
| count | int? | 否 | 每页消息数 |
| operationID | String? | 否 | 操作 ID |
反向获取历史消息
反向获取会话中的历史聊天记录,可用于定位消息上下文时向后拉取历史消息。
Future<AdvancedMessage> getAdvancedHistoryMsgListReverse({
String? conversationID,
Message? startMsg,
int? lastMinSeq,
int? count,
String? operationID,
});
-
返回值:
Future<AdvancedMessage> -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String? | 否 | 会话 ID |
| startMsg | Message? | 否 | 起始消息 |
| lastMinSeq | int? | 否 | 上次拉取返回的 lastMinSeq |
| count | int? | 否 | 每页消息数 |
| operationID | String? | 否 | 操作 ID |
设置消息本地扩展信息
Future setMsgLocalEx({
required String conversationID,
required String clientMsgID,
required String localEx,
String? operationID,
});
-
返回值:
Future -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | String | 是 | 会话 ID |
| clientMsgID | String | 是 | 客户端消息 ID |
| localEx | String | 是 | 本地扩展信息 |
| operationID | String? | 否 | 操作 ID |
设置角标
告知服务器客户端现有的数量
Future setAppBadge(int count, {String? operationID});
-
返回值:
Future -
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| count | int | 是 | 角标数量 |
| operationID | String? | 否 | 操作 ID |