@azure/web-pubsub

Index

Enumerations

KnownWebPubSubPermission

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ContentType

ContentType: "application/json" | "application/octet-stream"

Defines values for ContentType.

JSONTypes

JSONTypes: string | number | boolean | object

Types which can be serialized and sent as JSON.

Payload

Payload: TextPlainPayload | JsonPayload | BinaryPayload

Permission

Permission: "joinLeaveGroup" | "sendToGroup"

WebPubSubPermission

WebPubSubPermission: string

Defines values for WebPubSubPermission.
KnownWebPubSubPermission can be used interchangeably with WebPubSubPermission, this enum contains the known values that the service supports.

Known values supported by the service

sendToGroup
joinLeaveGroup

Variables

Const logger

logger: any = createClientLogger("web-pubsub")

The @azure/logger configuration for this package.

Const serializer

serializer: any = coreClient.createSerializer({}, /* isXml */ false)

Const url

url: { constructor: any; prototype: __type; createObjectURL: any; revokeObjectURL: any } = URL

Type declaration

constructor: function
- new __type(url: string, base?: string | __type): __type
- - Defined in opt/hostedtoolcache/node/14.17.1/x64/lib/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:16069
  Parameters
  - url: string
  - Optional base: string | __type
  Returns __type
prototype: __type
createObjectURL: function
- createObjectURL(object: any): string
- - Defined in opt/hostedtoolcache/node/14.17.1/x64/lib/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:16071
  Parameters
  - object: any
  Returns string
revokeObjectURL: function
- revokeObjectURL(url: string): void
- - Defined in opt/hostedtoolcache/node/14.17.1/x64/lib/node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:16072
  Parameters
  - url: string
  Returns void

Const webPubSubKeyCredentialPolicyName

webPubSubKeyCredentialPolicyName: "webPubSubKeyCredentialPolicy" = "webPubSubKeyCredentialPolicy"

The programmatic identifier of the webPubSubKeyCredentialPolicy.

Functions

getPayloadForMessage

getPayloadForMessage(message: unknown, options: Record<string, any>): Payload

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/utils.ts:31
Parameters
- message: unknown
- options: Record<string, any>
Returns Payload

isRequestBody

isRequestBody(obj: unknown): obj is RequestBodyType

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/utils.ts:3
Parameters
- obj: unknown
Returns obj is RequestBodyType

normalizeSendToAllOptions

normalizeSendToAllOptions<T>(options: T): any

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/normalizeOptions.ts:4
Type parameters
- T: { excludedConnections?: string[] }
Parameters
- options: T
Returns any

parseConnectionString

parseConnectionString(conn: string): ParsedConnectionString

- Defined in mnt/vss/_work/1/s/sdk/web-pubsub/web-pubsub/src/parseConnectionString.ts:9
Parameters
- conn: string
Returns ParsedConnectionString

Object literals

Const $host

$host: object

parameterPath

parameterPath: string = "$host"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "$host"

type

type: object

name

Const addConnectionToGroupOperationSpec

addConnectionToGroupOperationSpec: object

httpMethod

httpMethod: string = "PUT"

path

path: string = "/api/hubs/{hub}/groups/{group}/connections/{connectionId}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host,Parameters.hub,Parameters.connectionId,Parameters.group]

responses

responses: object

200

200: {}

Type declaration

404

404: {}

Type declaration

default

default: {}

Type declaration

Const addUserToGroupOperationSpec

addUserToGroupOperationSpec: object

httpMethod

httpMethod: string = "PUT"

path

path: string = "/api/hubs/{hub}/users/{userId}/groups/{group}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host,Parameters.hub,Parameters.group,Parameters.userId]

responses

responses: object

200

200: {}

Type declaration

404

404: {}

Type declaration

default

default: {}

Type declaration

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2021-05-01-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

Const checkPermissionOperationSpec

checkPermissionOperationSpec: object

httpMethod

httpMethod: string = "HEAD"

path

path: string = "/api/hubs/{hub}/permissions/{permission}/connections/{connectionId}"

queryParameters

