@azure/web-pubsub package

Classes

WebPubSubServiceClient

Client for connecting to a Web PubSub hub

Interfaces

CloseConnectionOptions

Options for closing a connection to a hub.

GetAuthenticationTokenOptions

Options for auth a client

GetAuthenticationTokenResponse

Response for the authed client, including the url and the jwt token

GroupAddConnectionOptions

Options for adding a connection to a group.

GroupAddUserOptions

Options for adding a user to a group.

GroupAdminClientOptions

Options for constructing a GroupAdmin client.

GroupHasUserOptions

Options for checking if a user is in a group

GroupRemoveConnectionOptions

Options for removing a connection from a group

GroupRemoveUserOptions

Options for removing a user from a group

GroupSendTextToAllOptions

Options for sending text messages to a group..

GroupSendToAllOptions

Options for sending messages to a group.

HasConnectionOptions

Options for checking if a connection exists.

HubAdminClientOptions

Options for constructing a HubAdmin client.

HubGrantPermissionOptions

Options for grant permissions to a connection

HubHasGroupOptions

Options for checking if a group exists.

HubHasPermissionOptions

Options for check if a connection has the specified permission

HubHasUserOptions

Options for checking if a user exists.

HubRemoveUserFromAllGroupsOptions

Options for removing a user from all groups.

HubRevokePermissionOptions

Options for revoke permissions from a connection

HubSendTextToAllOptions

Options for sending text messages to hubs.

HubSendTextToConnectionOptions

Options for sending a text message to a connection.

HubSendTextToUserOptions

Options for sending a text message to a user.

HubSendToAllOptions

Options for sending messages to hubs.

HubSendToConnectionOptions

Options for sending a message to a specific connection.

HubSendToUserOptions

Options for sending a message to a user.

WebPubSubGroup

Type Aliases

JSONTypes

Types which can be serialized and sent as JSON.

Permission