WebPubSubServiceClient.AddUserToGroupAsync Method

Definition

Namespace:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Package:

Azure.Messaging.WebPubSub v1.4.0

Source:

WebPubSubServiceClient.cs

Add a user to the target group.

public virtual System.Threading.Tasks.Task<Azure.Response> AddUserToGroupAsync (string group, string userId, Azure.RequestContext context = default);

abstract member AddUserToGroupAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AddUserToGroupAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

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

userId

String

Target user Id.

context

RequestContext

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

Returns

Task<Response>

Exceptions

ArgumentNullException

userId or group is null.

Remarks

Schema for Response Error:

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