WebPubSubServiceClient Class

Definition

Namespace:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Package:

Azure.Messaging.WebPubSub v1.3.0

Source:

WebPubSubServiceClient.cs

The WebPubSubService service client.

public class WebPubSubServiceClient

type WebPubSubServiceClient = class

Public Class WebPubSubServiceClient

Inheritance

Object

WebPubSubServiceClient

Constructors

WebPubSubServiceClient()	Initializes a new instance of WebPubSubServiceClient for mocking.
WebPubSubServiceClient(String, String)	Initializes a new instance of the WebPubSubServiceClient.
WebPubSubServiceClient(String, String, WebPubSubServiceClientOptions)	Initializes a new instance of the WebPubSubServiceClient.
WebPubSubServiceClient(Uri, String, AzureKeyCredential)	Initializes a new instance of WebPubSubServiceClient.
WebPubSubServiceClient(Uri, String, AzureKeyCredential, WebPubSubServiceClientOptions)	Initializes a new instance of WebPubSubServiceClient.
WebPubSubServiceClient(Uri, String, TokenCredential)	Initializes a new instance of WebPubSubServiceClient.
WebPubSubServiceClient(Uri, String, TokenCredential, WebPubSubServiceClientOptions)	Initializes a new instance of WebPubSubServiceClient.

Properties

Endpoint	The service endpoint.
Hub	The hub.
Pipeline	The HTTP pipeline for sending and receiving REST requests and responses.

Methods

