WebPubSubServiceClient.SendToGroupAsync Método

Definição

Namespace:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Pacote:

Azure.Messaging.WebPubSub v1.3.0

Sobrecargas

SendToGroupAsync(String, RequestContent, ContentType, IEnumerable<String>, RequestContext)	Enviar conteúdo dentro do corpo da solicitação para um grupo de conexões.
SendToGroupAsync(String, RequestContent, ContentType, IEnumerable<String>, String, RequestContext)	Enviar conteúdo dentro do corpo da solicitação para um grupo de conexões.
SendToGroupAsync(String, String, ContentType)	Enviar mensagem para um grupo de conexões.

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

Origem:

WebPubSubServiceClient.cs

Enviar conteúdo dentro do corpo da solicitação para um grupo de conexões.

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)

Parâmetros

group

String

Nome do grupo de destino, cujo comprimento deve ser maior que 0 e menor que 1025.

content

RequestContent

O conteúdo a ser enviado como o corpo da solicitação. Os detalhes do esquema do corpo da solicitação estão na seção Comentários abaixo.

contentType

ContentType

Tipo de arquivo de upload. Valores permitidos: "application/json" | "application/octet-stream" | "text/plain".

excluded

IEnumerable<String>

IDs de conexão excluídas.

context

RequestContext

O contexto de solicitação, que pode substituir os comportamentos padrão do pipeline do cliente por chamada.

Retornos

Task<Response>

A resposta retornada do serviço.

Exceções

ArgumentNullException

group ou content é nulo.

ArgumentException

group é uma cadeia de caracteres vazia e esperava-se que não estivesse vazia.

RequestFailedException

O serviço retornou um código de status sem êxito.

Exemplos

Este exemplo mostra como chamar SendToGroupAsync com os parâmetros necessários e o conteúdo da solicitação.

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);

Este exemplo mostra como chamar SendToGroupAsync com todos os parâmetros e conteúdo da solicitação.

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);

Comentários

Esquema para Response Error:

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

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

Origem:

WebPubSubServiceClient.cs

Enviar conteúdo dentro do corpo da solicitação para um grupo de conexões.

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)

Parâmetros

group

String

Nome do grupo de destino, cujo comprimento deve ser maior que 0 e menor que 1025.

content

RequestContent

O conteúdo a ser enviado como o corpo da solicitação. Os detalhes do esquema do corpo da solicitação estão na seção Comentários abaixo.

contentType

ContentType

Tipo de arquivo de upload. Valores permitidos: "application/json" | "application/octet-stream" | "text/plain".

excluded

IEnumerable<String>

IDs de conexão excluídas.

filter

String

Seguindo a sintaxe de filtro OData para filtrar os assinantes que recebem as mensagens.

context

RequestContext

O contexto de solicitação, que pode substituir os comportamentos padrão do pipeline do cliente por chamada.

Retornos

Task<Response>

A resposta retornada do serviço.

Exceções

ArgumentNullException

group ou content é nulo.

ArgumentException

group é uma cadeia de caracteres vazia e esperava-se que não estivesse vazia.

RequestFailedException

O serviço retornou um código de status sem êxito.

Exemplos

Este exemplo mostra como chamar SendToGroupAsync com os parâmetros necessários e o conteúdo da solicitação.

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);

Este exemplo mostra como chamar SendToGroupAsync com todos os parâmetros e conteúdo da solicitação.

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>"}, "<filter>");
Console.WriteLine(response.Status);

SendToGroupAsync(String, String, ContentType)

Origem:

WebPubSubServiceClient.cs

Enviar mensagem para um grupo de conexões.

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)

Parâmetros

group

String

Nome do grupo de destino, cujo comprimento deve ser maior que 0 e menor que 1025.

content

String

contentType

ContentType

O padrão é ContentType.PlainText.

Retornos

Task<Response>

Um Response se bem-sucedido.