Message Overview

Basic Message Structure

Property Name	Type	Description
conversationType	RCIMIWConversationType	Conversation type
targetId	String	Conversation ID
channelId	String	Business identifier of the conversation, limited to 20 characters, effective only in ultra groups
messageType	RCIMIWMessageType	Message type
messageId	int	Unique value of the locally stored message (database index unique value)
messageUId	String	Server message unique ID (globally unique under the same Appkey)
direction	RCIMIWMessageDirection	Message direction
receivedTime	int	Message received time (Unix timestamp, milliseconds)
sentTime	int	Message sent time (Unix timestamp, milliseconds)
receivedStatus	RCIMIWReceivedStatus	Message received status
sentStatus	RCIMIWSentStatus	Message sent status
senderUserId	String	Sender user ID
expansion	Map	Message extension information list, determined at message send time and cannot be modified after sending. Extensions are only supported in one-to-one and group chats, other conversation types cannot set extensions. Default message extension key length does not exceed 32, value length does not exceed 4096, maximum number of extensions per set is 20, total message extensions cannot exceed 300
offLine	bool	Whether it is an offline message, only valid in the message received callback method. If the message is an offline message, it is YES, otherwise NO
groupReadReceiptInfo	RCIMIWGroupReadReceiptInfo	Group read receipt status
userInfo	RCIMIWUserInfo	User information carried by the message
mentionedInfo	RCIMIWMentionedInfo	Message @ information
pushOptions	RCIMIWMessagePushOptions	Message push configuration, can only be configured by the sender, receiver is empty
extra	String	Additional field of the message, set so that the receiver can also access the data after receiving the message.

Message Types and Construction Methods

The message type (RCIMIWMessageType) enumeration in IMLib provides predefined text, voice, image, and other message types, and supports custom messages through RCIMIWMessageType.custom.

All message types are stored locally on the client by default and counted as unread messages, except for the following:

• Recall message type (RCIMIWMessageType.recall): Stored locally on the client but not counted as unread messages.
• Command message type (RCIMIWMessageType.command): Not stored locally on the client and not counted as unread messages.
• Command notification message type (RCIMIWMessageType.commandNotification): Stored locally on the client but not counted as unread messages.
• Custom message type (RCIMIWMessageType.custom): Storage strategy controlled by the app (RCIMIWCustomMessagePolicy).

Text Message

Type: RCIMIWMessageType.text

Exclusive accessible properties:

Property Name	Type	Description
text	String	Text content

Construct Text Message

RCIMIWTextMessage? message = await engine.createTextMessage(
      type,
      targetId,
      channelId,
      text,
    );

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	String	Conversation ID
channelId	String	Channel ID, only supported in ultra groups, pass null for other conversation types.
text	String	Text content

Voice Message

Type: RCIMIWMessageType.voice

Exclusive accessible properties:

Property Name	Type	Description
duration	int	Voice duration in seconds

Construct Voice Message

RCIMIWVoiceMessage? message = await engine.createVoiceMessage(
      type,
      targetId,
      channelId,
      path,
      duration,
    );

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	String	Conversation ID
channelId	String	Channel ID, only supported in ultra groups, pass null for other conversation types.
path	String	Local path of the voice message, must be a valid path
duration	int	Duration of the voice message

Image Message

Type: RCIMIWMessageType.image

Exclusive accessible properties:

Property Name	Type	Description
thumbnailBase64String	String	Thumbnail data of the image
original	bool	Whether it is the original image

Construct Image Message

RCIMIWImageMessage? message = await engine.createImageMessage(
          type,
          targetId,
          channelId,
          path,
        );

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	String	Conversation ID
channelId	String	Channel ID, only supported in ultra groups, pass null for other conversation types.
path	String	Local path of the image message, must be a valid path

File Message

Type: RCIMIWMessageType.file

Exclusive accessible properties:

Property Name	Type	Description
name	String	File name
fileType	String	File type
size	int	File size in bytes

Construct File Message

RCIMIWFileMessage? message = await engine.createFileMessage(
      type,
      targetId,
      channelId,
      path,
    );

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	String	Conversation ID
channelId	String	Channel ID, only supported in ultra groups, pass null for other conversation types.
path	String	Local path of the file message, must be a valid path

Short Video Message

Type: RCIMIWMessageType.sight

Exclusive accessible properties:

Property Name	Type	Description
duration	int	Video duration
size	int	Video size
name	String	Video name
thumbnailBase64String	String	Thumbnail data

Construct Short Video Message