queryParameters: Object = [Parameters.apiVersion, Parameters.targetName]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host,Parameters.hub,Parameters.connectionId,Parameters.permission]

responses

responses: object

200

200: {}

Type declaration

404

404: {}

Type declaration

default

default: {}

Type declaration

Const closeClientConnectionOperationSpec

closeClientConnectionOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/api/hubs/{hub}/connections/{connectionId}"

queryParameters

queryParameters: Object = [Parameters.apiVersion, Parameters.reason]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub, Parameters.connectionId]

responses

responses: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const connectionExistsOperationSpec

connectionExistsOperationSpec: object

httpMethod

httpMethod: string = "HEAD"

path

path: string = "/api/hubs/{hub}/connections/{connectionId}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub, Parameters.connectionId]

responses

responses: object

200

200: {}

Type declaration

404

404: {}

Type declaration

default

default: {}

Type declaration

Const connectionId

connectionId: object

parameterPath

parameterPath: string = "connectionId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "connectionId"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

Const contentType

contentType: object

parameterPath

parameterPath: string = "contentType"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

allowedValues

allowedValues: Object = ["application/json", "application/octet-stream"]

name

Const contentType1

contentType1: object

parameterPath

parameterPath: string = "contentType"

mapper

mapper: object

defaultValue

defaultValue: string = "text/plain"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

Const excluded

excluded: object

collectionFormat

collectionFormat: string = "Multi"

parameterPath

parameterPath: Object = ["options", "excluded"]

mapper

mapper: object

serializedName

serializedName: string = "excluded"

type

type: object

name

element

element: object

type

type: object

name

Const getServiceStatusOperationSpec

getServiceStatusOperationSpec: object

httpMethod

httpMethod: string = "HEAD"

path

path: string = "/api/health"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host]

responses

responses: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const grantPermissionOperationSpec

grantPermissionOperationSpec: object

httpMethod

httpMethod: string = "PUT"

path

path: string = "/api/hubs/{hub}/permissions/{permission}/connections/{connectionId}"

queryParameters

queryParameters: Object = [Parameters.apiVersion, Parameters.targetName]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host,Parameters.hub,Parameters.connectionId,Parameters.permission]

responses

responses: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const group

group: object

parameterPath

parameterPath: string = "group"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "group"

constraints

constraints: object

MaxLength

MaxLength: number = 1024

MinLength

MinLength: number = 1

type

type: object

name

Const groupExistsOperationSpec

groupExistsOperationSpec: object

httpMethod

httpMethod: string = "HEAD"

path

path: string = "/api/hubs/{hub}/groups/{group}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub, Parameters.group]

responses

responses: object

200

200: {}

Type declaration

404

404: {}

Type declaration

default

default: {}

Type declaration

Const hub

hub: object

parameterPath

parameterPath: string = "hub"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "hub"

constraints

constraints: object

Pattern

Pattern: any = new RegExp("^[A-Za-z][A-Za-z0-9_`,.[\\]]{0,127}$")

type

type: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const removeUserFromAllGroupsOperationSpec

removeUserFromAllGroupsOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/api/hubs/{hub}/users/{userId}/groups"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub, Parameters.userId]

responses

responses: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const removeUserFromGroupOperationSpec

removeUserFromGroupOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/api/hubs/{hub}/users/{userId}/groups/{group}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host,Parameters.hub,Parameters.group,Parameters.userId]

responses

responses: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const revokePermissionOperationSpec

revokePermissionOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/api/hubs/{hub}/permissions/{permission}/connections/{connectionId}"

queryParameters

queryParameters: Object = [Parameters.apiVersion, Parameters.targetName]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host,Parameters.hub,Parameters.connectionId,Parameters.permission]

responses

responses: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const sendToAll$binaryOperationSpec

sendToAll$binaryOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "binary"

path

path: string = "/api/hubs/{hub}/:send"

queryParameters

queryParameters: Object = [Parameters.apiVersion, Parameters.excluded]

requestBody

requestBody: any = Parameters.message

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub]

responses

responses: object

202

202: {}

Type declaration

default

default: {}

Type declaration

Const sendToAll$textOperationSpec

sendToAll$textOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType1]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "text"

