GroupSendTextToAllOptions interface
Options for sending text messages to a group..
- Extends
Properties
content |
The content will be sent to the clients in plain text. |
Inherited Properties
abort |
The signal which can be used to abort requests. |
excluded |
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:
|
on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
request |
Options used when creating and sending HTTP requests for this operation. |
serializer |
Options to override serialization/de-serialization behavior. |
tracing |
Options used when tracing is enabled. |
Property Details
contentType
The content will be sent to the clients in plain text.
contentType: "text/plain"
Property Value
"text/plain"
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
Inherited From GroupSendToAllOptions.abortSignal
excludedConnections
Connection ids to exclude from receiving this message.
excludedConnections?: string[]
Property Value
string[]
Inherited From GroupSendToAllOptions.excludedConnections
filter
The filter syntax to filter out the connections to send the messages to following OData filter syntax. Examples:
- Exclude connections from
user1
anduser2
:userId ne 'user1' and userId ne 'user2'
- Exclude connections in
group1
:not('group1' in groups)
Details aboutfilter
syntax please see OData filter syntax for Azure Web PubSub.
filter?: string
Property Value
string
Inherited From GroupSendToAllOptions.filter
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
Inherited From GroupSendToAllOptions.onResponse
requestOptions
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptions
Property Value
Inherited From GroupSendToAllOptions.requestOptions
serializerOptions
Options to override serialization/de-serialization behavior.
serializerOptions?: SerializerOptions
Property Value
Inherited From GroupSendToAllOptions.serializerOptions
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptions
Property Value
Inherited From GroupSendToAllOptions.tracingOptions