Class

TelerikChat<TItem>

Declaration

public TelerikChat()

Defines the ID of the current author/user. Set this to the ID of the user who is currently sending messages. Each message in the chat should have an AuthorId that matches this value to indicate that the message was sent by the current user.

Declaration

[Parameter]
public string AuthorId { get; set; }

Property Value

Defines the field in the data source that contains the ID of the author of the message.

Declaration

[Parameter]
public string AuthorIdField { get; set; }

Property Value

Defines the field in the data source that contains the alt text for the author's image.

Declaration

[Parameter]
public string AuthorImageAltTextField { get; set; }

Property Value

Defines the field in the data source that contains the image URL of the author of the message.

Declaration

[Parameter]
public string AuthorImageUrlField { get; set; }

Property Value

Defines the field in the data source that contains the name of the author of the message.

Declaration

[Parameter]
public string AuthorNameField { get; set; }

Property Value

Defines a render fragment that contains actions for the attachments. Children: ChatFileAction.

Declaration

[Parameter]
public RenderFragment ChatFileActions { get; set; }

Property Value

Defines a render fragment that contains message actions. Children: ChatMessageContextMenuAction.

Declaration

[Parameter]
public RenderFragment ChatMessageContextMenuActions { get; set; }

Property Value

Defines a render fragment that contains actions for the attachments. Children: ChatMessageToolbarAction.

Declaration

[Parameter]
public RenderFragment ChatMessageToolbarActions { get; set; }

Property Value

Defines a render fragment that contains all settings for the Chat. Children: ChatFileSelectSettings, ChatSpeechToTextButtonSettings.

Declaration

[Parameter]
public RenderFragment ChatSettings { get; set; }

Property Value

The data source for the chat component. The data source should be a collection of items that represent messages.

Declaration

[Parameter]
public IEnumerable<TItem> Data { get; set; }

Property Value

Enables or disables the file upload functionality in the chat component. Renders a file upload icon in the chat input box that allows users to upload files.

Declaration

[Parameter]
public bool EnableFileUpload { get; set; }

Property Value

Enables the collapse functionality for messages in the chat component. By default, messages are expanded and can be collapsed by clicking on them.

Declaration

[Parameter]
public bool EnableMessageCollapse { get; set; }

Property Value

Enables or disables the speech-to-text functionality in the chat component. Renders a microphone icon in the chat input box that allows users to convert speech to text.

Declaration

[Parameter]
public bool EnableSpeechToText { get; set; }

Property Value

Defines the field in the data source that contains the attachments of the message. The field should be a collection of objects of type FileSelectFileInfo.

Declaration

[Parameter]
public string FilesField { get; set; }

Property Value

Template for modifying the content of the header of the chat component.

Declaration

[Parameter]
public RenderFragment HeaderTemplate { get; set; }

Property Value

Defines the height of the chat component.

Declaration

[Parameter]
public string Height { get; set; }

Property Value

Defines the field in the data source that contains the ID of the message.

Declaration

[Parameter]
public string IdField { get; set; }

Property Value

The value of the chat input field.

Declaration

[Parameter]
public string InputValue { get; set; }

Property Value

Defines the field in the data source that indicates whether the message is deleted.

Declaration

[Parameter]
public string IsDeletedField { get; set; }

Property Value

Defines the field in the data source that indicates whether the message is deleted.

Declaration

[Parameter]
public string IsPinnedField { get; set; }

Property Value

A render fragment that allows customization of the whole message box section in the chat.

Declaration

[Parameter]
public RenderFragment MessageBoxTemplate { get; set; }

Property Value

Template for modifying the appearance of the message status indicators in the chat.

Declaration

[Parameter]
public RenderFragment<ChatMessageStatusTemplateContext<TItem>> MessageStatusTemplate { get; set; }

Property Value

Template for modifying the appearance of the messages in the chat.

Declaration

[Parameter]
public RenderFragment<ChatMessageTemplateContext<TItem>> MessageTemplate { get; set; }

Property Value

Defines the width mode of the messages in the chat. The available options are:

1. Standard - Messages will have a width that fits their content.
2. Full - Messages will take the full width of the chat container.

The default value is Standard.

Declaration

[Parameter]
public MessageWidthMode MessageWidthMode { get; set; }

Property Value

Event callback that is triggered when a file is downloaded. Triggered upon clicking on a file download action or when the Download button is clicked.

Declaration

[Parameter]
public EventCallback<ChatDownloadEventArgs> OnDownload { get; set; }

Property Value

Event callback that is triggered when the input value changes.

Declaration

[Parameter]
public EventCallback<string> OnInputValueChanged { get; set; }

Property Value

Event callback that is triggered when a message is unpinned.

Declaration

[Parameter]
public EventCallback<ChatMessageUnpinEventArgs> OnMessageUnpin { get; set; }

Property Value

Event callback that is triggered when a message is sent. The arguments are of type ChatSendMessageEventArgs.

Declaration

[Parameter]
public EventCallback<ChatSendMessageEventArgs> OnSendMessage { get; set; }

Property Value

An event callback that is triggered when a suggestion is selected from the suggestions list. The arguments are of type ChatSuggestionClickEventArgs.

Declaration

[Parameter]
public EventCallback<ChatSuggestionClickEventArgs> OnSuggestionClick { get; set; }

Property Value

Each meesage in the chat should have a unique ID. This field value is optional and it is used to identify the other meessage to which the current message is a reply.

Declaration

[Parameter]
public string ReplyToIdField { get; set; }

Property Value

Defines the field in the data source that contains the status of the message.

Declaration

[Parameter]
public string StatusField { get; set; }

Property Value

Defines the field in the data source that contains the quick actions for the message.

Declaration

[Parameter]
public string SuggestedActionsField { get; set; }

Property Value

Template for modifying the appearance of the suggestions displayed in the chat input.

Declaration

[Parameter]
public RenderFragment<ChatSuggestionTemplateContext> SuggestionTemplate { get; set; }

Property Value

Use this parameter to provide a collection of suggestions that will be displayed as quick reply options in the chat input.

Declaration

[Parameter]
public IEnumerable<string> Suggestions { get; set; }

Property Value

The field in the data source that contains the text of the message.

Declaration

[Parameter]
public string TextField { get; set; }

Property Value

Defines the field in the data source that contains the timestamp of the message.

Declaration

[Parameter]
public string TimestampField { get; set; }

Property Value

Defines a render fragment that contains the content of the chat time stamps displayed between messages.

Declaration

[Parameter]
public RenderFragment<ChatTimestampTemplateContext> TimestampTemplate { get; set; }

Property Value

Defines the width of the chat component.

Declaration

[Parameter]
public string Width { get; set; }

Property Value

Declaration

public void AddSendMessageButtonSettings(ChatSendMessageButtonSettings settings)

Parameters

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Declaration

public override void Dispose()

Overrides BaseComponent.Dispose()

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Returns

Overrides BaseComponent.OnAfterRenderAsync(bool)

Declaration

protected override void OnParametersSet()

Overrides ComponentBase.OnParametersSet()

Refreshes the chat component, causing it to re-render.

Declaration

public void Refresh()

Declaration

public void RemoveSendMessageButtonSettings()