Class ChatUIMessageBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
ChatUIMessageBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class ChatUIMessageBuilder : ControlBuilder
Constructors
ChatUIMessageBuilder()
Declaration
public ChatUIMessageBuilder()
ChatUIMessageBuilder(List<ChatUIMessage>)
Declaration
public ChatUIMessageBuilder(List<ChatUIMessage> collection)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<ChatUIMessage> |
collection |
|
Methods
Add()
Declaration
Author(Object)
Specifies the author of the message in the Chat UI component.
This property references a UserModel object that contains details about the user who sent the message.
Declaration
public ChatUIMessageBuilder Author(object author)
Parameters
| Type |
Name |
Description |
| System.Object |
author |
|
Returns
ContentTemplate(Action<Object>)
Declaration
public ChatUIMessageBuilder ContentTemplate(Action<object> template)
Parameters
| Type |
Name |
Description |
| System.Action<System.Object> |
template |
|
Returns
ContentTemplate(Func<Object, Object>)
Declaration
public ChatUIMessageBuilder ContentTemplate(Func<object, object> template)
Parameters
| Type |
Name |
Description |
| System.Func<System.Object, System.Object> |
template |
|
Returns
Id(String)
Specifies the unique identifier for each message sent in the Chat UI component.
Represents a string that uniquely identifies a message for tracking and managing individual messages within the chat.
Declaration
public ChatUIMessageBuilder Id(string id)
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
Returns
IsForwarded(Boolean)
Specifies whether the message has been forwarded.
When set to true, the message is visually marked as forwarded.
Declaration
public ChatUIMessageBuilder IsForwarded(bool isForwarded)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isForwarded |
|
Returns
IsPinned(Boolean)
Specifies whether the message is pinned.
When set to true, the message will be visually highlighted and can appear in the pinned messages section.
Declaration
public ChatUIMessageBuilder IsPinned(bool isPinned)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isPinned |
|
Returns
MentionUsers(Object)
Represents an array of users mentioned in the message.
This field contains the list of users referenced via the @mention feature in the message text, populated when mentions are selected from the suggestion popup.
The field is optional and defaults to an empty array if no mentions are included in the message.
Declaration
public ChatUIMessageBuilder MentionUsers(object mentionUsers)
Parameters
| Type |
Name |
Description |
| System.Object |
mentionUsers |
|
Returns
ReplyTo(Object)
Specifies the reference to the original message when this message is a reply.
Contains the MessageReplyModel of the message being replied to.
Declaration
public ChatUIMessageBuilder ReplyTo(object replyTo)
Parameters
| Type |
Name |
Description |
| System.Object |
replyTo |
|
Returns
Status(Object)
Specifies the status of the message in the Chat UI component.
Represents the current status of the message, such as sent, received, or read. It helps in tracking the messages within the chat component.
Declaration
public ChatUIMessageBuilder Status(object status)
Parameters
| Type |
Name |
Description |
| System.Object |
status |
|
Returns
Text(String)
Represents the content of the message sent by a user in the Chat UI component.
Declaration
public ChatUIMessageBuilder Text(string text)
Parameters
| Type |
Name |
Description |
| System.String |
text |
|
Returns
TimeStamp(Object)
Specifies the timestamp of when the message was sent.
This property holds a Date object that represents the exact time the message was created, providing context to the conversation flow.
Declaration
public ChatUIMessageBuilder TimeStamp(object timeStamp)
Parameters
| Type |
Name |
Description |
| System.Object |
timeStamp |
|
Returns
Specifies the format of the timestamp for displaying the message's sending time.
By default, the format is set based on the culture of the application.
You can customize the format using a specific pattern, such as "'dd/MM/yyyy hh:mm'" in string format.
Declaration
public ChatUIMessageBuilder TimeStampFormat(string timeStampFormat)
Parameters
| Type |
Name |
Description |
| System.String |
timeStampFormat |
|
Returns