WebPubSubServiceClient.SendToAllAsync メソッド

定義

名前空間:

Azure.Messaging.WebPubSub

アセンブリ:

Azure.Messaging.WebPubSub.dll

パッケージ:

Azure.Messaging.WebPubSub v1.3.0

オーバーロード

SendToAllAsync(RequestContent, ContentType, IEnumerable<String>, RequestContext)	接続されているすべてのクライアント接続に要求本文内のコンテンツをブロードキャストします。
SendToAllAsync(RequestContent, ContentType, IEnumerable<String>, String, RequestContext)	接続されているすべてのクライアント接続に要求本文内のコンテンツをブロードキャストします。
SendToAllAsync(String, ContentType)	接続されているすべてのクライアント接続にメッセージをブロードキャストします。

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

Source:

WebPubSubServiceClient.cs

接続されているすべてのクライアント接続に要求本文内のコンテンツをブロードキャストします。

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)

パラメーター

content

RequestContent

要求の本文として送信するコンテンツ。 要求本文スキーマの詳細については、以下の「解説」セクションを参照してください。

contentType

ContentType

ファイルの種類をアップロードします。 使用できる値: "application/json" |"application/octet-stream" |"text/plain"

excluded

IEnumerable<String>

除外された接続 ID。

context

RequestContext

要求コンテキスト。これは、呼び出しごとにクライアント パイプラインの既定の動作をオーバーライドできます。

戻り値

Task<Response>

サービスから返された応答。

例外

ArgumentNullException

content が null です。

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、必要なパラメーターと要求コンテンツを使用して SendToAllAsync を呼び出す方法を示します。

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

このサンプルでは、すべてのパラメーターと要求コンテンツを使用して SendToAllAsync を呼び出す方法を示します。

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

注釈

の Response Errorスキーマ:

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

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

Source:

WebPubSubServiceClient.cs

接続されているすべてのクライアント接続に要求本文内のコンテンツをブロードキャストします。

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)

パラメーター

content

RequestContent

要求の本文として送信するコンテンツ。 要求本文スキーマの詳細については、以下の「解説」セクションを参照してください。

contentType

ContentType

ファイルの種類をアップロードします。 使用できる値: "application/json" |"application/octet-stream" |"text/plain"

excluded

IEnumerable<String>

除外された接続 ID。

filter

String

OData フィルター構文に従って、メッセージを受信するサブスクライバーを除外します。

context

RequestContext

要求コンテキスト。これは、呼び出しごとにクライアント パイプラインの既定の動作をオーバーライドできます。

戻り値

Task<Response>

サービスから返された応答。

例外

ArgumentNullException

content が null です。

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、必要なパラメーターと要求コンテンツを使用して SendToAllAsync を呼び出す方法を示します。

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

このサンプルでは、すべてのパラメーターと要求コンテンツを使用して SendToAllAsync を呼び出す方法を示します。

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

SendToAllAsync(String, ContentType)

Source:

WebPubSubServiceClient.cs

接続されているすべてのクライアント接続にメッセージをブロードキャストします。

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)

パラメーター

content

String

contentType

ContentType

既定値は ContentType.PlainText です。

戻り値

Task<Response>

成功した場合は Response 。