ChatMessageReceivedEvent interface

  • Reference
Package:
@azure/communication-chat

Event for a received chat message. All chat participants receive this event, including the original sender

Extends
@azure/communication-signaling.BaseChatMessageEvent

Properties

attachments

Chat message attachments.
message

Content of the message.
metadata

Metadata of the message.

Inherited Properties

createdOn

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

The Id of the message. This Id is server generated.
recipient

The Id of the event recipient.
sender

The Id of the event sender.
senderDisplayName

The display name of the event sender.
threadId

Thread Id of the event.
type

Type of the chat message. Possible types are "Text" and "RichText/Html".
version

Version of the message. This version is an epoch time in a numeric unsigned Int64 format: 1593117207131

Property Details

attachments

Chat message attachments.

attachments?: ChatAttachment[]

Property Value

@azure/communication-signaling.ChatAttachment[]

message

Content of the message.

message: string

Property Value

string

metadata

Metadata of the message.

metadata: Record<string, string>

Property Value

Record<string, string>

Inherited Property Details

createdOn

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

createdOn: Date

Property Value

Date

Inherited From BaseChatMessageEvent.createdOn

id

The Id of the message. This Id is server generated.

id: string

Property Value

string

Inherited From BaseChatMessageEvent.id

recipient

The Id of the event recipient.

recipient: CommunicationIdentifierKind

Property Value

@azure/communication-signaling.CommunicationIdentifierKind

Inherited From BaseChatMessageEvent.recipient

sender

The Id of the event sender.

sender: CommunicationIdentifierKind

Property Value

@azure/communication-signaling.CommunicationIdentifierKind

Inherited From BaseChatMessageEvent.sender

senderDisplayName

The display name of the event sender.

senderDisplayName: string

Property Value

string

Inherited From BaseChatMessageEvent.senderDisplayName

threadId

Thread Id of the event.

threadId: string

Property Value

string

Inherited From BaseChatMessageEvent.threadId

type

Type of the chat message. Possible types are "Text" and "RichText/Html".

type: string

Property Value

string

Inherited From BaseChatMessageEvent.type

version

Version of the message. This version is an epoch time in a numeric unsigned Int64 format: 1593117207131

version: string

Property Value

string

Inherited From BaseChatMessageEvent.version