Class

RadChat

Initializes a new instance of the RadChat class.

Declaration

public RadChat()

Identifies the ActualRemoveAttachedFileCommand property.

Declaration

public static readonly BindableProperty ActualRemoveAttachedFileCommandProperty

Field Value

Identifies the ActualScrollMediator property.

Declaration

public static readonly BindableProperty ActualScrollMediatorModeProperty

Field Value

Identifies the ActualSendMessageCommand property.

Declaration

public static readonly BindableProperty ActualSendMessageCommandProperty

Field Value

Identifies the AttachFilesCommand property.

Declaration

public static readonly BindableProperty AttachFilesCommandProperty

Field Value

Identifies the AttachedFileConverter property.

Declaration

public static readonly BindableProperty AttachedFileConverterProperty

Field Value

Identifies the AttachedFiles property.

Declaration

public static readonly BindableProperty AttachedFilesProperty

Field Value

Identifies the AttachedFilesSource property.

Declaration

public static readonly BindableProperty AttachedFilesSourceProperty

Field Value

Identifies the Author property.

Declaration

public static readonly BindableProperty AuthorProperty

Field Value

Identifies the AutoGenerateMoreButtonActions property.

Declaration

public static readonly BindableProperty AutoGenerateMoreButtonActionsProperty

Field Value

Identifies the AutoScrollMode property.

Declaration

public static readonly BindableProperty AutoScrollModeProperty

Field Value

Identifies the BackgroundColor property.

Declaration

public static readonly BindableProperty BackgroundColorProperty

Field Value

Identifies the DownloadAttachmentsCommand property.

Declaration

public static readonly BindableProperty DownloadAttachmentsCommandProperty

Field Value

Identifies the InputAreaStyle property.

Declaration

public static readonly BindableProperty InputAreaStyleProperty

Field Value

Identifies the ItemConverter property.

Declaration

public static readonly BindableProperty ItemConverterProperty

Field Value

Identifies the ItemTemplateSelector property.

Declaration

public static readonly BindableProperty ItemTemplateSelectorProperty

Field Value

Identifies the ItemsSource property.

Declaration

public static readonly BindableProperty ItemsSourceProperty

Field Value

Identifies the Message property.

Declaration

public static readonly BindableProperty MessageProperty

Field Value

Identifies the MoreButtonActions property.

Declaration

public static readonly BindableProperty MoreButtonActionsProperty

Field Value

Identifies the MoreButtonStyle property.

Declaration

public static readonly BindableProperty MoreButtonStyleProperty

Field Value

Identifies the PickFileCommand property.

Declaration

public static readonly BindableProperty PickFileCommandProperty

Field Value

Identifies the PickFileTypes property.

Declaration

public static readonly BindableProperty PickFileTypesProperty

Field Value

Identifies the PickPhotoCommand property.

Declaration

public static readonly BindableProperty PickPhotoCommandProperty

Field Value

Identifies the Picker property.

Declaration

public static readonly BindableProperty PickerProperty

Field Value

Identifies the RemoveAttachedFileCommand property.

Declaration

public static readonly BindableProperty RemoveAttachedFileCommandProperty

Field Value

Identifies the SendMessageButtonImage property.

Declaration

public static readonly BindableProperty SendMessageButtonImageProperty

Field Value

Identifies the SendMessageCommand property.

Declaration

public static readonly BindableProperty SendMessageCommandProperty

Field Value

Identifies the ShareAttachmentsCommand property.

Declaration

public static readonly BindableProperty ShareAttachmentsCommandProperty

Field Value

Identifies the SpeechToTextButtonStyle property.

Declaration

public static readonly BindableProperty SpeechToTextButtonStyleProperty

Field Value

Identifies the TakePhotoCommand property.

Declaration

public static readonly BindableProperty TakePhotoCommandProperty

Field Value

Identifies the TypingIndicator property.

Declaration

public static readonly BindableProperty TypingIndicatorProperty

Field Value

Gets the actual command that is executed when removing an attached file. This command will execute the custom RemoveAttachedFileCommand.

Declaration

public ICommand ActualRemoveAttachedFileCommand { get; }

Property Value

Gets or sets the actual ScrollMediator used by the chat to mediate the scrolling functionality.

Declaration

public ScrollMediator ActualScrollMediator { get; }

Property Value

Gets the actual send command that is executed when sending a message. This command will execute the custom SendMessageCommand.

Declaration

public ICommand ActualSendMessageCommand { get; }

Property Value

Gets or sets the command that is executed when the files the end-user picked need to be attached/uploaded.

Declaration

public ICommand AttachFilesCommand { get; set; }

Property Value

Gets or sets the converter that performs the conversion between a data item representing an attached file and a ChatAttachedFile.

Declaration

public IChatAttachedFileConverter AttachedFileConverter { get; set; }

Property Value

Gets or sets a collection that contains the currently attached files that have not yet been sent.

Declaration

public ICollection<ChatAttachedFile> AttachedFiles { get; }

Property Value

Gets or sets the items source from which the chat populates the AttachedFiles collection, i.e. the files that are to be uploaded and have not yet been sent.

