chat_uikit library

Classes

AlphabeticalItemModel
BlockListView
The block list view. This widget is used to display the list of blocked users.
BlockListViewController
ChangeInfoView
ChangeInfoViewArguments
ChatAreaCode
ChatClient
该类是 Chat SDK 的入口，负责登录、退出及连接管理等，由此可以获得其他模块的入口。
ChatCmdMessageBody
命令消息体类。
ChatContact
ChatContactEventHandler
联系人事件监听
ChatContactManager
联系人管理类，用于记录、查询和修改用户的联系人列表。
ChatConversation
会话类，用于定义单聊会话、群聊会话和聊天室会话。每类会话中包含发送和接收的消息。
ChatCursorResult<T>
带游标及分页获取结果的泛型类。 做为分页获取且含有游标的返回对象。
ChatCustomMessageBody
自定义消息体类。
ChatDeviceInfo
多设备登录信息类。
ChatDownloadCallback
群文件下载回调。
ChatEventHandler
Chat 事件监听。
ChatExpression
ChatFileMessageBody
文件类消息的基类。
ChatGroup
群组信息类，包含内存中的群组相关信息。
ChatGroupEventHandler
群组事件监听
ChatGroupInfo
ChatGroupManager
群组管理类，用于管理群组的创建，删除及成员管理等操作。
ChatGroupMessageAck
群组消息回执类。
ChatGroupOptions
创建群组时的属性配置类。
ChatGroupSharedFile
群组共享文件类。
ChatImageMessageBody
图片消息体类。
ChatLocal
ChatLocationMessageBody
位置消息类。
ChatMessage
消息对象类。
ChatMessageBody
ChatMessageEvent
消息状态事件类。
ChatMessageReaction
消息 Reaction 实体类，用于指定 Reaction 属性。
ChatMessageReactionEvent
消息 Reaction 事件类。
ChatMultiDeviceEventHandler
多设备事件监听 监听当前用户在其他设备上的操作的回调，包括联系人更改、群组和 thread 等更改。
ChatObserver
ChatOptions
提供 SDK 聊天相关的设置。 用户可以用来配置 SDK 的各种参数、选项， 比如，发送消息加密，是否自动接受加好友邀请。
ChatPageResult<T>
分页类。 该类包含下次查询的页码以及相应页面上的数据条数。 该对象在分页获取数据时返回。
ChatPresence
在线状态属性类，包含发布者的用户名、在线设备使用的平台、当前在线状态以及在线状态的扩展信息、更新时间和到期时间。
ChatPresenceEventHandler
订阅用户状态变更监听
ChatPresenceManager
用户在线状态管理类。
ChatPresenceStatusDetail
用户在线状态详情。
ChatPushConfigs
推送设置类。
ChatPushManager
推送设置管理类。
ChatReactionInfoWidget
ChatRoomManager
聊天室管理类，负责聊天室加入和退出、聊天室列表获取以及成员权限管理等。 比如，加入聊天室：
ChatSDKEventsObserver
ChatSDKService
ChatSilentModeTime
用于离线推送免打扰时间类。
ChatTextMessageBody
文本消息类。
ChatThreadManager
子区管理类。
ChatTranslateLanguage
翻译语言类，包含翻译语言相关信息。
ChatUIKit
ChatUIKitAlphabeticalListViewItem
ChatUIKitAlphabeticalWidget
ChatUIKitAlphabetSortHelper
Contact alphabet sorting, if there is Chinese, you can redefine the first letter using ChatUIKitAlphabetSortHelper, for example:
ChatUIKitAppBar
ChatUIKitAppBarAction
ChatUIKitAppBarModel
ChatUIKitAvatar
ChatUIKitBadge
ChatUIKitBottomPanelData
ChatUIKitBottomSheet<T>
ChatUIKitButton
ChatUIKitCardBubbleWidget
ChatUIKitColor
ChatUIKitCombineBubbleWidget
ChatUIKitContactListViewItem
ChatUIKitContext
ChatUIKitConversationListViewItem
ChatUIKitDetailContentAction
ChatUIKitDetailsListViewItem
ChatUIKitDetailsListViewItemModel
ChatUIKitDialog<T>
ChatUIKitDialogAction<T>
ChatUIKitDialogInputContentItem
ChatUIKitDownloadController
ChatUIKitDownloadsHelperWidget
ChatUIKitEditBar
ChatUIKitEmojiData
ChatUIKitEmojiPanel
ChatUIKitEmojiRichText
ChatUIKitEventAction<T>
ChatUIKitFileBubbleWidget
ChatUIKitFileSizeTool
ChatUIKitFont
ChatUIKitGroupListViewItem
ChatUIKitImageBubbleWidget
ChatUIKitImageLoader
ChatUIKitInputBar
ChatUIKitInsertTools
ChatUikitKeyboardHeight
ChatUIKitKeyboardPanel
ChatUIKitKeyboardPanelController
ChatUIKitListItemModelBase
ChatUIKitListView
ChatUIKitListViewControllerBase
ChatUIKitListViewMoreItem
ChatUIKitLocalizations
ChatUIKitMessageBubbleWidget
ChatUIKitMessageListViewAlertItem
ChatUIKitMessageListViewMessageItem
ChatUIKitMessageReactionInfo
ChatUIKitMessageReactionsRow
ChatUIKitMessageStatusWidget
ChatUIKitMessageThreadWidget
ChatUIKitMessageViewBottomMenu
ChatUIKitNewRequestListViewItem
ChatUIKitNonsupportMessageWidget
ChatUIKitObserverBase
ChatUIKitPopupMenu
ChatUIKitPopupMenuController
ChatUIKitPopupMenuStyle
ChatUIKitPositionWidget
ChatUIKitPreviewObj
ChatUIKitProfile
ChatUIKitProfile class, used to store information about contacts or groups.
ChatUIKitProvider
用户信息提供类，用于设置用户/群组展示的名称和头像信息
ChatUIKitProviderObserver
用户信息更新观察者，当用户信息更新时，会通知所有的观察者。
ChatUIKitQuoteWidget
ChatUIkitReactionWidget
ChatUIKitReplyBar
ChatUIKitRoute
路由
ChatUIKitRouteBackModel
路由返回信息，用于标记路由返回到上一页时的变更类型和 profileId
ChatUIKitRouteNames
ChatUIKitSearchHistoryViewItem
ChatUIKitSearchListViewItem
ChatUIKitSearchWidget
ChatUIKitServiceBase
ChatUIKitSettings
ChatUIKitShadow
ChatUIKitShowImageWidget
ChatUIKitShowVideoWidget
ChatUIKitTextBubbleWidget
ChatUIKitTheme
ChatUIKitThemeImpl
ChatUIKitThemeMixin
ChatUIKitTimeFormatter
ChatUIKitTimeTool
ChatUIKitURLHelper
ChatUIKitVideoBubbleWidget
ChatUIKitViewArguments
ChatUIKitViewObserver
ChatUIKitVoiceBubbleWidget
ChatUserInfo
用户属性类。
ChatUserInfoManager
用户属性类，用于获取和更新用户属性。
ChatVideoMessageBody
视频消息体类。
ChatVoiceMessageBody
语音消息体类。
ConnectObserver
ContactDetailsView
ContactDetailsViewArguments
ContactItemModel
ContactListView
The contact list view. This widget is used to display the list of contacts.
ContactListViewController
联系人列表控制器
ContactObserver
ContactsView
ContactsViewArguments
ConversationFetchOptions
会话过滤类。
ConversationItemModel
ConversationListView
The conversation list view. This widget is used to display the list of conversations.
ConversationListViewController
会话列表控制器
ConversationsView
ConversationsViewArguments
会话列表构建参数
CreateGroupInfo
CreateGroupView
CreateGroupViewArguments
CurrentUserInfoView
CurrentUserInfoViewArguments
CustomTextEditingController
EmojiIndex
ForwardMessageSelectView
ForwardMessageSelectViewArguments
ForwardMessagesView
ForwardMessagesViewArguments
GroupAddMembersView
GroupAddMembersViewArguments
GroupChangeOwnerView
GroupChangeOwnerViewArguments
GroupDeleteMembersView
GroupDeleteMembersViewArguments
GroupDetailsView
GroupDetailsViewArguments
GroupItemModel
GroupListView
The group list view. This widget is used to display the list of groups.
GroupListViewController
GroupMemberListView
The group member list view. This widget is used to display the list of group members.
GroupMemberListViewController
GroupMembersView
GroupMembersViewArguments
GroupMentionView
GroupMentionViewArguments
GroupObserver
GroupsView
GroupsViewArguments
MentionAllItem
MentionModel
MessageAlertAction
MessageListView
The list view of the message. This widget is used to display the list of messages.
MessageModel
MessageObserver
MessageSearchOptions
MessagesView
消息页面
MessagesViewArguments
MessagesViewController
消息列表控制器
MultiObserver
NewRequestDetailsView
NewRequestDetailsViewArguments
NewRequestItemModel
NewRequestListViewController
NewRequestsListView
The new requests list view. This widget is used to display the list of new requests.
NewRequestsView
NewRequestsViewArguments
PinListItem
PinListItemModel
PinMessageListView
The pin message list view.
PinMessageListViewController
PresenceObserver
QuoteModel
ReactionOperation
Reaction 操作。
RecallMessageInfo
RecordBar
RecordBarController
RecordBarState
RecordResultData
ReportMessageView
ReportMessageViewArguments
RoomObserver
SearchGroupMembersView
SearchGroupMembersViewArguments
SearchHistoryView
SearchHistoryViewArguments
SearchNotification
SearchView
SearchViewArguments
SelectContactView
SelectContactViewArguments
ShareUserData
ShowImageView
ShowImageViewArguments
ShowVideoView
ShowVideoViewArguments
ThreadMembersView
ThreadMembersViewArguments
ThreadMembersViewController
ThreadMessageListView
The thread message list view. This widget is used to display the list of thread messages.
ThreadMessagesView
ThreadMessagesViewArguments
ThreadMessagesViewController
ThreadObserver
ThreadsView
ThreadsViewArguments
UIKitHSLColor
UserData

