HubSendTextToAllOptions interface

Paket:: @azure/web-pubsub

Optionen zum Senden von Textnachrichten an Hubs.

Extends: HubSendToAllOptions

Eigenschaften

Der Inhalt wird an die Clients in Nur-Text gesendet.

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
excludedConnections	Verbindungs-IDs, die vom Empfang dieser Nachricht ausgeschlossen werden sollen.
filter	Die Filtersyntax zum Filtern der Verbindungen zum Senden der Nachrichten an die folgende OData-Filtersyntax. Beispiele: Verbindungen von `user1` und `user2`ausschließen: `userId ne 'user1' and userId ne 'user2'` Verbindungen in `group1`ausschließen: `not('group1' in groups)` Details zu `filter` Syntax finden Sie unter OData-Filtersyntax für Azure Web PubSub.
messageTtlSeconds	Der Zeit-zu-Live-Wert (TTL) in Sekunden für Nachrichten, die an den Dienst gesendet werden. 0 ist der Standardwert, was bedeutet, dass die Nachricht nie abläuft. 300 ist der Maximalwert. Wenn dieser Parameter ungleich Null ist, werden nachrichten, die nicht vom Client innerhalb der angegebenen TTL verwendet werden, vom Dienst gelöscht. Dieser Parameter kann hilfreich sein, wenn die Bandbreite des Clients begrenzt ist.
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.
serializerOptions	Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.
tracingOptions	Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

contentType

Der Inhalt wird an die Clients in Nur-Text gesendet.

contentType: "text/plain"

Eigenschaftswert

"text/plain"

Geerbte Eigenschaftsdetails

abortSignal

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

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

vonHubSendToAllOptions.abortSignal

excludedConnections

Verbindungs-IDs, die vom Empfang dieser Nachricht ausgeschlossen werden sollen.

excludedConnections?: string[]

Eigenschaftswert

string[]

vonHubSendToAllOptions.excludedConnections

filter

Die Filtersyntax zum Filtern der Verbindungen zum Senden der Nachrichten an die folgende OData-Filtersyntax. Beispiele:

Verbindungen von user1 und user2ausschließen: userId ne 'user1' and userId ne 'user2'
Verbindungen in group1ausschließen: not('group1' in groups) Details zu filter Syntax finden Sie unter OData-Filtersyntax für Azure Web PubSub.

filter?: string

Eigenschaftswert

string

vonHubSendToAllOptions.filter geerbt

messageTtlSeconds

Der Zeit-zu-Live-Wert (TTL) in Sekunden für Nachrichten, die an den Dienst gesendet werden. 0 ist der Standardwert, was bedeutet, dass die Nachricht nie abläuft. 300 ist der Maximalwert. Wenn dieser Parameter ungleich Null ist, werden nachrichten, die nicht vom Client innerhalb der angegebenen TTL verwendet werden, vom Dienst gelöscht. Dieser Parameter kann hilfreich sein, wenn die Bandbreite des Clients begrenzt ist.

messageTtlSeconds?: number

Eigenschaftswert

number

vonHubSendToAllOptions.messageTtlSeconds geerbt

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 vonHubSendToAllOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Eigenschaftswert

OperationRequestOptions

geerbt vonHubSendToAllOptions.requestOptions

serializerOptions

Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

SerializerOptions

vonHubSendToAllOptions.serializerOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

vonHubSendToAllOptions.tracingOptions