ListMessagesOptionalParams interface

Paket:

@azure/web-pubsub-chat

Optionale Parameter.

Extends

OperationOptions

Eigenschaften

earliestMessageId	Früheste Nachrichten-ID (exklusiv) für die Paginierung.
latestMessageId	Neueste Nachrichten-ID (exklusiv) für Paginierung.
maxPageSize	Die maximale Anzahl von Ergebniselementen pro Seite.

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
onResponse	Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.
requestOptions	Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
tracingOptions	Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

earliestMessageId

Früheste Nachrichten-ID (exklusiv) für die Paginierung.

earliestMessageId?: string

Eigenschaftswert

string

latestMessageId

Neueste Nachrichten-ID (exklusiv) für Paginierung.

latestMessageId?: string

Eigenschaftswert

string

maxPageSize

Die maximale Anzahl von Ergebniselementen pro Seite.

maxPageSize?: number

Eigenschaftswert

number

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

Geerbt von OperationOptions.abortSignal

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

RawResponseCallback

Geerbt von OperationOptions.onResponse

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

OperationRequestOptions

Geerbt von OperationOptions.requestOptions

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

Geerbt von OperationOptions.tracingOptions