MessagesContext

Value

forwarded from Channel props

additionalTouchableProps

Additional props provided to the underlying TouchableOpacity used by components within a message such as MessageContent.

Type
object

channelId

Id of current channel.

Type
string

forwarded from Channel props

deletedMessagesVisibiltyType

Controls the visibility of the deleted messages within the channel.

• always: The deleted messages in the channel will be visible to both the sender and receiver.
• never: The deleted messages will not be visible to anyone.
• sender: The deleted messages in the channel will only be visible to sender.
• receiver: The deleted messages in the channel will only be visible to receiver.

Type	Default
enum('always', 'never', 'receiver', 'sender')	'both'

forwarded from Channel props

disableTypingIndicator

Disable typing indicator in MessageList.

Type	Default
boolean	false

forwarded from Channel props

dismissKeyboardOnMessageTouch

Dismiss the keyboard when a user touches any of the messages in the list.

Type	Default
boolean	false

forwarded from Channel props

enableMessageGroupingByUser

Note: This prop is available only in SDK version >= v3.9.0

If false, consecutive messages from same user won't be grouped together.

Type	Default
boolean	true

forwarded from Channel props

forceAlignMessages

Forces alignment of messages in the list to either the left or right side of the screen. By default, received messages are aligned on the left side of the screen, and sent messages are aligned on the right.

Type	Default
'left' | 'right' | false	false

forwarded from Channel props

formatDate

Format function that returns a string to be used for the date in the message status and delete message component.

Type
function

Parameter	Description
date	date to format provided as a string, Date, or number (Unix Timestamp)

forwarded from Channel props

handleBlock

Function called when the Block User action is invoked from message actions list. This function does not override the default behavior of the Block User action. Please refer to the guide on customizing message actions for details.

Type
function

Parameter	Description
message	message the action is called on

forwarded from Channel props

handleCopy

Function called when the Copy Message action is invoked from message actions list. This function does not override the default behavior of the Copy Message action. Please refer to the guide on customizing message actions for details.

Type
function

Parameter	Description
message	message the action is called on

forwarded from Channel props

handleDelete

Function called when the Delete Message action is invoked from message actions list. This function does not override the default behavior of the Delete Message action. Please refer to the guide on customizing message actions for details.

Type
function

Parameter	Description
message	message the action is called on

forwarded from Channel props

handleEdit

Function called when the Edit Message action is invoked from message actions list. This function does not override the default behavior of the Edit Message action. Please refer to the guide on customizing message actions for details.

Type
function

Parameter	Description
message	message the action is called on

forwarded from Channel props

handleFlag

Function called when the Flag Message action is invoked from message actions list. This function does not override the default behavior of the Flag Message action. Please refer to the guide on customizing message actions for details.

Type
function

Parameter	Description
message	message the action is called on

forwarded from Channel props

handleMute

Function called when the Mute User action is invoked from message actions list. This function does not override the default behavior of the Mute User action. Please refer to the guide on customizing message actions for details.

Type
function

Parameter	Description
message	message the action is called on

forwarded from Channel props

handleQuotedReply

Function called when the Reply action is invoked from message actions list. This function does not override the default behavior of the Reply action. Please refer to the guide on customizing message actions for details.

Type
function

Parameter	Description
message	message the action is called on

forwarded from Channel props

handleReaction

Function called when a reaction is selected in the message overlay, this is called on both the add and remove action. This function does not override the default behavior of the reaction being selected. Please refer to the guide on customizing message actions for details.

Type
function

Parameter	Description
message	message the action is called on
reactionType	string designating the type of reaction

forwarded from Channel props

handleRetry

Function called when the Retry action is invoked from message actions list. This function does not override the default behavior of the Retry action. Please refer to the guide on customizing message actions for details.

Type
function

Parameter	Description
message	message the action is called on

forwarded from Channel props

handleThreadReply

Function called when the Thread Reply action is invoked from message actions list. This function does not override the default behavior of the Thread Reply action. Please refer to the guide on customizing message actions for details.

Type
function

Parameter	Description
message	message the action is called on

forwarded from Channel props

initialScrollToFirstUnreadMessage

Load messages in a channel at the first unread message.

Type	Default
boolean	false

forwarded from Channel props

isAttachmentEqual

Function which returns true if passing nextAttachment to render would return the same result as passing prevAttachment to render, otherwise return false.