Constants

alertContactAddKey → const String
alertCreateThreadKey → const String
alertDeleteThreadKey → const String
alertGroupCreateKey → const String
alertGroupDestroyKey → const String
alertGroupKickedKey → const String
alertGroupLeaveKey → const String
alertOperatorIdKey → const String
alertOperatorNameKey → const String
alertPinMessageKey → const String
alertRecalledKey → const String
alertTargetIdKey → const String
alertTargetNameKey → const String
alertTargetParentIdKey → const String
alertTimeKey → const String
alertUnPinMessageKey → const String
alertUpdateThreadKey → const String
arrowHeight → const double
arrowPadding → const double
arrowPosition → const double
arrowWidth → const double
borderHeight → const double
cardAvatarKey → const String
cardMessageKey → const String
cardNicknameKey → const String
cardUserIdKey → const String
contactLoadFinishedKey → const String
convLoadFinishedKey → const String
defaultLeftRightPadding → const double
hasMentionKey → const String
hasMentionValue → const String
hasTranslatedKey → const String
isNotRecording → const int
isRecording → const int
kMenuHorizontalPadding → const double
letterHeight → const double
letterWidth → const double
mentionAllValue → const String
mentionKey → const String
msgPreviewKey → const String
msgUserInfoKey → const String
muteMapKey → const String
permissionDenied → const int
playFailed → const int
quoteKey → const String
quoteMsgIdKey → const String
quoteMsgPreviewKey → const String
quoteMsgSenderKey → const String
quoteMsgTypeKey → const String
recordFailed → const int
requestsKey → const String
sdkEventKey → const String
tooShort → const int
typingKey → const String
userAvatarKey → const String
userGroupName → const String
userNicknameKey → const String
voiceHasReadKey → const String

