ChatMessage interface

  • Reference
Package:
@azure/communication-chat

Chat message.

Properties

content

Content of a chat message.
createdOn

The timestamp when the chat message arrived at the server. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
deletedOn

The timestamp (if applicable) when the message was deleted. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
editedOn

The last timestamp (if applicable) when the message was edited. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
id

The id of the chat message. This id is server generated.
metadata

metadata
sender

Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model must be interpreted as a union: Apart from rawId, at most one further property may be set.
senderDisplayName

The display name of the chat message sender. This property is used to populate sender name for push notifications.
sequenceId

Sequence of the chat message in the conversation.
type

The chat message type.
version

Version of the chat message.

Property Details

content

Content of a chat message.

content?: ChatMessageContent

Property Value

ChatMessageContent

createdOn

The timestamp when the chat message arrived at the server. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

createdOn: Date

Property Value

Date

deletedOn

The timestamp (if applicable) when the message was deleted. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

deletedOn?: Date

Property Value

Date

editedOn

The last timestamp (if applicable) when the message was edited. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

editedOn?: Date

Property Value

Date

id

The id of the chat message. This id is server generated.

id: string

Property Value

string

metadata

metadata

metadata?: Record<string, string>

Property Value

Record<string, string>

sender

Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model must be interpreted as a union: Apart from rawId, at most one further property may be set.

sender?: CommunicationIdentifierKind

Property Value

CommunicationIdentifierKind

senderDisplayName

The display name of the chat message sender. This property is used to populate sender name for push notifications.

senderDisplayName?: string

Property Value

string

sequenceId

Sequence of the chat message in the conversation.

sequenceId: string

Property Value

string

type

The chat message type.

type: ChatMessageType

Property Value

ChatMessageType

version

Version of the chat message.

version: string

Property Value

string