WebPubSubChatServiceClient class

Aus Verbindungszeichenfolge erstellen

new WebPubSubChatServiceClient(connectionString: string, hub: string, options?: WebPubSubChatServiceClientOptions)

Parameter

Vom Endpunkt und Zugangsdaten erstellen

new WebPubSubChatServiceClient(endpointParam: string, credential: TokenCredential | AzureKeyCredential, hub: string, options?: WebPubSubChatServiceClientOptions)

Parameter

Die Pipeline, die von diesem Client verwendet wird, um Anforderungen zu stellen

pipeline: Pipeline

Eigenschaftswert

Erstelle oder ersetze eine Rolle.

function createOrReplaceRole(roleName: string, resource: ChatRoleInput, options?: CreateOrReplaceRoleOptionalParams): Promise<ChatRole>

Parameter

Gibt zurück

Erstelle oder ersetze einen Raum mit einer vom Client angegebenen ID.

function createOrReplaceRoom(roomId: string, resource: ChatRoomInput, options?: CreateOrReplaceRoomOptionalParams): Promise<ChatRoom>

Parameter

Gibt zurück

Erstelle oder ersetze ein Zimmermitglied.

function createOrReplaceRoomMember(roomId: string, userId: string, resource: ChatRoomMemberInput, options?: CreateOrReplaceRoomMemberOptionalParams): Promise<ChatRoomMember>

Parameter

Gibt zurück

Erstellen oder ersetzen Sie einen Benutzer. Der Anforderungskörper ist ein polymorpher ChatUser (z. B. HumanChatUser), der vom Discriminator kind ausgewählt wird.

function createOrReplaceUser(userId: string, resource: HumanChatUserInput, options?: CreateOrReplaceUserOptionalParams): Promise<ChatUserUnion>

Parameter

Gibt zurück

Löschen einer Nachricht.

function deleteMessage(conversationId: string, messageId: string, options?: DeleteMessageOptionalParams): Promise<void>

Parameter

Gibt zurück

Lösche eine Rolle.

function deleteRole(roleName: string, options?: DeleteRoleOptionalParams): Promise<void>

Parameter

Gibt zurück

Lösche einen Raum.

function deleteRoom(roomId: string, options?: DeleteRoomOptionalParams): Promise<void>

Parameter

Gibt zurück

Lösche ein Zimmermitglied.

function deleteRoomMember(roomId: string, userId: string, options?: DeleteRoomMemberOptionalParams): Promise<void>

Parameter

Gibt zurück

Löscht einen Benutzer.

function deleteUser(userId: string, options?: DeleteUserOptionalParams): Promise<void>

Parameter

Gibt zurück

Generiere ein Token, damit ein Client sich mit dem Azure Web PubSub-Dienst verbinden kann.

Bei Verwendung von AzureKeyCredential wird das Token lokal mittels JWT-Signing generiert. Bei Verwendung von TokenCredential wird das Token durch das Aufruf der REST-API des Web PubSub-Dienstes generiert.

function getClientAccessToken(options?: GetClientAccessTokenOptions): Promise<ClientAccessToken>

Parameter

Gibt zurück

Holen Sie sich Informationen zum Gespräch.

function getConversation(conversationId: string, options?: GetConversationOptionalParams): Promise<ChatConversation>

Parameter

Gibt zurück

Holen Sie sich Rolleninformationen.

function getRole(roleName: string, options?: GetRoleOptionalParams): Promise<ChatRole>

Parameter

Gibt zurück

Hol dir Zimmerinformationen.

function getRoom(roomId: string, options?: GetRoomOptionalParams): Promise<ChatRoom>

Parameter

Gibt zurück

Erhalten Sie ein Benutzerprofil. Die Antwort ist eine polymorphe ChatUser (z. B. HumanChatUser), die vom kind Discriminator ausgewählt wird.

function getUser(userId: string, options?: GetUserOptionalParams): Promise<ChatUserUnion>

Parameter

Gibt zurück

Fragen Sie Nachrichten in einem Gespräch von der neuesten bis zur frühesten an.

function listMessages(conversationId: string, options?: ListMessagesOptionalParams): PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

Parameter

Gibt zurück

Abfrage von Rollen in einem Hub.

function listRoles(options?: ListRolesOptionalParams): PagedAsyncIterableIterator<ChatRole, ChatRole[], PageSettings>

Parameter

Gibt zurück

Holt euch Zimmermitglieder.

function listRoomMembers(roomId: string, options?: ListRoomMembersOptionalParams): PagedAsyncIterableIterator<ChatRoomMember, ChatRoomMember[], PageSettings>

Parameter

Gibt zurück

Aktualisiere eine Nachricht.

function updateMessage(conversationId: string, messageId: string, resource: ChatMessageInput, options?: UpdateMessageOptionalParams): Promise<ChatMessage>

Parameter

Gibt zurück