Properties

appBarHeight ↔ double
getter/setter pair
bottomBarHeight ↔ double
getter/setter pair
connectionTimeout ↔ int
getter/setter pair
itemHeight ↔ double
getter/setter pair
maxImageHeight ↔ double
getter/setter pair
maxImageWidth ↔ double
getter/setter pair
maxRedirects ↔ int
getter/setter pair

Functions

showChatUIKitBottomSheet<T>({required BuildContext context, List<ChatUIKitEventAction<T>>? items, Color? backgroundColor, Color? barrierColor, bool enableRadius = true, String? title, TextStyle? titleStyle, Widget? titleWidget, Widget? body, String? cancelLabel, bool showCancel = true, TextStyle? cancelLabelStyle, double? height, bool isDismissible = true}) → Future<T?>
showChatUIKitDialog<T>({required BuildContext context, required List<ChatUIKitDialogAction<T>> actionItems, String? content, String? title, List<ChatUIKitDialogInputContentItem>? inputItems, TextStyle? hiddenStyle, double? leftRightPadding, Color barrierColor = Colors.black54, bool barrierDismissible = true, ChatUIKitDialogRectangleType? borderType}) → Future<T?>
showChatUIKitRecordBar<T>({required BuildContext context, RecordBarController? controller, RecordBarOnRecord? onRecordTypeChanged, Color? backgroundColor, Color? barrierColor, int maxDuration = 60, int minDuration = 1}) → Future<RecordResultData?>

Typedefs

