im_flutter_sdk library

Classes

ChatAreaCode

ChatMessageEvent

~english 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. ~end

ChatSilentModeParam

~english Offline push Settings parameter entity class. ~end

ChatSilentModeResult

~english Offline push DND result class. ~end

ChatSilentModeTime

~english For offline push DND time class. ~end

EMChatEventHandler

~english The chat event handler.

EMChatManager

~english The chat manager class, responsible for sending and receiving messages, loading and deleting conversations, and downloading attachments.

EMChatRoom

~english The chat room instance class.

EMChatRoomEventHandler

~english The chat room event handler.

EMChatRoomManager

~english 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:

EMChatThread

~english The message thread class. ~end

EMChatThreadEvent

~english The message thread event class. ~end

EMChatThreadEventHandler

~english The message thread event handler, which handles message thread events such as creating or leaving a message thread.

EMChatThreadManager

~english The chat thread manager class. ~end

EMClient

~english The EMClient 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. ~end

EMCmdMessageBody

~english The command message body. ~end

EMCombineMessageBody

EMConnectionEventHandler

~english The connection event handler.

EMContact

EMContactEventHandler

~english The contact event handler.

EMContactManager

~english The contact manager class, which manages chat contacts such as adding, deleting, retrieving, and modifying contacts. ~end

EMConversation

~english 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.

EMCursorResult<T>

~english The EMCursorResult class, which specifies the cursor from which to query results. When querying using this class, the SDK returns the queried instance and the cursor.

EMCustomMessageBody

~english The custom message body. ~end

EMDeviceInfo

~english The EMDeviceInfo class, which contains the multi-device information. ~end

EMDownloadCallback

~english The group shared download callback. ~end

EMError

~english The error class defined by the SDK. ~end

EMFileMessageBody

~english The base class of file messages. ~end

EMGroup

~english The EMGroup class, which contains the information of the chat group. ~end

EMGroupEventHandler

~english The group event handler.

EMGroupInfo

~english The class that defines basic information of chat groups. ~end

EMGroupManager

~english The group manager class, which manages group creation and deletion, user joining and exiting the group, etc. ~end

EMGroupMessageAck

~english The class for group message read receipts.

EMGroupOptions

~english The group options to be configured when the chat group is created. ~end

EMGroupSharedFile

~english The EMGroupSharedFile class, which manages the chat group shared files.

EMImageMessageBody

~english The image message body class. ~end

EMLocationMessageBody

~english The location message class. ~end

EMMessage

~english The message class.

EMMessageReaction

~english 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. ~end

EMMessageReactionEvent

~english The message reaction change event class. ~end

EMMultiDeviceEventHandler

~english 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.

EMOptions

~english The EMOptions class, which contains the settings of the Chat SDK.

EMPageResult<T>

~english The EMPageResult 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.

EMPresence

~english 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. ~end

EMPresenceEventHandler

~english The presence event handler.

EMPresenceManager

~english The Manager that defines how to manage presence states. ~end

EMPresenceStatusDetail

~english The presence details, including the platform used by the publisher's current online device and the current presence state. ~end

EMPushConfigs

~english The push configuration class. ~end

EMPushManager

~english The message push configuration options. ~end

EMTextMessageBody

~english The text message class. ~end

EMTranslateLanguage

~english The translation language class, which contains the information of the translation languages. ~end

EMUserInfo

~english The EMUserInfo class, which contains the user attributes, such as the nickname, description, and avatar. ~end

EMUserInfoManager

~english The user attribute manager class, which gets and sets the user attributes. ~end

EMVideoMessageBody

~english The video message body class. ~end

EMVoiceMessageBody

~english The voice message body class. ~end

FetchMessageOptions

~english The parameter configuration class for pulling historical messages from the server. ~end

ReactionOperation

~english Reaction operation. ~end

Enums

ChatPushRemindType

~english The push notification modes. ~end

ChatRoomMessagePriority

~english Chat room message priorities. ~end

ChatSilentModeParamType

~english The offline push settings. ~end

ChatType

~english The chat types.

DisplayStyle

~english The push display styles. ~end

DownloadStatus

~english The download status of the attachment file. ~end

EMChatRoomPermissionType

~english The chat room roles. ~end

EMChatThreadOperation

~english The message thread events. ~end

EMConversationType

~english The conversation types. ~end

EMGroupPermissionType

~english The group roles. ~end

EMGroupStyle

~english The group types. ~end

EMMultiDevicesEvent

~english Multi-device event types.

EMSearchDirection

~english The message search directions. ~end

LeaveReason

MessageDirection

~english The message directions.

MessageStatus

~english The message sending/reception status. ~end

MessageType

~english The message types. ~end

ReactionOperate

~english Reaction operations. ~end

Typedefs

CursorResultCallback = Object Function(dynamic obj)

PageResultCallback = Object Function(dynamic obj)