WebPubSubServiceClient Class

Reference

Definition

Namespace:: Azure.Messaging.WebPubSub

Assembly:: Azure.Messaging.WebPubSub.dll

Package:: Azure.Messaging.WebPubSub v1.4.0

Source:: WebPubSubServiceClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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, WebPubSubServiceClientOptions)	Initializes a new instance of the WebPubSubServiceClient.
WebPubSubServiceClient(String, String)	Initializes a new instance of the WebPubSubServiceClient.
WebPubSubServiceClient(Uri, String, AzureKeyCredential, WebPubSubServiceClientOptions)	Initializes a new instance of WebPubSubServiceClient.
WebPubSubServiceClient(Uri, String, AzureKeyCredential)	Initializes a new instance of WebPubSubServiceClient.
WebPubSubServiceClient(Uri, String, TokenCredential, WebPubSubServiceClientOptions)	Initializes a new instance of WebPubSubServiceClient.
WebPubSubServiceClient(Uri, String, TokenCredential)	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

AddConnectionsToGroups(IEnumerable<String>, String, RequestContext)	Add filtered connections to multiple groups.
AddConnectionsToGroupsAsync(IEnumerable<String>, String, RequestContext)	Add filtered connections to multiple groups.
AddConnectionToGroup(String, String, RequestContext)	[Protocol Method] Add a connection to the target group. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
AddConnectionToGroupAsync(String, String, RequestContext)	[Protocol Method] Add a connection to the target group. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
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)	[Protocol Method] Close the connections in the hub. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CloseAllConnectionsAsync(IEnumerable<String>, String, RequestContext)	[Protocol Method] Close the connections in the hub. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CloseConnection(String, String, RequestContext)	[Protocol Method] Close the client connection. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CloseConnectionAsync(String, String, RequestContext)	[Protocol Method] Close the client connection. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CloseGroupConnections(String, IEnumerable<String>, String, RequestContext)	[Protocol Method] Close connections in the specific group. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CloseGroupConnectionsAsync(String, IEnumerable<String>, String, RequestContext)	[Protocol Method] Close connections in the specific group. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CloseUserConnections(String, IEnumerable<String>, String, RequestContext)	[Protocol Method] Close connections for the specific user. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CloseUserConnectionsAsync(String, IEnumerable<String>, String, RequestContext)	[Protocol Method] Close connections for the specific user. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
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>, IEnumerable<String>, WebPubSubClientProtocol, CancellationToken)	Creates a URI with authentication token for the clients.
GetClientAccessUri(TimeSpan, String, IEnumerable<String>, IEnumerable<String>, WebPubSubClientProtocol, CancellationToken)	Creates a URI with authentication token for the clients.
GetClientAccessUriAsync(DateTimeOffset, String, IEnumerable<String>, IEnumerable<String>, WebPubSubClientProtocol, CancellationToken)	Creates a URI with authentication token for the clients..
GetClientAccessUriAsync(TimeSpan, String, IEnumerable<String>, IEnumerable<String>, WebPubSubClientProtocol, CancellationToken)	Creates a URI with authentication token for the clients.
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)	[Protocol Method] Remove a connection from all groups. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
RemoveConnectionFromAllGroupsAsync(String, RequestContext)	[Protocol Method] Remove a connection from all groups. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
RemoveConnectionFromGroup(String, String, RequestContext)	[Protocol Method] Remove a connection from the target group. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
RemoveConnectionFromGroupAsync(String, String, RequestContext)	[Protocol Method] Remove a connection from the target group. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
RemoveConnectionsFromGroups(IEnumerable<String>, String, RequestContext)	Remove filtered connections from multiple groups.
RemoveConnectionsFromGroupsAsync(IEnumerable<String>, String, RequestContext)	Remove filtered connections from multiple groups.
RemoveUserFromAllGroups(String, RequestContext)	[Protocol Method] Remove a user from all groups. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
RemoveUserFromAllGroupsAsync(String, RequestContext)	[Protocol Method] Remove a user from all groups. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
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)	[Protocol Method] Broadcast content inside request body to all the connected client connections. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
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)	[Protocol Method] Broadcast content inside request body to all the connected client connections. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
SendToAllAsync(String, ContentType)	Broadcast message to all the connected client connections.
SendToConnection(String, RequestContent, ContentType, RequestContext)	[Protocol Method] Send content inside request body to the specific connection. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
SendToConnection(String, String, ContentType)	Send message to the specific connection.
SendToConnectionAsync(String, RequestContent, ContentType, RequestContext)	[Protocol Method] Send content inside request body to the specific connection. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
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)	[Protocol Method] Send content inside request body to a group of connections. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
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)	[Protocol Method] Send content inside request body to a group of connections. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
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)	[Protocol Method] Send content inside request body to the specific user. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
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)	[Protocol Method] Send content inside request body to the specific user. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
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.

Applies to

Share via