GroupSendToAllOptions interface

Package:

@azure/web-pubsub

Options for sending messages to a group.

Extends

OperationOptions

Properties

excludedConnections	Connection ids to exclude from receiving this message.
filter	The filter syntax to filter out the connections to send the messages to following OData filter syntax. Examples: Exclude connections from user1 and user2: userId ne 'user1' and userId ne 'user2' Exclude connections in group1: not('group1' in groups) Details about filter syntax please see OData filter syntax for Azure Web PubSub.
messageTtlSeconds	The time-to-live (TTL) value in seconds for messages sent to the service. 0 is the default value, which means the message never expires. 300 is the maximum value. If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service. This parameter can help when the client's bandwidth is limited.

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

excludedConnections

Connection ids to exclude from receiving this message.

excludedConnections?: string[]

Property Value

string[]

filter

The filter syntax to filter out the connections to send the messages to following OData filter syntax. Examples:

• Exclude connections from user1 and user2: userId ne 'user1' and userId ne 'user2'
• Exclude connections in group1: not('group1' in groups) Details about filter syntax please see OData filter syntax for Azure Web PubSub.

filter?: string

Property Value

string

messageTtlSeconds

The time-to-live (TTL) value in seconds for messages sent to the service. 0 is the default value, which means the message never expires. 300 is the maximum value. If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service. This parameter can help when the client's bandwidth is limited.

messageTtlSeconds?: number

Property Value

number

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