GroupSendToAllOptions interface

Pakket:

@azure/web-pubsub

Opties voor het verzenden van berichten naar een groep.

Uitbreiding

OperationOptions

Eigenschappen

excludedConnections	Verbindings-id's die moeten worden uitgesloten van het ontvangen van dit bericht.
filter	De filtersyntaxis voor het filteren van de verbindingen om de berichten te verzenden naar de volgende OData-filtersyntaxis. Voorbeelden: Verbindingen uitsluiten van user1 en user2: userId ne 'user1' and userId ne 'user2' Sluit verbindingen uit in group1: not('group1' in groups) Details over filter syntaxis raadpleegt u OData-filtersyntaxis voor Azure Web PubSub.
messageTtlSeconds	De TTL-waarde (Time-to-Live) in seconden voor berichten die naar de service worden verzonden. 0 is de standaardwaarde, wat betekent dat het bericht nooit verloopt. 300 is de maximumwaarde. Als deze parameter niet nul is, worden berichten die niet door de client binnen de opgegeven TTL worden verbruikt, verwijderd door de service. Deze parameter kan helpen wanneer de bandbreedte van de client beperkt is.

Overgenomen eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
onResponse	Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
requestOptions	Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
serializerOptions	Opties voor het overschrijven van serialisatie/deserialisatiegedrag.
tracingOptions	Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

excludedConnections

Verbindings-id's die moeten worden uitgesloten van het ontvangen van dit bericht.

excludedConnections?: string[]

Waarde van eigenschap

string[]

filter

De filtersyntaxis voor het filteren van de verbindingen om de berichten te verzenden naar de volgende OData-filtersyntaxis. Voorbeelden:

• Verbindingen uitsluiten van user1 en user2: userId ne 'user1' and userId ne 'user2'
• Sluit verbindingen uit in group1: not('group1' in groups) Details over filter syntaxis raadpleegt u OData-filtersyntaxis voor Azure Web PubSub.

filter?: string

Waarde van eigenschap

string

messageTtlSeconds

De TTL-waarde (Time-to-Live) in seconden voor berichten die naar de service worden verzonden. 0 is de standaardwaarde, wat betekent dat het bericht nooit verloopt. 300 is de maximumwaarde. Als deze parameter niet nul is, worden berichten die niet door de client binnen de opgegeven TTL worden verbruikt, verwijderd door de service. Deze parameter kan helpen wanneer de bandbreedte van de client beperkt is.

messageTtlSeconds?: number

Waarde van eigenschap

number

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

overgenomen van OperationOptions.abortSignal

onResponse

Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

overgenomen van OperationOptions.onResponse

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

overgenomen van OperationOptions.requestOptions

serializerOptions

Opties voor het overschrijven van serialisatie/deserialisatiegedrag.

serializerOptions?: SerializerOptions

Waarde van eigenschap

SerializerOptions

overgenomen van OperationOptions.serializerOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen van OperationOptions.tracingOptions