AlphabetSortHandler = String? Function(String? groupId, String userId, String showName)
ChatError = ChatError
ChatEventHandle = ChatEventHandler
ChatManager = ChatManager
ChatPushRemindType = ChatPushRemindType
ChatRoom = ChatRoom
ChatRoomEventHandler = ChatRoomEventHandler
ChatSilentModeParam = ChatSilentModeParam
ChatSilentModeResult = ChatSilentModeResult
ChatThread = ChatThread
ChatThreadEvent = ChatThreadEvent
ChatThreadEventHandler = ChatThreadEventHandler
ChatThreadOperation = ChatThreadOperation
ChatType = ChatType
ChatUIKitActionItemOnTap = void Function(BuildContext context)
ChatUIKitAppBarActionsBuilder = List<ChatUIKitAppBarAction>? Function(BuildContext context, List<ChatUIKitAppBarAction>? defaultList)
用于在 appBar 上添加事件，会返回默认的列表，需要你调整后返回来，返回来的数据会用于菜单显示。
ChatUIKitContactItemBuilder = Widget? Function(BuildContext context, ContactItemModel model)
联系人列表 item 构建器，需要返回一个 widget，如果返回 null 将会使用默认的 item。 返回后会用于列表显示。
ChatUIKitDetailContentActionsBuilder = List<ChatUIKitDetailContentAction>? Function(BuildContext context, List<ChatUIKitDetailContentAction>? defaultList)
用于在详情页添加主要按钮事件，比如联系人详情，群组详情中添加音视频呼叫。会返回一个默认的列表，需要你调整后返回来，返回来的数据会用于菜单显示。
ChatUIKitDetailItemBuilder = List<ChatUIKitDetailsListViewItemModel> Function(BuildContext context, ChatUIKitProfile? profile, List<ChatUIKitDetailsListViewItemModel> defaultItems)
用于在联系人详情页添加 list item，会返回默认的列表，需要你调整后返回来，返回来的数据会用于菜单显示。
ChatUIKitDownloadBuilder = Widget Function(BuildContext context, String? path, String? name, ChatUIKitMessageDownloadState state, int progress)
ChatUIKitDownloadResult = void Function(Message message, String? path, ChatError? error)
ChatUIKitGroupItemBuilder = Widget Function(BuildContext context, GroupItemModel model)
群列表 item 构建器，需要返回一个 widget，如果返回 null 将会使用默认的 item。 返回后会用于列表显示。
ChatUIKitListItemBuilder = Widget? Function(BuildContext context, ChatUIKitListItemModelBase model)
ChatUIKitMoreActionsBuilder<T> = List<ChatUIKitEventAction<T>> Function(BuildContext context, List<ChatUIKitEventAction<T>> actions)
appBar 点击更多按钮时会弹出 bottom sheet, 会返回默认的列表，需要你调整后返回来，返回来的数据会用于 bottom sheet 显示。
ChatUIKitNewRequestItemBuilder = Widget Function(BuildContext context, NewRequestItemModel model)
ChatUIKitPositionWidgetHandler = void Function(Rect rect)
ChatUIKitProviderProfileHandler = List<ChatUIKitProfile>? Function(List<ChatUIKitProfile> profiles)
用户信息回调，入参为需要提供信息的 profile 列表，返回值为提供信息后的 profile 列表，如果返回值为空，当再次需要展示是仍会回调。
ChatUIKitWidgetBuilder = Widget Function(BuildContext context, Object? arguments)
Client = ChatClient
CmdMessageBody = ChatCmdMessageBody
CombineMessageBody = CombineMessageBody
ConnectionEventHandler = ConnectionEventHandler
Contact = ChatContact
ContactEventHandler = ChatContactEventHandler
ContactListViewShowHandler = List<ContactItemModel> Function(List<ContactItemModel> contacts)
通讯录列表展示前回调，会将当前的通讯录列表传递过来，你需要调整后返回来，返回来的数据会用于列表显示。
Conversation = ChatConversation
ConversationItemBuilder = Widget? Function(BuildContext context, ConversationItemModel model)
ConversationListViewShowHandler = List<ConversationItemModel> Function(List<ConversationItemModel> conversations)
会话列表展示前回调，会将当前的会话列表传递过来，你需要调整后返回来，返回来的数据会用于列表显示。
ConversationsViewItemLongPressHandler = List<ChatUIKitEventAction>? Function(BuildContext context, ConversationItemModel model, List<ChatUIKitEventAction> defaultActions)
用户会话列表长按事件，会返回默认的列表，需要你调整后返回来，返回来的数据会用于 bottom sheet 显示。
ConversationType = ChatConversationType
CreateGroupHandler = Future<CreateGroupInfo?> Function(BuildContext context, List<ChatUIKitProfile> selectedProfiles)
创建群组拦截器，当在创建群组页面点击创建后回调给你当前选择的用户，你需要返回一个 CreateGroupInfo 对象，如果返回 null 将会取消创建。
CursorResult<T> = ChatCursorResult<T>
CursorResultCallback = Object Function(dynamic obj)
CustomMessageBody = ChatCustomMessageBody
DisplayStyle = DisplayStyle
DownloadStatus = DownloadStatus
EmojiClick = void Function(String emoji)
FetchMessageOptions = FetchMessageOptions
FileMessageBody = ChatFileMessageBody
Group = ChatGroup
GroupCreateCallback = void Function(Group? group, ChatError? error)
创建群组后的回调
GroupEventHandler = ChatGroupEventHandler
GroupInfo = ChatGroupInfo
GroupMessageAck = ChatGroupMessageAck
GroupOptions = ChatGroupOptions
GroupPermissionType = ChatGroupPermissionType
GroupSharedFile = ChatGroupSharedFile
GroupStyle = ChatGroupStyle
ImageMessageBody = ChatImageMessageBody
KeyboardHeightCallback = void Function(double height, double safeArea)
LeaveReason = LeaveReason
ListViewBuilder = Widget Function(BuildContext context, List<ChatUIKitListItemModelBase> list)
ListViewSearchBuilder = Widget Function(BuildContext context, String? searchKeyword, List<ChatUIKitListItemModelBase> list)
LocationMessageBody = ChatLocationMessageBody
LoginExtensionInfo = LoginExtensionInfo
Message = ChatMessage
MessageDirection = MessageDirection
MessageEvent = ChatMessageEvent
MessageItemBubbleBuilder = Widget? Function(BuildContext context, Widget child, MessageModel model)
消息气泡构建器，需要返回一个 widget，如果返回 null 将会使用默认的气泡。 返回后会用于列表显示。其中 child 是气泡内部的内容。
MessageItemBuilder = Widget? Function(BuildContext context, MessageModel model)
MessageItemGlobalPositionTapHandler = bool? Function(BuildContext context, MessageModel model, Rect rect)
MessageItemShowHandler = bool Function(MessageModel model)
消息列表 item 元素是否展示，返回 true 表示展示，false 表示不展示。
MessageItemTapHandler = bool? Function(BuildContext context, MessageModel model)
消息列表 item 点击事件，返回 true 表示消费事件，false 或 null 表示不消费事件，事件将会继续传递。
MessagePinInfo = MessagePinInfo
MessagePinOperation = MessagePinOperation
MessageReaction = ChatMessageReaction
MessageReactionEvent = ChatMessageReactionEvent
MessageReactionItemTapHandler = bool? Function(BuildContext context, MessageModel model, MessageReaction reaction)
MessageSearchScope = MessageSearchScope
MessageStatus = MessageStatus
MessagesViewItemLongPressPositionHandler = List<ChatUIKitEventAction>? Function(BuildContext context, MessageModel model, Rect rect, List<ChatUIKitEventAction> defaultActions)
消息列表 item 长按事件，会返回默认的列表，需要你调整后返回来，返回来的数据会用于 bottom sheet 显示。
MessagesViewMorePressHandler = List<ChatUIKitEventAction>? Function(BuildContext context, List<ChatUIKitEventAction> defaultActions)
消息页 输入框 更多按钮点击事件，会返回默认的列表，需要你调整后返回来，返回来的数据会用于 bottom sheet 显示。
MessageType = MessageType
MultiDeviceEventHandler = ChatMultiDeviceEventHandler
MultiDevicesEvent = ChatMultiDevicesEvent
Options = ChatOptions
PageResult<T> = ChatPageResult<T>
PageResultCallback = Object Function(dynamic obj)
Presence = ChatPresence
PresenceEventHandler = ChatPresenceEventHandler
PushConfigs = ChatPushConfigs
ReactionOperate = ReactionOperate
RecordBarOnRecord = void Function(RecordBarRecordType type)
RecordBarOnRecordFinished = void Function(RecordResultData data)
RoomEventHandler = ChatRoomEventHandler
SearchDirection = ChatSearchDirection
TextMessageBody = ChatTextMessageBody
TimeFormatterHandler = String? Function(BuildContext context, ChatUIKitTimeType type, int time)
时间格式化
TranslateLanguage = ChatTranslateLanguage
UserInfo = ChatUserInfo
VideoMessageBody = ChatVideoMessageBody
VoiceMessageBody = ChatVoiceMessageBody

Exceptions / Errors

RecordError