SendMessageOptions interface

Package:

@azure/communication-chat

Options to send a chat message.

Extends

OperationOptions

Properties

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

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.

Property Details

metadata

Message metadata.

metadata?: Record<string, string>

Property Value

Record<string, string>

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

type

The chat message type.

type?: ChatMessageType

Property Value

ChatMessageType

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions