WebPubSubServiceClient<THub> Class
Definition
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.
Web PubSub serivce client based on user implemented WebPubSubHub. Hub name is the class name of user implemented WebPubSubHub.
public class WebPubSubServiceClient<THub> : Azure.Messaging.WebPubSub.WebPubSubServiceClient where THub : WebPubSubHubtype WebPubSubServiceClient<'Hub (requires 'Hub :> WebPubSubHub)> = class
inherit WebPubSubServiceClientPublic Class WebPubSubServiceClient(Of THub)
Inherits WebPubSubServiceClientType Parameters
- THub
User implemented WebPubSubHub.
- Inheritance
Constructors
| Name | Description |
|---|---|
| WebPubSubServiceClient<THub>() |
Initializes a new instance of WebPubSubServiceClient for mocking. |
Properties
| Name | Description |
|---|---|
| Endpoint |
The service endpoint. (Inherited from WebPubSubServiceClient) |
| Hub |
The hub. (Inherited from WebPubSubServiceClient) |
| Pipeline |
The HTTP pipeline for sending and receiving REST requests and responses. (Inherited from WebPubSubServiceClient) |
Methods
| Name | Description |
|---|---|
| AddConnectionsToGroups(IEnumerable<String>, String, RequestContext) |
Add filtered connections to multiple groups. (Inherited from WebPubSubServiceClient) |
| AddConnectionsToGroupsAsync(IEnumerable<String>, String, RequestContext) |
Add filtered connections to multiple groups. (Inherited from WebPubSubServiceClient) |
| AddConnectionToGroup(String, String, RequestContext) |
[Protocol Method] Add a connection to the target group.
|
| AddConnectionToGroupAsync(String, String, RequestContext) |
[Protocol Method] Add a connection to the target group.
|
| AddUserToGroup(String, String, RequestContext) |
Add a user to the target group. (Inherited from WebPubSubServiceClient) |
| AddUserToGroupAsync(String, String, RequestContext) |
Add a user to the target group. (Inherited from WebPubSubServiceClient) |
| CheckPermission(WebPubSubPermission, String, String, RequestContext) |
Check if a connection has permission to the specified action. (Inherited from WebPubSubServiceClient) |
| CheckPermissionAsync(WebPubSubPermission, String, String, RequestContext) |
Check if a connection has permission to the specified action. (Inherited from WebPubSubServiceClient) |
| CloseAllConnections(IEnumerable<String>, String, RequestContext) |
[Protocol Method] Close the connections in the hub.
|
| CloseAllConnectionsAsync(IEnumerable<String>, String, RequestContext) |
[Protocol Method] Close the connections in the hub.
|
| CloseConnection(String, String, RequestContext) |
[Protocol Method] Close the client connection.
|
| CloseConnectionAsync(String, String, RequestContext) |
[Protocol Method] Close the client connection.
|
| CloseGroupConnections(String, IEnumerable<String>, String, RequestContext) |
[Protocol Method] Close connections in the specific group.
|
| CloseGroupConnectionsAsync(String, IEnumerable<String>, String, RequestContext) |
[Protocol Method] Close connections in the specific group.
|
| CloseUserConnections(String, IEnumerable<String>, String, RequestContext) |
[Protocol Method] Close connections for the specific user.
|
| CloseUserConnectionsAsync(String, IEnumerable<String>, String, RequestContext) |
[Protocol Method] Close connections for the specific user.
|
| ConnectionExists(String, RequestContext) |
Check if the connection with the given connectionId exists. (Inherited from WebPubSubServiceClient) |
| ConnectionExistsAsync(String, RequestContext) |
Check if the connection with the given connectionId exists. (Inherited from WebPubSubServiceClient) |
| GetClientAccessUri(DateTimeOffset, String, IEnumerable<String>, IEnumerable<String>, WebPubSubClientProtocol, CancellationToken) |
Creates a URI with authentication token for the clients. (Inherited from WebPubSubServiceClient) |
| GetClientAccessUri(TimeSpan, String, IEnumerable<String>, IEnumerable<String>, WebPubSubClientProtocol, CancellationToken) |
Creates a URI with authentication token for the clients. (Inherited from WebPubSubServiceClient) |
| GetClientAccessUriAsync(DateTimeOffset, String, IEnumerable<String>, IEnumerable<String>, WebPubSubClientProtocol, CancellationToken) |
Creates a URI with authentication token for the clients.. (Inherited from WebPubSubServiceClient) |
| GetClientAccessUriAsync(TimeSpan, String, IEnumerable<String>, IEnumerable<String>, WebPubSubClientProtocol, CancellationToken) |
Creates a URI with authentication token for the clients. (Inherited from WebPubSubServiceClient) |
| GrantPermission(WebPubSubPermission, String, String, RequestContext) |
Grant permission to the connection. (Inherited from WebPubSubServiceClient) |
| GrantPermissionAsync(WebPubSubPermission, String, String, RequestContext) |
Grant permission to the connection. (Inherited from WebPubSubServiceClient) |
| GroupExists(String, RequestContext) |
Check if there are any client connections inside the given group. (Inherited from WebPubSubServiceClient) |
| GroupExistsAsync(String, RequestContext) |
Check if there are any client connections inside the given group. (Inherited from WebPubSubServiceClient) |
| ListConnectionsInGroup(String, Nullable<Int32>, Nullable<Int32>, String) |
List all the connections in a group. (Inherited from WebPubSubServiceClient) |
| ListConnectionsInGroupAsync(String, Nullable<Int32>, Nullable<Int32>, String) |
List all the connections in a group. (Inherited from WebPubSubServiceClient) |
| RemoveConnectionFromAllGroups(String, RequestContext) |
[Protocol Method] Remove a connection from all groups.
|
| RemoveConnectionFromAllGroupsAsync(String, RequestContext) |
[Protocol Method] Remove a connection from all groups.
|
| RemoveConnectionFromGroup(String, String, RequestContext) |
[Protocol Method] Remove a connection from the target group.
|
| RemoveConnectionFromGroupAsync(String, String, RequestContext) |
[Protocol Method] Remove a connection from the target group.
|
| RemoveConnectionsFromGroups(IEnumerable<String>, String, RequestContext) |
Remove filtered connections from multiple groups. (Inherited from WebPubSubServiceClient) |
| RemoveConnectionsFromGroupsAsync(IEnumerable<String>, String, RequestContext) |
Remove filtered connections from multiple groups. (Inherited from WebPubSubServiceClient) |
| RemoveUserFromAllGroups(String, RequestContext) |
[Protocol Method] Remove a user from all groups.
|
| RemoveUserFromAllGroupsAsync(String, RequestContext) |
[Protocol Method] Remove a user from all groups.
|
| RemoveUserFromGroup(String, String, RequestContext) |
Remove a user from the target group. (Inherited from WebPubSubServiceClient) |
| RemoveUserFromGroupAsync(String, String, RequestContext) |
Remove a user from the target group. (Inherited from WebPubSubServiceClient) |
| RevokePermission(WebPubSubPermission, String, String, RequestContext) |
Revoke permission for the connection. (Inherited from WebPubSubServiceClient) |
| RevokePermissionAsync(WebPubSubPermission, String, String, RequestContext) |
Revoke permission for the connection. (Inherited from WebPubSubServiceClient) |
| SendToAll(RequestContent, ContentType, IEnumerable<String>, RequestContext) |
Broadcast content inside request body to all the connected client connections. (Inherited from WebPubSubServiceClient) |
| SendToAll(RequestContent, ContentType, IEnumerable<String>, String, RequestContext) |
[Protocol Method] Broadcast content inside request body to all the connected client connections.
|
| SendToAll(String, ContentType) |
Broadcast message to all the connected client connections. (Inherited from WebPubSubServiceClient) |
| SendToAllAsync(RequestContent, ContentType, IEnumerable<String>, RequestContext) |
Broadcast content inside request body to all the connected client connections. (Inherited from WebPubSubServiceClient) |
| SendToAllAsync(RequestContent, ContentType, IEnumerable<String>, String, RequestContext) |
[Protocol Method] Broadcast content inside request body to all the connected client connections.
|
| SendToAllAsync(String, ContentType) |
Broadcast message to all the connected client connections. (Inherited from WebPubSubServiceClient) |
| SendToConnection(String, RequestContent, ContentType, RequestContext) |
[Protocol Method] Send content inside request body to the specific connection.
|
| SendToConnection(String, String, ContentType) |
Send message to the specific connection. (Inherited from WebPubSubServiceClient) |
| SendToConnectionAsync(String, RequestContent, ContentType, RequestContext) |
[Protocol Method] Send content inside request body to the specific connection.
|
| SendToConnectionAsync(String, String, ContentType) |
Send message to the specific connection. (Inherited from WebPubSubServiceClient) |
| SendToGroup(String, RequestContent, ContentType, IEnumerable<String>, RequestContext) |
Send content inside request body to a group of connections. (Inherited from WebPubSubServiceClient) |
| SendToGroup(String, RequestContent, ContentType, IEnumerable<String>, String, RequestContext) |
[Protocol Method] Send content inside request body to a group of connections.
|
| SendToGroup(String, String, ContentType) |
Send message to a group of connections. (Inherited from WebPubSubServiceClient) |
| SendToGroupAsync(String, RequestContent, ContentType, IEnumerable<String>, RequestContext) |
Send content inside request body to a group of connections. (Inherited from WebPubSubServiceClient) |
| SendToGroupAsync(String, RequestContent, ContentType, IEnumerable<String>, String, RequestContext) |
[Protocol Method] Send content inside request body to a group of connections.
|
| SendToGroupAsync(String, String, ContentType) |
Send message to a group of connections. (Inherited from WebPubSubServiceClient) |
| SendToUser(String, RequestContent, ContentType, RequestContext) |
Send content inside request body to the specific user. (Inherited from WebPubSubServiceClient) |
| SendToUser(String, RequestContent, ContentType, String, RequestContext) |
[Protocol Method] Send content inside request body to the specific user.
|
| SendToUser(String, String, ContentType) |
Send message to the specific user. (Inherited from WebPubSubServiceClient) |
| SendToUserAsync(String, RequestContent, ContentType, RequestContext) |
Send content inside request body to the specific user. (Inherited from WebPubSubServiceClient) |
| SendToUserAsync(String, RequestContent, ContentType, String, RequestContext) |
[Protocol Method] Send content inside request body to the specific user.
|
| SendToUserAsync(String, String, ContentType) |
Send message to the specific user. (Inherited from WebPubSubServiceClient) |
| UserExists(String, RequestContext) |
Check if there are any client connections connected for the given user. (Inherited from WebPubSubServiceClient) |
| UserExistsAsync(String, RequestContext) |
Check if there are any client connections connected for the given user. (Inherited from WebPubSubServiceClient) |
