WebPubSubServiceClient.SendToConnection Method

Definition

Namespace:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Package:

Azure.Messaging.WebPubSub v1.3.0

Overloads

SendToConnection(String, String, ContentType)	Send message to the specific connection.
SendToConnection(String, RequestContent, ContentType, RequestContext)	Send content inside request body to the specific connection.

SendToConnection(String, String, ContentType)

Source:

WebPubSubServiceClient_extensions.cs

Send message to the specific connection.

public virtual Azure.Response SendToConnection (string connectionId, string content, Azure.Core.ContentType contentType = default);

abstract member SendToConnection : string * string * Azure.Core.ContentType -> Azure.Response
override this.SendToConnection : string * string * Azure.Core.ContentType -> Azure.Response

Public Overridable Function SendToConnection (connectionId As String, content As String, Optional contentType As ContentType = Nothing) As Response

Parameters

connectionId

String

The connection Id.

content

String

contentType

ContentType

Defaults to ContentType.PlainText.

Returns

Response

A Response if successful.

SendToConnection(String, RequestContent, ContentType, RequestContext)

Source:

WebPubSubServiceClient.cs

Send content inside request body to the specific connection.

public virtual Azure.Response SendToConnection (string connectionId, Azure.Core.RequestContent content, Azure.Core.ContentType contentType, Azure.RequestContext context = default);

abstract member SendToConnection : string * Azure.Core.RequestContent * Azure.Core.ContentType * Azure.RequestContext -> Azure.Response
override this.SendToConnection : string * Azure.Core.RequestContent * Azure.Core.ContentType * Azure.RequestContext -> Azure.Response

Public Overridable Function SendToConnection (connectionId As String, content As RequestContent, contentType As ContentType, Optional context As RequestContext = Nothing) As Response

Parameters

connectionId

String

The connection Id.

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".

context

RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

connectionId or content is null.

ArgumentException

connectionId 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 SendToConnection with required parameters and request content.

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

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

Response response = client.SendToConnection("<connectionId>", RequestContent.Create(data), ContentType.ApplicationOctetStream);
Console.WriteLine(response.Status);

Remarks

Schema for Response Error:

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