RestListMessagesOptions interface

  • Reference
Package:
@azure/communication-chat

Optional parameters.

Extends
OperationOptions

Properties

maxPageSize

The maximum number of messages to be returned per page.
startTime

The earliest point in time to get messages up to. The timestamp should be in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

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

maxPageSize

The maximum number of messages to be returned per page.

maxPageSize?: number

Property Value

number

startTime

The earliest point in time to get messages up to. The timestamp should be in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

startTime?: Date

Property Value

Date

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From coreClient.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 coreClient.OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From coreClient.OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From coreClient.OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From coreClient.OperationOptions.tracingOptions