@azure/web-pubsub-chat package

Classes

AzureKeyCredential

A static-key-based credential that supports updating the underlying key value.

WebPubSubChatServiceClient

A client for managing chat resources in an Azure Web PubSub Chat hub.

Interfaces

ChatConversation

Represents a chat conversation.

ChatMessage

Represents a chat message.

ChatMessageInput

The properties accepted when updating a chat message.

ChatRole

Represents a chat role. A role name must start with 'user.' or 'room.' prefix. A role must contain either user permissions or room permissions, but not both.

ChatRoleInput

The properties required to create or replace a chat role.

ChatRoom

Represents a chat room.

ChatRoomInput

The properties required to create or replace a chat room.

ChatRoomMember

Represents a room member.

ChatRoomMemberInput

The properties required to create or replace a room member.

ChatUser

Represents a user profile in the chat system. This is a discriminated base type; concrete payloads are selected by the kind field (e.g. HumanChatUser).

ChatUserInput

The properties required to create or replace a chat user.

ClientAccessToken

A chat client access token and connection URLs.

CreateOrReplaceRoleOptionalParams

Optional parameters.

CreateOrReplaceRoomMemberOptionalParams

Optional parameters.

CreateOrReplaceRoomOptionalParams

Optional parameters.

CreateOrReplaceUserOptionalParams

Optional parameters.

DeleteMessageOptionalParams

Optional parameters.

DeleteRoleOptionalParams

Optional parameters.

DeleteRoomMemberOptionalParams

Optional parameters.

DeleteRoomOptionalParams

Optional parameters.

DeleteUserOptionalParams

Optional parameters.

GetClientAccessTokenOptions

Options for generating a chat client access token.

GetConversationOptionalParams

Optional parameters.

GetRoleOptionalParams

Optional parameters.

GetRoomOptionalParams

Optional parameters.

GetUserOptionalParams

Optional parameters.

HumanChatUser

A human end-user, identified by a user role.

HumanChatUserInput

The properties required to create or replace a human chat user.

ListMessagesOptionalParams

Optional parameters.

ListRolesOptionalParams

Optional parameters.

ListRoomMembersOptionalParams

Optional parameters.

MessageContent

Message content body.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

UpdateMessageOptionalParams

Optional parameters.

WebPubSubChatServiceClientOptionalParams

Optional parameters for the client.

WebPubSubChatServiceClientOptions

Options for configuring the Web PubSub Chat service client.

Type Aliases

ChatPermission

A permission that can be assigned to a chat role. KnownChatPermission can be used interchangeably with ChatPermission, this enum contains the known values that the service supports.

Known values supported by the service

user.create_room: Allows a user to create chat rooms. user.fetch_all_rooms: Allows a user to list the rooms they belong to. room.publish_message: Allows a room member to publish messages. room.history: Allows a room member to read message history. room.invite: Allows a room member to add users to a room. room.remove_user: Allows a room operator to remove users from a room.

ChatUserInputUnion

Alias for ChatUserInputUnion

ChatUserKind

Discriminator for the kind of chat user.

ChatUserUnion

Alias for ChatUserUnion

ContinuablePage

An interface that describes a page of results.

Enums

KnownChatPermission

A permission that can be assigned to a chat role.

KnownVersions

Service API versions.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

BuiltInChatRoles

Built-in roles supported by Web PubSub Chat.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

BuiltInChatRoles

Built-in roles supported by Web PubSub Chat.

BuiltInChatRoles: { RoomMember: "room.member", RoomOperator: "room.operator", UserNormal: "user.normal" }

Type

{ RoomMember: "room.member", RoomOperator: "room.operator", UserNormal: "user.normal" }