path

path: string = "/api/hubs/{hub}/:send"

queryParameters

queryParameters: Object = [Parameters.apiVersion, Parameters.excluded]

requestBody

requestBody: any = Parameters.message1

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub]

responses

responses: object

202

202: {}

Type declaration

default

default: {}

Type declaration

Const sendToConnection$binaryOperationSpec

sendToConnection$binaryOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "binary"

path

path: string = "/api/hubs/{hub}/connections/{connectionId}/:send"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.message

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub, Parameters.connectionId]

responses

responses: object

202

202: {}

Type declaration

default

default: {}

Type declaration

Const sendToConnection$textOperationSpec

sendToConnection$textOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType1]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "text"

path

path: string = "/api/hubs/{hub}/connections/{connectionId}/:send"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.message1

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub, Parameters.connectionId]

responses

responses: object

202

202: {}

Type declaration

default

default: {}

Type declaration

Const sendToGroup$binaryOperationSpec

sendToGroup$binaryOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "binary"

path

path: string = "/api/hubs/{hub}/groups/{group}/:send"

queryParameters

queryParameters: Object = [Parameters.apiVersion, Parameters.excluded]

requestBody

requestBody: any = Parameters.message

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub, Parameters.group]

responses

responses: object

202

202: {}

Type declaration

default

default: {}

Type declaration

Const sendToGroup$textOperationSpec

sendToGroup$textOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType1]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "text"

path

path: string = "/api/hubs/{hub}/groups/{group}/:send"

queryParameters

queryParameters: Object = [Parameters.apiVersion, Parameters.excluded]

requestBody

requestBody: any = Parameters.message1

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub, Parameters.group]

responses

responses: object

202

202: {}

Type declaration

default

default: {}

Type declaration

Const sendToUser$binaryOperationSpec

sendToUser$binaryOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "binary"

path

path: string = "/api/hubs/{hub}/users/{userId}/:send"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.message

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub, Parameters.userId]

responses

responses: object

202

202: {}

Type declaration

default

default: {}

Type declaration

Const sendToUser$textOperationSpec

sendToUser$textOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType1]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "text"

path

path: string = "/api/hubs/{hub}/users/{userId}/:send"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.message1

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub, Parameters.userId]

responses

responses: object

202

202: {}

Type declaration

default

default: {}

Type declaration

Const targetName

targetName: object

parameterPath

parameterPath: Object = ["options", "targetName"]

mapper

mapper: object

serializedName

serializedName: string = "targetName"

type

type: object

name

Const userExistsOperationSpec

userExistsOperationSpec: object

httpMethod

httpMethod: string = "HEAD"

path

path: string = "/api/hubs/{hub}/users/{userId}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.$host, Parameters.hub, Parameters.userId]

responses

responses: object

200

200: {}

Type declaration

404

404: {}

Type declaration

default

default: {}

Type declaration

Const userId

userId: object

parameterPath

parameterPath: string = "userId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "userId"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ContentType

JSONTypes

Payload

Permission

WebPubSubPermission

Known values supported by the service

Variables

Const logger

Const serializer

Const url

Type declaration

constructor: function

Parameters

url: string

Optional base: string | __type

Returns __type

prototype: __type

createObjectURL: function

Parameters

object: any

Returns string

revokeObjectURL: function

Parameters

url: string

Returns void

Const webPubSubKeyCredentialPolicyName

Functions

getPayloadForMessage

Parameters

message: unknown

options: Record<string, any>

Returns Payload

isRequestBody

Parameters

obj: unknown

Returns obj is RequestBodyType

normalizeSendToAllOptions

Type parameters

T: { excludedConnections?: string[] }

Parameters

options: T

Returns any

parseConnectionString

Parameters

conn: string

Returns ParsedConnectionString

Object literals

Const $host

parameterPath

skipEncoding

mapper

required

serializedName

type

name

Const addConnectionToGroupOperationSpec

httpMethod

path

queryParameters

serializer

urlParameters

responses

200

Type declaration

404

Type declaration

default

Type declaration

Const addUserToGroupOperationSpec

httpMethod

path