ZegoLiveStreamingInRoomMessageConfig class

Control options for the bottom-left message list.

This class is used for the ZegoUIKitPrebuiltLiveStreamingConfig.message property.

Of course, we also provide a range of styles for you to customize, such as display size, background color, font style, and so on.

Constructors

ZegoLiveStreamingInRoomMessageConfig({bool visible = true, bool notifyUserJoin = false, bool notifyUserLeave = false, Map<String, String> attributes()?, double? width, double? height, Offset? bottomLeft, ZegoInRoomMessageItemBuilder? itemBuilder, ZegoInRoomMessageItemBuilder? avatarLeadingBuilder, ZegoInRoomMessageItemBuilder? avatarTailingBuilder, ZegoInRoomMessageItemBuilder? nameLeadingBuilder, ZegoInRoomMessageItemBuilder? nameTailingBuilder, ZegoInRoomMessageItemBuilder? textLeadingBuilder, ZegoInRoomMessageItemBuilder? textTailingBuilder, double opacity = 0.5, int? maxLines, TextStyle? nameTextStyle, TextStyle? messageTextStyle, Color? backgroundColor, BorderRadiusGeometry? borderRadius, EdgeInsetsGeometry? paddings, Widget? resendIcon, Widget? background, bool showName = true, bool showAvatar = true, bool showFakeMessage = true})

Properties

attributes ↔ (Map<String, String> Function()?)

message attributes of local user, which will be appended to the message body.

getter/setter pair

avatarLeadingBuilder ↔ ZegoInRoomMessageItemBuilder?

A more granular builder for customizing the widget on the leading of the avatar part, default is empty. default message display widget = avatar + name + text Please note that if you use itemBuilder, this builder will be ignored.

getter/setter pair

avatarTailingBuilder ↔ ZegoInRoomMessageItemBuilder?

A more granular builder for customizing the widget on the tailing of the avatar part, default is empty. default message display widget = avatar + name + text Please note that if you use itemBuilder, this builder will be ignored.

getter/setter pair

background ↔ Widget?

background

getter/setter pair

backgroundColor ↔ Color?

The background of chat message list items If you set the backgroundColor, the opacity setting will be overridden. You can use backgroundColor.withOpacity(0.5) to set the opacity of the background color.

getter/setter pair

borderRadius ↔ BorderRadiusGeometry?

The border radius of chat message list items

getter/setter pair

bottomLeft ↔ Offset?

The offset of chat message list view bottom-left position

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

height ↔ double?

The height of chat message list view

getter/setter pair

itemBuilder ↔ ZegoInRoomMessageItemBuilder?

Use this to customize the style and content of each chat message list item. For example, you can modify the background color, opacity, border radius, or add additional information like the sender's level or role.

getter/setter pair

maxLines ↔ int?

The max lines of chat message list items, default value is not limit.

getter/setter pair

messageTextStyle ↔ TextStyle?

The message text style of chat message list items

getter/setter pair

nameLeadingBuilder ↔ ZegoInRoomMessageItemBuilder?

A more granular builder for customizing the widget on the leading of the name part, default is empty. default message display widget = avatar + name + text Please note that if you use itemBuilder, this builder will be ignored.

getter/setter pair

nameTailingBuilder ↔ ZegoInRoomMessageItemBuilder?

A more granular builder for customizing the widget on the tailing of the name part, default is empty. default message display widget = avatar + name + text Please note that if you use itemBuilder, this builder will be ignored.

getter/setter pair

nameTextStyle ↔ TextStyle?

The name text style of chat message list items

getter/setter pair

notifyUserJoin ↔ bool

Whether to display user join messages, default is not displayed

getter/setter pair

notifyUserLeave ↔ bool

Whether to display user leave messages, default is not displayed

getter/setter pair

opacity ↔ double

The opacity of the background color for chat message list items, default value of 0.5. If you set the backgroundColor, the opacity setting will be overridden.

getter/setter pair

paddings ↔ EdgeInsetsGeometry?

The paddings of chat message list items

getter/setter pair

resendIcon ↔ Widget?

resend button icon

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

showAvatar ↔ bool

display user avatar in message list view or not

getter/setter pair

showFakeMessage ↔ bool

show fake message or not

getter/setter pair

showName ↔ bool

display user name in message list view or not

getter/setter pair

textLeadingBuilder ↔ ZegoInRoomMessageItemBuilder?

A more granular builder for customizing the widget on the leading of the text part, default is empty. default message display widget = avatar + name + text Please note that if you use itemBuilder, this builder will be ignored.

getter/setter pair

textTailingBuilder ↔ ZegoInRoomMessageItemBuilder?

A more granular builder for customizing the widget on the tailing of the text part, default is empty. default message display widget = avatar + name + text Please note that if you use itemBuilder, this builder will be ignored.

getter/setter pair

visible ↔ bool

display chat message list view or not

getter/setter pair

width ↔ double?

The width of chat message list view

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited