WebPubSubServiceClient.SendToGroupAsync Method

Definition

Namespace:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Package:

Azure.Messaging.WebPubSub v1.4.0

Overloads

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

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

Source:

WebPubSubServiceClient.cs

Send content inside request body to a group of connections.

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

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

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

Parameters

group

String

Target group name, which length should be greater than 0 and less than 1025.

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

group or content is null.

ArgumentException

group is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call SendToGroupAsync 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.SendToGroupAsync("<group>", RequestContent.Create(data), ContentType.ApplicationOctetStream);
Console.WriteLine(response.Status);

This sample shows how to call SendToGroupAsync 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.SendToGroupAsync("<group>", 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
              }
            }

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

Source:

WebPubSubServiceClient.cs

[Protocol Method] Send content inside request body to a group of 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> SendToGroupAsync (string group, Azure.Core.RequestContent content, Azure.Core.ContentType contentType, System.Collections.Generic.IEnumerable<string> excluded = default, string filter = default, Azure.RequestContext context = default);

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

Public Overridable Function SendToGroupAsync (group As String, 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

group

String

Target group name, which length should be greater than 0 and less than 1025.

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

group or content is null.

ArgumentException

group is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call SendToGroupAsync.

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

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

Console.WriteLine(response.Status);

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

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

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

Console.WriteLine(response.Status);

SendToGroupAsync(String, String, ContentType)

Source:

WebPubSubServiceClient.cs

Send message to a group of connections.

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

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

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

Parameters

group

String

Target group name, which length should be greater than 0 and less than 1025.

content

String

contentType

ContentType

Defaults to ContentType.PlainText.

Returns

Task<Response>

A Response if successful.