TencentCloudCustomerMessage class
Constructors
-
TencentCloudCustomerMessage.new({Key? key, String? groupID, required V2TimConversation conversation, String? conversationID, ConvType? conversationType, List<V2TimGroupMemberFullInfo?>? groupMemberList, String? conversationShowName, String? abstractMessageBuilder(V2TimMessage message)?, void onTapAvatar(String userID, TapDownDetails tapDetails)?, @Deprecated("Nickname will not show in one-to-one chat, if you tend to control it in group chat, please use `isShowSelfNameInGroup` and `isShowOthersNameInGroup` from `config: TIMUIKitChatConfig` instead") bool showNickName = false, bool showTotalUnReadCount = false, MessageItemBuilder? messageItemBuilder, @Deprecated("Please use [extraTipsActionItemBuilder] instead") Widget? exteraTipsActionItemBuilder(V2TimMessage message, dynamic closeTooltip(), [Key? key, BuildContext? context])?, String? draftText, String? textFieldHintText, V2TimMessage? initFindingMsg, Widget userAvatarBuilder(BuildContext context, V2TimMessage message)?, AppBar? appBarConfig, TIMUIKitChatController? controller, MorePanelConfig? morePanelConfig, CustomStickerPanel? customStickerPanel, TIMUIKitChatConfig? config = const TIMUIKitChatConfig(), TongueItemBuilder? tongueItemBuilder, List<V2TimGroupAtInfo?>? groupAtInfoList, TIMUIKitHistoryMessageListConfig? mainHistoryListConfig, ValueChanged<String>? onDealWithGroupApplication, ToolTipsConfig? toolTipsConfig, ChatLifeCycle? lifeCycle, Widget? topFixWidget = const SizedBox(), Widget textFieldBuilder(BuildContext context)?, List<CustomEmojiFaceData> customEmojiStickerList = const [], Widget? customAppBar, Widget? inputTopBuilder, void onSecondaryTapAvatar(String userID, TapDownDetails tapDetails)?, Widget? customMessageHoverBarOnDesktop(V2TimMessage message)?})
-
Properties
-
abstractMessageBuilder
→ String? Function(V2TimMessage message)?
-
The generator for the abstract summary preview of a message,
typically used in replied and forwarded messages.
Returns
null
to use the default message summary.
final
-
appBarConfig
→ AppBar?
-
The configuration for appbar.
final
-
config
→ TIMUIKitChatConfig?
-
The configuration for the whole
TIMUIKitChat
widget.
final
-
controller
→ TIMUIKitChatController?
-
The chat controller you tend to used.
You have to provide this before using it since tencentcloud_ai_desk_customer 0.1.4.
final
-
conversation
→ V2TimConversation
-
Update
It is suggested to provide the V2TimConversation
once directly, since tencentcloud_ai_desk_customer 1.5.0.
conversationID
/ conversationType
/ groupAtInfoList
/ conversationShowName
are not necessary to be provided, unless you want to cover these fields manually.
final
-
conversationID
→ String?
-
Conversation id, use for load history message list.
This field is not necessary to be provided, when
conversation
is provided, unless you want to cover this field manually.
final
-
conversationShowName
→ String?
-
Use for show conversation name.
This field is not necessary to be provided, when
conversation
is provided, unless you want to cover this field manually.
final
-
conversationType
→ ConvType?
-
Conversation type.
This field is not necessary to be provided, when
conversation
is provided, unless you want to cover this field manually.
final
-
customAppBar
→ Widget?
-
final
-
customEmojiStickerList
→ List<CustomEmojiFaceData>
-
Specify the custom small png emoji packages.
final
-
customMessageHoverBarOnDesktop
→ Widget? Function(V2TimMessage message)?
-
This parameter accepts a custom widget to be displayed when the mouse hovers over a message,
replacing the default message hover action bar.
Applicable only on desktop platforms.
If provided, the default message action functionality will appear in the right-click context menu instead.
Returns
null
to use default hover bar.
final
-
customStickerPanel
→ CustomStickerPanel?
-
Custom emoji panel.
final
-
draftText
→ String?
-
The text of draft shows in TextField.
Recommend
: You can specify this field with the draftText from V2TimConversation.
final
-
endTime
↔ int
-
getter/setter pair
-
exteraTipsActionItemBuilder
→ Widget? Function(V2TimMessage message, dynamic closeTooltip(), [Key? key, BuildContext? context])?
-
Deprecated("Please use extraTipsActionItemBuilder instead")
final
-
The builder for extra tips action.
final
-
groupAtInfoList
→ List<V2TimGroupAtInfo?>?
-
The
groupAtInfoList
from V2TimConversation
.
This field is not necessary to be provided, when conversation
is provided,
unless you want to cover this field manually.
final
-
groupID
→ String?
-
The ID of the Group that the topic belongs to, only need for topic.
final
-
groupMemberList
↔ List<V2TimGroupMemberFullInfo?>?
-
An optional parameter
groupMemberList
can be provided.
groupMemberList
accepts a list of nullable V2TimGroupMemberFullInfo
objects.
The purpose of this parameter is to allow the client to supply a pre-fetched list
of group member information. If this list is provided, it will not make
additional network requests to fetch the group member information internally.
getter/setter pair
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
initFindingMsg
→ V2TimMessage?
-
The target message been jumped just after entering the chat page.
final
-
inputTopBuilder
→ Widget?
-
final
-
key
→ Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
lifeCycle
→ ChatLifeCycle?
-
The life cycle for chat business logic.
final
-
mainHistoryListConfig
→ TIMUIKitHistoryMessageListConfig?
-
The configuration for historical message list.
final
-
messageItemBuilder
→ MessageItemBuilder?
-
Message item builder, can customize partial message item for different types or the layout for the whole line.
final
-
morePanelConfig
→ MorePanelConfig?
-
The configuration for more panel, can customize actions.
final
-
onDealWithGroupApplication
→ ValueChanged<String>?
-
The callback for jumping to the page for
TIMUIKitGroupApplicationList
or other pages to deal with enter group application for group administrator manually,
in the case of public group
.
The parameter here is String groupID
final
-
onSecondaryTapAvatar
→ void Function(String userID, TapDownDetails tapDetails)?
-
Avatar and name in message reaction secondary tap callback.
final
-
onTapAvatar
→ void Function(String userID, TapDownDetails tapDetails)?
-
Avatar and name in message reaction tap callback.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
showNickName
→ bool
-
Should show the nick name.
final
-
showTotalUnReadCount
→ bool
-
Is show unread message count, default value is false
final
-
startTime
↔ int
-
getter/setter pair
-
textFieldBuilder
→ Widget Function(BuildContext context)?
-
Custom text field
final
-
textFieldHintText
→ String?
-
The hint text shows at input field.
final
-
tongueItemBuilder
→ TongueItemBuilder?
-
The builder for the tongue on the right bottom.
Used for back to bottom, shows the count of unread new messages,
and prompts the messages that @ user.
final
-
toolTipsConfig
→ ToolTipsConfig?
-
The configuration for tool tips panel, long press messages will show this panel.
final
-
topFixWidget
→ Widget?
-
The top fixed widget.
final
-
userAvatarBuilder
→ Widget Function(BuildContext context, V2TimMessage message)?
-
use for customize avatar
final