Declaration

public IEnumerable AttachedFilesSource { get; set; }

Property Value

Gets or sets the current author of outgoing messages in the chat.

Declaration

public Author Author { get; set; }

Property Value

Gets or sets a value indicating whether to automatically generate default actions for the 'More' button.

Declaration

public bool AutoGenerateMoreButtonActions { get; set; }

Property Value

Gets or sets the mode which defines the automatic scrolling behavior of the RadChatListView when a message is sent or received.

Declaration

public AutoScrollMode AutoScrollMode { get; set; }

Property Value

Declaration

public Color BackgroundColor { get; set; }

Property Value

Gets or sets the command that is executed when the end user initiates download of attachments for a ChatAttachmentsMessage. The command parameter of this command is of type ChatDownloadAttachmentsCommandContext.

Declaration

public ICommand DownloadAttachmentsCommand { get; set; }

Property Value

Gets or sets the style of the .

Declaration

public Style InputAreaStyle { get; set; }

Property Value

Gets or sets the converter that performs the conversion between data and chat items.

Declaration

public IChatItemConverter ItemConverter { get; set; }

Property Value

Gets or sets the template selector for visualizing chat items.

Declaration

public DataTemplateSelector ItemTemplateSelector { get; set; }

Property Value

Gets the collection of chat items.

Declaration

public IList<ChatItem> Items { get; }

Property Value

Gets or sets the items source from which chat items are generated.

Declaration

public IEnumerable ItemsSource { get; set; }

Property Value

Gets or sets the message that is typed in the chat entry.

Declaration

public object Message { get; set; }

Property Value

Gets or sets the collection of toolbar actions displayed in the input area more button.

Declaration

public IList<ChatButtonAction> MoreButtonActions { get; set; }

Property Value

Gets or sets a custom style that is to be applied to the 'More' button. The actual style that is applied is a merger between this style and the default style for the ChatMoreButtonToolbarItemView. The target type of this style is ChatMoreButtonToolbarItemView .

Declaration

public Style MoreButtonStyle { get; set; }

Property Value

Gets or sets the command that opens the for attaching files for upload.

Declaration

public ICommand PickFileCommand { get; set; }

Property Value

Gets or sets the type of files that can be attached in the UI that is shown when the end-user clicks the pick-file button (attach-files button).

Declaration

public FilePickerFileType PickFileTypes { get; set; }

Property Value

Gets or sets the command that opens the for attaching photos for upload.

Declaration

public ICommand PickPhotoCommand { get; set; }

Property Value

Gets or sets the inline picker of the chat.

Declaration

public View Picker { get; set; }

Property Value

Gets or sets the command that should remove an attached file from the AttachedFilesSource collection in the view model.

Declaration

public ICommand RemoveAttachedFileCommand { get; set; }

Property Value

Gets or sets the image for the send message button.

Declaration

public ImageSource SendMessageButtonImage { get; set; }

Property Value

Gets or sets the custom command that will be executed when sending a message (when the Send message button is pressed or Enter is pressed). The parameter of this command is of type object and the value is the same as the Message property.

Declaration

public ICommand SendMessageCommand { get; set; }

Property Value

Gets or sets the command that triggers the share attachments operation.

Declaration

public ICommand ShareAttachmentsCommand { get; set; }

Property Value

Gets or sets the style of the RadSpeechToTextButton in the RadChat control. The actual style that is applied is a merger between this style and the default style for the RadSpeechToTextButton The target type of this style is RadSpeechToTextButton.

Declaration

public Style SpeechToTextButtonStyle { get; set; }

Property Value

Gets or sets the command that opens the camera for attaching a photo.

Declaration

public ICommand TakePhotoCommand { get; set; }

Property Value

Gets or sets the typing indicator displayed when another author is typing.

Declaration

public View TypingIndicator { get; set; }

Property Value

Attempts to set focus to the entry element.

Declaration

public bool FocusEntry()

Returns

Declaration

protected override void OnApplyTemplate()

Called when the binding context changes.

Declaration

protected override void OnBindingContextChanged()

Overrides RadContentView.OnBindingContextChanged()

Declaration

protected override void OnPropertyChanged(string propertyName = null)

Parameters

Scrolls to the item at the provided index.

Declaration

public void ScrollTo(int index)

Parameters

Stops the speech to text recognition.

If the speech recognizer is currently in the StartingListening or Listening state, this method will stop the recognition process. If the recognizer is not listening, this method has no effect.

Declaration

public Task StopSpeechToTextRecognition()

Returns

Raised when the end user picks files to attach.

Declaration

public event EventHandler<ChatAttachFilesEventArgs> AttachFiles

Event Value

Raised when the end user removes an attached file, via the X button of the ChatInputAreaAttachedFileItemView.

Declaration

public event EventHandler<ChatRemoveAttachedFileEventArgs> RemoveAttachedFile

Event Value

Raised when a message is sent from the chat by the current author (by clicking the send messsage button or pressing Enter).

Declaration

public event EventHandler SendMessage

Event Value