Type
function

Parameter	Description
prevAttachment	previous message attachment to be compared
nextAttachment	next message attachment to be compared

forwarded from Channel props

legacyImageViewerSwipeBehaviour

forwarded from Channel props

markdownRules

Object specifying rules defined within simple-markdown.

Type
object

forwarded from Channel props

messageActions

An array of, or function that returns and array of, actions that can be performed on a message shown in the message overlay. Please refer to the guide on customizing message actions for details.

Type	Default
array | function	messageActions

Parameter	Description
actionInfo	an object containing the original actions and relevant message data

forwarded from Channel props

messageContentOrder

Order in which to render the content of a message.

Type	Default
array	['quoted_reply', 'gallery', 'files', 'text', 'attachments']

forwarded from Channel props

myMessageTheme

Theme applied to messages of the current user.

Type
object

forwarded from Channel props

onLongPressMessage

Function called when a user long presses a message. The default opens the message actions overlay.

Type
function

Parameter	Description
payload	{ actionHandlers, message }

forwarded from Channel props

onPressInMessage

Function called immediately when a touch is engaged on a message, before onPressMessage.

Type
function

Parameter	Description
payload	{ actionHandlers, message }

forwarded from Channel props

onPressMessage

Function called when a user presses a message.

caution

The default handler for message press interactions acts differently when pressing on reactions and attachments. You will have to handle these cases when overriding this function.

Type
function

Parameter	Description
payload	{ additionalInfo, actionHandlers, message }

The additionalInfo prop is handy for getting information from certain click events. A good example of this is getting the user details when a textMention (for example @Enigma-I-am) is clicked.

For example:

    <Channel
      onPressMessage={({ additionalInfo, defaultHandler, emitter }) => {

          if (emitter === 'textMention') {
            console.log(additionalInfo?.user);
            return;
          }

          if (emitter === 'card' || emitter === 'textLink') {
            console.log(additionalInfo?.url);
            return;
          }

          if (emitter === 'fileAttachment') {
            console.log(additionalInfo?.attachment);
            return;
          }

          defaultHandler?.();
      }}
    >

info

The additionalInfo prop will change over time as we explore more use-cases for different emitter's.

removeMessage

Function to remove message from local channel state. Please note that this function is only for updating the local state, it doesn't call the API for deleting message (channel.deleteMessage).

Type
(message) => void

forwarded from Channel props

Reply

Component to render preview of parent of message for quoted reply.

Type	Default
component	Reply

retrySendMessage

Function to re-attempt sending failed message.

Type
(message) => void

forwarded from Channel props

selectReaction

Full override of the reaction function on a message. This function must return a function that takes as a parameter the reactionType as a string. Please refer to the guide on customizing message actions for details.

Type
function | null

Parameter	Description
message	message the action is called on

setEditingState

Enables editing state for given message.

Type
(message) => void

setQuotedMessageState

Enables quoted-reply state on given message.

Type
(message) => void

forwarded from Channel props

supportedReactions

List of reactions which can be added on message. Please refer to the guide on customizing reactions for details.

Type	Default
array	reactionData

targetedMessage

Has the message id of the message which is to be highlighted. By default the value is undefined. As soon as the highlight time is out this is set to undefined.

Type
string

updateMessage

Upserts a given message in local channel state. Please note that this function doesn't call channel.sendMessage. Channel component uses this function for optimistic updates to message.

Type
(message) => void

forwarded from Channel props

Attachment

Component for rendering attachments in MessageList.

Available props:

• attachment {object}

Type	Default
component	Attachment

forwarded from Channel props

AttachmentActions

Component to render additional actions on attachment. for example send, shuffle, cancel in case of Giphy.

Type	Default
component	AttachmentActions

forwarded from Channel props

AudioAttachment

Component for rendering the Audio Attachment

Type	Default
Component	AudioAttachment

forwarded from Channel props

Card

Component to render any custom type of attachment. Please check the guides for Custom Attachment

Type	Default
component	Card

forwarded from Channel props

CardCover

Component to render main body for Card component which renders custom type of attachment. Please check the guides for Custom Attachment.

Type
component

forwarded from Channel props

CardFooter

Component to render footer for Card component which renders custom type of attachment. Please check the guides for Custom Attachment.

Type
component

forwarded from Channel props

