WebPubSub | @azure/web-pubsub

Interface representing a WebPubSub.

Hierarchy

WebPubSub

Implemented by

WebPubSubImpl

Index

Methods

addConnectionToGroup

addConnectionToGroup(hub: string, group: string, connectionId: string, options?: WebPubSubAddConnectionToGroupOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:137
Add a connection to the target group.

Parameters
- hub: string
  
  Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
- group: string
  
  Target group name, which length should be greater than 0 and less than 1025.
- connectionId: string
  
  Target connection Id
- Optional options: WebPubSubAddConnectionToGroupOptionalParams
  
  The options parameters.
Returns Promise<void>

addUserToGroup

addUserToGroup(hub: string, group: string, userId: string, options?: WebPubSubAddUserToGroupOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:198
Add a user to the target group.

Parameters
- hub: string
  
  Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
- group: string
  
  Target group name, which length should be greater than 0 and less than 1025.
- userId: string
  
  Target user Id.
- Optional options: WebPubSubAddUserToGroupOptionalParams
  
  The options parameters.
Returns Promise<void>

checkPermission

checkPermission(hub: string, permission: WebPubSubPermission, connectionId: string, options?: WebPubSubCheckPermissionOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:266
Check if a connection has permission to the specified action.

Parameters
- hub: string
  
  Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
- permission: WebPubSubPermission
  
  The permission: current supported actions are joinLeaveGroup and sendToGroup.
- connectionId: string
  
  Target connection Id.
- Optional options: WebPubSubCheckPermissionOptionalParams
  
  The options parameters.
Returns Promise<void>

closeClientConnection

closeClientConnection(hub: string, connectionId: string, options?: WebPubSubCloseClientConnectionOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:70
Close the client connection.

Parameters
- hub: string
  
  Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
- connectionId: string
  
  Target connection Id.
- Optional options: WebPubSubCloseClientConnectionOptionalParams
  
  The options parameters.
Returns Promise<void>

connectionExists

connectionExists(hub: string, connectionId: string, options?: WebPubSubConnectionExistsOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:58
Check if the connection with the given connectionId exists.

Parameters
- hub: string
  
  Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
- connectionId: string
  
  The connection Id.
- Optional options: WebPubSubConnectionExistsOptionalParams
  
  The options parameters.
Returns Promise<void>

grantPermission

grantPermission(hub: string, permission: WebPubSubPermission, connectionId: string, options?: WebPubSubGrantPermissionOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:238
Grant permission to the connection.

Parameters
- hub: string
  
  Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
- permission: WebPubSubPermission
  
  The permission: current supported actions are joinLeaveGroup and sendToGroup.
- connectionId: string
  
  Target connection Id.
- Optional options: WebPubSubGrantPermissionOptionalParams
  
  The options parameters.
Returns Promise<void>

groupExists

groupExists(hub: string, group: string, options?: WebPubSubGroupExistsOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:103
Check if there are any client connections inside the given group

Parameters
- hub: string
  
  Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
- group: string
  
  Target group name, which length should be greater than 0 and less than 1025.
- Optional options: WebPubSubGroupExistsOptionalParams
  
  The options parameters.
Returns Promise<void>

removeConnectionFromGroup

removeConnectionFromGroup(hub: string, group: string, connectionId: string, options?: WebPubSubRemoveConnectionFromGroupOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:151
Remove a connection from the target group.

Parameters
- hub: string
  
  Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
- group: string
  
  Target group name, which length should be greater than 0 and less than 1025.
- connectionId: string
  
  Target connection Id.
- Optional options: WebPubSubRemoveConnectionFromGroupOptionalParams
  
  The options parameters.
Returns Promise<void>

removeUserFromAllGroups

removeUserFromAllGroups(hub: string, userId: string, options?: WebPubSubRemoveUserFromAllGroupsOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:225
Remove a user from all groups.

Parameters
- hub: string
  
  Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
- userId: string
  
  Target user Id.
- Optional options: WebPubSubRemoveUserFromAllGroupsOptionalParams
  
  The options parameters.
Returns Promise<void>

removeUserFromGroup

removeUserFromGroup(hub: string, group: string, userId: string, options?: WebPubSubRemoveUserFromGroupOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:212
Remove a user from the target group.

Parameters
- hub: string
  
  Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
- group: string
  
  Target group name, which length should be greater than 0 and less than 1025.
- userId: string
  
  Target user Id.
- Optional options: WebPubSubRemoveUserFromGroupOptionalParams
  
  The options parameters.
Returns Promise<void>

revokePermission

revokePermission(hub: string, permission: WebPubSubPermission, connectionId: string, options?: WebPubSubRevokePermissionOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:252
Revoke permission for the connection.

Parameters
- hub: string
  
  Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
- permission: WebPubSubPermission
  
  The permission: current supported actions are joinLeaveGroup and sendToGroup.
- connectionId: string
  
  Target connection Id.
- Optional options: WebPubSubRevokePermissionOptionalParams
  
  The options parameters.
Returns Promise<void>

sendToAll

sendToAll(...args: [string, ContentType, coreRestPipeline.RequestBodyType, undefined | WebPubSubSendToAll$binaryOptionalParams] | [string, "text/plain", string, undefined | WebPubSubSendToAll$textOptionalParams]): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:41
Broadcast content inside request body to all the connected client connections.

Parameters
- Rest ...args: [string, ContentType, coreRestPipeline.RequestBodyType, undefined | WebPubSubSendToAll$binaryOptionalParams] | [string, "text/plain", string, undefined | WebPubSubSendToAll$textOptionalParams]
  
  Includes all the parameters for this operation.
Returns Promise<void>

sendToConnection

sendToConnection(...args: [string, string, ContentType, coreRestPipeline.RequestBodyType, undefined | WebPubSubSendToConnection$binaryOptionalParams] | [string, string, "text/plain", string, undefined | WebPubSubSendToConnection$textOptionalParams]): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:79
Send content inside request body to the specific connection.

Parameters
- Rest ...args: [string, string, ContentType, coreRestPipeline.RequestBodyType, undefined | WebPubSubSendToConnection$binaryOptionalParams] | [string, string, "text/plain", string, undefined | WebPubSubSendToConnection$textOptionalParams]
  
  Includes all the parameters for this operation.
Returns Promise<void>

sendToGroup

sendToGroup(...args: [string, string, ContentType, coreRestPipeline.RequestBodyType, undefined | WebPubSubSendToGroup$binaryOptionalParams] | [string, string, "text/plain", string, undefined | WebPubSubSendToGroup$textOptionalParams]): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:112
Send content inside request body to a group of connections.

Parameters
- Rest ...args: [string, string, ContentType, coreRestPipeline.RequestBodyType, undefined | WebPubSubSendToGroup$binaryOptionalParams] | [string, string, "text/plain", string, undefined | WebPubSubSendToGroup$textOptionalParams]
  
  Includes all the parameters for this operation.
Returns Promise<void>

sendToUser

sendToUser(...args: [string, string, ContentType, coreRestPipeline.RequestBodyType, undefined | WebPubSubSendToUser$binaryOptionalParams] | [string, string, "text/plain", string, undefined | WebPubSubSendToUser$textOptionalParams]): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:173
Send content inside request body to the specific user.

Parameters
- Rest ...args: [string, string, ContentType, coreRestPipeline.RequestBodyType, undefined | WebPubSubSendToUser$binaryOptionalParams] | [string, string, "text/plain", string, undefined | WebPubSubSendToUser$textOptionalParams]
  
  Includes all the parameters for this operation.
Returns Promise<void>

userExists

userExists(hub: string, userId: string, options?: WebPubSubUserExistsOptionalParams): Promise<void>

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/generated/operationsInterfaces/webPubSub.ts:164
Check if there are any client connections connected for the given user.

Parameters
- hub: string
  
  Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.
- userId: string
  
  Target user Id.
- Optional options: WebPubSubUserExistsOptionalParams
  
  The options parameters.
Returns Promise<void>

Hierarchy

Implemented by

Index

Methods

Methods

addConnectionToGroup

Parameters

hub: string

group: string

connectionId: string

Optional options: WebPubSubAddConnectionToGroupOptionalParams

Returns Promise<void>

addUserToGroup

Parameters

hub: string

group: string

userId: string

Optional options: WebPubSubAddUserToGroupOptionalParams

Returns Promise<void>

checkPermission

Parameters

hub: string

permission: WebPubSubPermission

connectionId: string

Optional options: WebPubSubCheckPermissionOptionalParams

Returns Promise<void>

closeClientConnection

Parameters

hub: string

connectionId: string

Optional options: WebPubSubCloseClientConnectionOptionalParams

Returns Promise<void>

connectionExists

Parameters

hub: string

connectionId: string

Optional options: WebPubSubConnectionExistsOptionalParams

Returns Promise<void>

grantPermission

Parameters

hub: string

permission: WebPubSubPermission

connectionId: string

Optional options: WebPubSubGrantPermissionOptionalParams

Returns Promise<void>

groupExists

Parameters

hub: string

group: string

Optional options: WebPubSubGroupExistsOptionalParams

Returns Promise<void>

removeConnectionFromGroup

Parameters

hub: string

group: string

connectionId: string

Optional options: WebPubSubRemoveConnectionFromGroupOptionalParams

Returns Promise<void>

removeUserFromAllGroups

Parameters

hub: string

userId: string

Optional options: WebPubSubRemoveUserFromAllGroupsOptionalParams

Returns Promise<void>

removeUserFromGroup

Parameters

hub: string

group: string

userId: string

Optional options: WebPubSubRemoveUserFromGroupOptionalParams

Returns Promise<void>

revokePermission

Parameters

hub: string

permission: WebPubSubPermission

connectionId: string

Optional options: WebPubSubRevokePermissionOptionalParams

Returns Promise<void>

sendToAll

Parameters