RCIMIWSightMessage? message = await engine.createSightMessage(
      type,
      targetId,
      channelId,
      path,
      duration,
    );

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	String	Conversation ID
channelId	String	Channel ID, only supported in ultra groups, pass null for other conversation types.
path	String	Local path of the short video message, must be a valid path
duration	int	Duration of the short video message, note that the default server-side video duration limit is 2 minutes. Contact business for adjustments.

GIF Message

Type: RCIMIWMessageType.gif

Exclusive accessible properties:

Property Name	Type	Description
dataSize	int	GIF size in bytes
width	int	GIF width
height	int	GIF height

Construct GIF Message

RCIMIWGIFMessage? message = await engine.createGIFMessage(
      type,
      targetId,
      channelId,
      path
    );

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	String	Conversation ID
channelId	String	Channel ID, only supported in ultra groups, pass null for other conversation types.
path	String	Local path of the GIF message

Recall Message

Recall messages cannot be actively constructed and sent. To recall a message, call the recall message interface.

Type: RCIMIWMessageType.recall

Exclusive accessible properties:

Property Name	Type	Description
admin	bool	Whether it is an admin operation
deleted	bool	Whether it is deleted
recallTime	int	Sent time of the original message being recalled (milliseconds)
recallActionTime	int	Time of the recall action (milliseconds)
originalMessage	RCIMIWMessage	Original message being recalled

Reference Message

Type: RCIMIWMessageType.reference

Exclusive accessible properties:

Property Name	Type	Description
text	String	Reference text
referenceMessage	RCIMIWMessage	Referenced message

Construct Reference Message

RCIMIWReferenceMessage? message = await engine.createReferenceMessage(
      type,
      targetId,
      channelId,
      message,
      text,
    );

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	String	Conversation ID
channelId	String	Channel ID, only supported in ultra groups, pass null for other conversation types.
referenceMessage	RCIMIWMessage	Referenced message
text	String	Reference text content

Location Message

Type: RCIMIWMessageType.location

Exclusive accessible properties:

Property Name	Type	Description
longitude	double	Longitude information
latitude	double	Latitude information
poiName	String	POI information
thumbnailPath	String	Thumbnail path

Construct Location Message

RCIMIWLocationMessage? message = await engine?.createLocationMessage(
      type,
      targetId,
      channelId,
      double.parse(longitude),
      double.parse(latitude),
      poiName,
      path,
    );

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	String	Conversation ID
channelId	String	Channel ID, only supported in ultra groups, pass null for other conversation types.
longitude	double	Longitude
latitude	double	Latitude
poiName	String	POI information
thumbnailPath	String	Local path of the thumbnail, must be a valid path

Command Message

Type: RCIMIWMessageType.command

Exclusive accessible properties:

Property Name	Type	Description
name	String	Command name
data	String	Command extension data, can be any string, such as json data defined by you.

Flutter SDK currently does not provide a create method for RCIMIWCommandMessage command messages, only supports receiving this type of message. To send this message on the client, you need to define a wrapper class for this message at the Flutter layer. See the knowledge base document How to Send Command Messages and Command Notification Messages in Flutter SDK?.

Command Notification Message

Type: RCIMIWMessageType.commandNotification

Exclusive accessible properties:

Property Name	Type	Description
name	String	Command notification name
data	String	Command notification message extension data, can be any string, such as json data defined by you.

Flutter SDK currently does not provide a create method for RCIMIWCommandNotificationMessage command notification messages, only supports receiving this type of message. To send this message on the client, you need to define a wrapper class for this message at the Flutter layer. See the knowledge base document How to Send Command Messages and Command Notification Messages in Flutter SDK?.

Custom Message

Type: RCIMIWMessageType.custom

Exclusive accessible properties:

Property Name	Type	Description
identifier	String	Custom message identifier
policy	RCIMIWCustomMessagePolicy	Custom message storage policy
fields	Map<String, String>	Custom message key-value pairs

Construct Custom Message

RCIMIWCustomMessage? message = await engine.createCustomMessage(
      type,
      targetId,
      channelId,
      policy,
      messageIdentifier,
      fields,
    );

Parameter Name	Parameter Type	Description
type	RCIMIWConversationType	Conversation type
targetId	String	Conversation ID
channelId	String	Channel ID, only supported in ultra groups, pass null for other conversation types.
policy	RCIMIWCustomMessagePolicy	Message storage policy
messageIdentifier	String	Message identifier, must be unique
fields	Map<String, String>	Message content key-value pairs

Invalid Type

When an unrecognized message is received, it becomes an invalid type message, this message cannot be actively constructed and sent.

Type: RCIMIWMessageType.unknown

Exclusive accessible properties:

Property Name	Type	Description
rawData	String	Message data
objectName	String	Message identifier