CardHeader

Component to render header for Card component which renders custom type of attachment. Please check the guides for Custom Attachment.

Type
component

forwarded from Channel props

DateHeader

Component to render sticky date header within enclosed MessageList component.

Type	Default
component	DateHeader

forwarded from Channel props

FileAttachment

Component to render 'file' type attachment in MessageList.

Type	Default
component	FileAttachment

forwarded from Channel props

FileAttachmentGroup

Component to render group of file type attachments, when there are multiple file type attachments in message.

Type	Default
component	FileAttachmentGroup

forwarded from Channel props

FileAttachmentIcon

Component to render file icon for file type attachment.

Type	Default
component	FileIcon

forwarded from Channel props

FlatList

FlatList component for underlying MessageList component.

Type	Default
component	flat-list-mvcp

forwarded from Channel props

Gallery

Component to render 'image' type attachments in the MessageList.

Type	Default
component	Gallery

forwarded from Channel props

Giphy

Component to render Giphy type attachments in MessageList.

Type	Default
component	Giphy

forwarded from Channel props

giphyVersion

The Giphy version to render - check the keys of the Image Object for possible values.

Type	Default
string	'fixed_height'

forwarded from Channel props

InlineDateSeparator

Component to render inline date separators between messages which were created at a difference of more than a day.

Type	Default
component	InlineDateSeparator

forwarded from Channel props

InlineUnreadIndicator

Component to render inline separator in MessageList, to indicate the position of last read message in list.

Type	Default
component	InlineUnreadIndicator

forwarded from Channel props

MessageAvatar

Component to render avatar of sender for message, within MessageList. This component is only rendered for messages from other users.

Type	Default
component	MessageAvatar

forwarded from Channel props

MessageContent

Component to render content of message including status, attachments, reactions etc., within MessageList.

Type	Default
component	MessageContent

forwarded from Channel props

MessageDeleted

Component to render deleted message.

Type	Default
component	MessageDeleted

forwarded from Channel props

MessageFooter

Component to render footer for message, within MessageList.

Type	Default
component	MessageFooter

forwarded from Channel props

MessageHeader

Component to render header for message, within MessageList.

Type
component

forwarded from Channel props

MessageReplies

Component to show number of thread replies and avatars of members who replied on message

Type	Default
component	MessageReplies

forwarded from Channel props

MessageRepliesAvatars

Component to show avatars of members who thread replied on message.

Type	Default
component	MessageRepliesAvatars

forwarded from Channel props

MessageSimple

Component to render a message within MessageList.

Please check guides section for Customizing Message UI for details.

Type	Default
component	MessageSimple

forwarded from Channel props

MessageStatus

Component to render status of message, which includes time and read-receipts.

Type	Default
component	MessageStatus

forwarded from Channel props

MessageSystem

Component to render system type messages. Purpose of system messages is to inform user about changes to channel. System messages are part of message history, and have a property type set as system. You can add system messages within message history in following scenarios:

• A user gets added to or removed from channel
• A user accepts invite to join a channel
• Channel is updated

Type	Default
component	MessageSystem

forwarded from Channel props

MessageText

Component to render text of message. By default, we use Simple Markdown package to render the text content of message. If you decide to use this prop, please be aware that you will need to handle the markdown rendering yourself.

Type	Default
component	renderText

forwarded from Channel props

OverlayReactionList

Reaction selector component displayed within the message overlay when user long presses a message.

Type	Default
component	OverlayReactionList

forwarded from Channel props

ReactionList

Component to render list of reactions at top of message bubble.

Type	Default
component	ReactionList

forwarded from Channel props

ScrollToBottomButton

Component to render a button which when pressed, scrolls the message list to bottom.

Type	Default
component	ScrollToBottomButton

forwarded from Channel props

TypingIndicator

Component to render typing indicator within enclosed MessageList component.

Type	Default
component	TypingIndicator

forwarded from Channel props

TypingIndicatorContainer

Component to render container in which typing indicator gets rendered within enclosed MessageList component.

Type	Default
component	TypingIndicatorContainer

forwarded from Channel props

UrlPreview

Component to render preview of URLs in MessageList.

Type	Default
component	Card

forwarded from Channel props

VideoThumbnail

Component to render the video thumbnail for video attachments in MessageList.

Type	Default
component	VideoThumbnail