agora_chat_sdk library

Classes

ChatAreaCode
ChatClient
The ChatClient class, which is the entry point of the Chat SDK. With this class, you can log in, log out, and access other functionalities such as group and chatroom.
ChatCmdMessageBody
The command message body.
ChatContactManager
The contact manager class, which manages chat contacts such as adding, deleting, retrieving, and modifying contacts.
ChatConversation
The conversation class, indicating a one-to-one chat, a group chat, or a conversation chat. It contains the messages that are sent and received within the conversation.
ChatCursorResult<T>
The ChatCursorResult class, which specifies the cursor from which to query results. When querying using this class, the SDK returns the queried instance and the cursor.
ChatCustomMessageBody
The custom message body.
ChatDeviceInfo
The ChatDeviceInfo class, which contains the multi-device information.
ChatDownloadCallback
The group shared download callback.
ChatError
The error class defined by the SDK.
ChatEventHandler
The chat event handler.
ChatFileMessageBody
The base class of file messages.
ChatGroup
The ChatGroup class, which contains the information of the chat group.
ChatGroupEventHandler
The group event handler.
ChatGroupInfo
The class that defines basic information of chat groups.
ChatGroupManager
The group manager class, which manages group creation and deletion, user joining and exiting the group, etc.
ChatGroupMessageAck
The class for group message read receipts.
ChatGroupOptions
The group options to be configured when the chat group is created.
ChatGroupSharedFile
The ChatGroupSharedFile class, which manages the chat group shared files.
ChatImageMessageBody
The image message body class.
ChatLocationMessageBody
The location message class.
ChatManager
The chat manager class, responsible for sending and receiving messages, loading and deleting conversations, and downloading attachments.
ChatMessage
The message class.
ChatMessageEvent
The message status event class. During message delivery, the message ID will be changed from a local uuid to a global unique ID that is generated by the server to uniquely identify a message on all devices using the SDK. This API should be implemented in the chat page widget to listen for message status changes.
ChatMessageReaction
The message Reaction instance class, which has the following attributes: Reaction: The message Reaction. UserCount: The count of users that added the Reaction. UserList: The list of users that added the Reaction. isAddedBySelf: Whether the current user added this Reaction.
ChatMessageReactionEvent
The message reaction change event class.
ChatMultiDeviceEventHandler
The multi-device event handler. Listens for callback for the current user's actions on other devices, including contact changes, group changes, and thread changes.
ChatOptions
The ChatOptions class, which contains the settings of the Chat SDK.
ChatPageResult<T>
The ChatPageResult class, which is returned when calling the methods that fetch data by pagination. The SDK also returns the number of remaining pages and the data count of the next page. If the dada count is less than the count you set, there is no more data on server.
ChatPresence
The presence property class that contains presence properties, including the publisher's user ID and current presence state, and the platform used by the online device, as well as the presence's extension information, update time, and subscription expiration time.
ChatPresenceEventHandler
The presence event handler.
ChatPresenceManager
The Manager that defines how to manage presence states.
ChatPresenceStatusDetail
The presence details, including the platform used by the publisher's current online device and the current presence state.
ChatPushConfigs
The push configuration class.
ChatPushManager
The message push configuration options.
ChatRoom
The chat room instance class.
ChatRoomEventHandler
The chat room event handler.
ChatRoomManager
The chat room manager class, which manages user joining and exiting the chat room, retrieving the chat room list, and managing member privileges. The sample code for joining a chat room:
ChatSilentModeParam
Offline push Settings parameter entity class.
ChatSilentModeResult
Offline push DND result class.
ChatSilentModeTime
For offline push DND time class.
ChatTextMessageBody
The text message class.
ChatThread
The message thread class.
ChatThreadEvent
The message thread event class.
ChatThreadEventHandler
The message thread event handler, which handles message thread events such as creating or leaving a message thread.
ChatThreadManager
The chat thread manager class.
ChatTranslateLanguage
The translation language class, which contains the information of the translation languages.
ChatUserInfo
The ChatUserInfo class, which contains the user attributes, such as the nickname, description, and avatar.
ChatUserInfoManager
The user attribute manager class, which gets and sets the user attributes.
ChatVideoMessageBody
The video message body class.
ChatVoiceMessageBody
The voice message body class.
CombineMessageBody
ConnectionEventHandler
The connection event handler.
ContactEventHandler
The contact event handler.
FetchMessageOptions
The parameter configuration class for pulling historical messages from the server.
ReactionOperation
Reaction operation.

Enums

ChatConversationType
The conversation types.
ChatGroupPermissionType
The group roles.
ChatGroupStyle
The group types.
ChatMultiDevicesEvent
Multi-device event types.
ChatPushRemindType
The push notification modes.
ChatRoomMessagePriority
Chat room message priorities.
ChatRoomPermissionType
The chat room roles.
ChatSearchDirection
The message search directions.
ChatSilentModeParamType
The offline push settings.
ChatThreadOperation
The message thread events.
ChatType
The chat types.
DisplayStyle
The push display styles.
DownloadStatus
The download status of the attachment file.
LeaveReason
MessageDirection
The message directions.
MessageStatus
The message sending/reception status.
MessageType
The message types.
ReactionOperate
Reaction operations.

Typedefs

CursorResultCallback = Object Function(dynamic obj)
PageResultCallback = Object Function(dynamic obj)