WebPubSubServiceClient.SendToAllAsync Method

Definition

Namespace:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Package:

Azure.Messaging.WebPubSub v1.4.0

Overloads

SendToAllAsync(RequestContent, ContentType, IEnumerable<String>, String, RequestContext)	[Protocol Method] Broadcast content inside request body to all the connected client connections. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
SendToAllAsync(String, ContentType)	Broadcast message to all the connected client connections.
SendToAllAsync(RequestContent, ContentType, IEnumerable<String>, RequestContext)	Broadcast content inside request body to all the connected client connections.

SendToAllAsync(RequestContent, ContentType, IEnumerable<String>, String, RequestContext)

Source:

WebPubSubServiceClient.cs

[Protocol Method] Broadcast content inside request body to all the connected client connections.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual System.Threading.Tasks.Task<Azure.Response> SendToAllAsync (Azure.Core.RequestContent content, Azure.Core.ContentType contentType, System.Collections.Generic.IEnumerable<string> excluded = default, string filter = default, Azure.RequestContext context = default);

abstract member SendToAllAsync : Azure.Core.RequestContent * Azure.Core.ContentType * seq<string> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.SendToAllAsync : Azure.Core.RequestContent * Azure.Core.ContentType * seq<string> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function SendToAllAsync (content As RequestContent, contentType As ContentType, Optional excluded As IEnumerable(Of String) = Nothing, Optional filter As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

content

RequestContent

The content to send as the body of the request.

contentType

ContentType

Upload file type. Allowed values: "application/json" | "application/octet-stream" | "text/plain".

excluded

IEnumerable<String>

Excluded connection Ids.

filter

String

Following OData filter syntax to filter out the subscribers receiving the messages.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

content is null.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call SendToAllAsync.

WebPubSubServiceClient client = new WebPubSubServiceClient("<Endpoint>", "<Hub>");

using RequestContent content = RequestContent.Create(File.OpenRead("<filePath>"));
Response response = await client.SendToAllAsync(content, new ContentType("application/json"));

Console.WriteLine(response.Status);

This sample shows how to call SendToAllAsync with all parameters and request content.

WebPubSubServiceClient client = new WebPubSubServiceClient("<Endpoint>", "<Hub>");

using RequestContent content = RequestContent.Create(File.OpenRead("<filePath>"));
Response response = await client.SendToAllAsync(content, new ContentType("application/json"), excluded: new string[] { "<excluded>" }, filter: "<filter>");

Console.WriteLine(response.Status);

SendToAllAsync(String, ContentType)

Source:

WebPubSubServiceClient.cs

Broadcast message to all the connected client connections.

public virtual System.Threading.Tasks.Task<Azure.Response> SendToAllAsync (string content, Azure.Core.ContentType contentType = default);

abstract member SendToAllAsync : string * Azure.Core.ContentType -> System.Threading.Tasks.Task<Azure.Response>
override this.SendToAllAsync : string * Azure.Core.ContentType -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function SendToAllAsync (content As String, Optional contentType As ContentType = Nothing) As Task(Of Response)

Parameters

content

String

contentType

ContentType

Defaults to ContentType.PlainText.

Returns

Task<Response>

A Response if successful.

SendToAllAsync(RequestContent, ContentType, IEnumerable<String>, RequestContext)

Source:

WebPubSubServiceClient.cs

Broadcast content inside request body to all the connected client connections.

public virtual System.Threading.Tasks.Task<Azure.Response> SendToAllAsync (Azure.Core.RequestContent content, Azure.Core.ContentType contentType, System.Collections.Generic.IEnumerable<string> excluded, Azure.RequestContext context);

abstract member SendToAllAsync : Azure.Core.RequestContent * Azure.Core.ContentType * seq<string> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.SendToAllAsync : Azure.Core.RequestContent * Azure.Core.ContentType * seq<string> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function SendToAllAsync (content As RequestContent, contentType As ContentType, excluded As IEnumerable(Of String), context As RequestContext) As Task(Of Response)

Parameters

content

RequestContent

The content to send as the body of the request. Details of the request body schema are in the Remarks section below.

contentType

ContentType

Upload file type. Allowed values: "application/json" | "application/octet-stream" | "text/plain".

excluded

IEnumerable<String>

Excluded connection Ids.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

content is null.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call SendToAllAsync with required parameters and request content.

var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");

var data = File.OpenRead("<filePath>");

Response response = await client.SendToAllAsync(RequestContent.Create(data), ContentType.ApplicationOctetStream);
Console.WriteLine(response.Status);

This sample shows how to call SendToAllAsync with all parameters and request content.

var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");

var data = File.OpenRead("<filePath>");

Response response = await client.SendToAllAsync(RequestContent.Create(data), ContentType.ApplicationOctetStream, new String[]{"<excluded>"});
Console.WriteLine(response.Status);

Remarks

Schema for Response Error:

{
              code: string,
              message: string,
              target: string,
              details: [ErrorDetail],
              inner: {
                code: string,
                inner: InnerError
              }
            }