AddConnectionToGroup(String, String, RequestContext)	Add a connection to the target group.
AddConnectionToGroupAsync(String, String, RequestContext)	Add a connection to the target group.
AddUserToGroup(String, String, RequestContext)	Add a user to the target group.
AddUserToGroupAsync(String, String, RequestContext)	Add a user to the target group.
CheckPermission(WebPubSubPermission, String, String, RequestContext)	Check if a connection has permission to the specified action.
CheckPermissionAsync(WebPubSubPermission, String, String, RequestContext)	Check if a connection has permission to the specified action.
CloseAllConnections(IEnumerable<String>, String, RequestContext)	Close the connections in the hub.
CloseAllConnectionsAsync(IEnumerable<String>, String, RequestContext)	Close the connections in the hub.
CloseConnection(String, String, RequestContext)	Close the client connection.
CloseConnectionAsync(String, String, RequestContext)	Close the client connection.
CloseGroupConnections(String, IEnumerable<String>, String, RequestContext)	Close connections in the specific group.
CloseGroupConnectionsAsync(String, IEnumerable<String>, String, RequestContext)	Close connections in the specific group.
CloseUserConnections(String, IEnumerable<String>, String, RequestContext)	Close connections for the specific user.
CloseUserConnectionsAsync(String, IEnumerable<String>, String, RequestContext)	Close connections for the specific user.
ConnectionExists(String, RequestContext)	Check if the connection with the given connectionId exists.
ConnectionExistsAsync(String, RequestContext)	Check if the connection with the given connectionId exists.
GetClientAccessUri(DateTimeOffset, String, IEnumerable<String>, CancellationToken)	Creates a URI with authentication token.
GetClientAccessUri(DateTimeOffset, String, IEnumerable<String>, IEnumerable<String>, CancellationToken)	Creates a URI with authentication token.
GetClientAccessUri(TimeSpan, String, IEnumerable<String>, CancellationToken)	Creates a URI with authentication token.
GetClientAccessUri(TimeSpan, String, IEnumerable<String>, IEnumerable<String>, CancellationToken)	Creates a URI with authentication token.
GetClientAccessUriAsync(DateTimeOffset, String, IEnumerable<String>, CancellationToken)	Creates a URI with authentication token.
GetClientAccessUriAsync(DateTimeOffset, String, IEnumerable<String>, IEnumerable<String>, CancellationToken)	Creates a URI with authentication token.
GetClientAccessUriAsync(TimeSpan, String, IEnumerable<String>, CancellationToken)	Creates a URI with authentication token.
GetClientAccessUriAsync(TimeSpan, String, IEnumerable<String>, IEnumerable<String>, CancellationToken)	Creates a URI with authentication token.
GrantPermission(WebPubSubPermission, String, String, RequestContext)	Grant permission to the connection.
GrantPermissionAsync(WebPubSubPermission, String, String, RequestContext)	Grant permission to the connection.
GroupExists(String, RequestContext)	Check if there are any client connections inside the given group.
GroupExistsAsync(String, RequestContext)	Check if there are any client connections inside the given group.
RemoveConnectionFromAllGroups(String, RequestContext)	Remove a connection from all groups.
RemoveConnectionFromAllGroupsAsync(String, RequestContext)	Remove a connection from all groups.
RemoveConnectionFromGroup(String, String, RequestContext)	Remove a connection from the target group.
RemoveConnectionFromGroupAsync(String, String, RequestContext)	Remove a connection from the target group.
RemoveUserFromAllGroups(String, RequestContext)	Remove a user from all groups.
RemoveUserFromAllGroupsAsync(String, RequestContext)	Remove a user from all groups.
RemoveUserFromGroup(String, String, RequestContext)	Remove a user from the target group.
RemoveUserFromGroupAsync(String, String, RequestContext)	Remove a user from the target group.
RevokePermission(WebPubSubPermission, String, String, RequestContext)	Revoke permission for the connection.
RevokePermissionAsync(WebPubSubPermission, String, String, RequestContext)	Revoke permission for the connection.
SendToAll(RequestContent, ContentType, IEnumerable<String>, RequestContext)	Broadcast content inside request body to all the connected client connections.
SendToAll(RequestContent, ContentType, IEnumerable<String>, String, RequestContext)	Broadcast content inside request body to all the connected client connections.
SendToAll(String, ContentType)	Broadcast message to all the connected client connections.
SendToAllAsync(RequestContent, ContentType, IEnumerable<String>, RequestContext)	Broadcast content inside request body to all the connected client connections.
SendToAllAsync(RequestContent, ContentType, IEnumerable<String>, String, RequestContext)	Broadcast content inside request body to all the connected client connections.
SendToAllAsync(String, ContentType)	Broadcast message to all the connected client connections.
SendToConnection(String, RequestContent, ContentType, RequestContext)	Send content inside request body to the specific connection.
SendToConnection(String, String, ContentType)	Send message to the specific connection.
SendToConnectionAsync(String, RequestContent, ContentType, RequestContext)	Send content inside request body to the specific connection.
SendToConnectionAsync(String, String, ContentType)	Send message to the specific connection.
SendToGroup(String, RequestContent, ContentType, IEnumerable<String>, RequestContext)	Send content inside request body to a group of connections.
SendToGroup(String, RequestContent, ContentType, IEnumerable<String>, String, RequestContext)	Send content inside request body to a group of connections.
SendToGroup(String, String, ContentType)	Send message to a group of connections.
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)	Send content inside request body to a group of connections.
SendToGroupAsync(String, String, ContentType)	Send message to a group of connections.
SendToUser(String, RequestContent, ContentType, RequestContext)	Send content inside request body to the specific user.
SendToUser(String, RequestContent, ContentType, String, RequestContext)	Send content inside request body to the specific user.
SendToUser(String, String, ContentType)	Send message to the specific user.
SendToUserAsync(String, RequestContent, ContentType, RequestContext)	Send content inside request body to the specific user.
SendToUserAsync(String, RequestContent, ContentType, String, RequestContext)	Send content inside request body to the specific user.
SendToUserAsync(String, String, ContentType)	Send message to the specific user.
UserExists(String, RequestContext)	Check if there are any client connections connected for the given user.
UserExistsAsync(String, RequestContext)	Check if there are any client connections connected for the given user.