WebPubSubChatServiceClient class

Paket:

@azure/web-pubsub-chat

Ein Client zur Verwaltung von Chat-Ressourcen in einem Azure Web PubSub Chat-Hub.

Konstruktoren

WebPubSubChatServiceClient(string, string, WebPubSubChatServiceClientOptions)	Aus Verbindungszeichenfolge erstellen
WebPubSubChatServiceClient(string, TokenCredential | AzureKeyCredential, string, WebPubSubChatServiceClientOptions)	Vom Endpunkt und Zugangsdaten erstellen

Eigenschaften

pipeline

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

Methoden

createOrReplaceRole(string, ChatRoleInput, CreateOrReplaceRoleOptionalParams)	Erstelle oder ersetze eine Rolle.
createOrReplaceRoom(string, ChatRoomInput, CreateOrReplaceRoomOptionalParams)	Erstelle oder ersetze einen Raum mit einer vom Client angegebenen ID.
createOrReplaceRoomMember(string, string, ChatRoomMemberInput, CreateOrReplaceRoomMemberOptionalParams)	Erstelle oder ersetze ein Zimmermitglied.
createOrReplaceUser(string, HumanChatUserInput, CreateOrReplaceUserOptionalParams)	Erstellen oder ersetzen Sie einen Benutzer. Der Anforderungskörper ist ein polymorpher ChatUser (z. B. HumanChatUser), der vom Discriminator kind ausgewählt wird.
deleteMessage(string, string, DeleteMessageOptionalParams)	Löschen einer Nachricht.
deleteRole(string, DeleteRoleOptionalParams)	Lösche eine Rolle.
deleteRoom(string, DeleteRoomOptionalParams)	Lösche einen Raum.
deleteRoomMember(string, string, DeleteRoomMemberOptionalParams)	Lösche ein Zimmermitglied.
deleteUser(string, DeleteUserOptionalParams)	Löscht einen Benutzer.
getClientAccessToken(GetClientAccessTokenOptions)	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.
getConversation(string, GetConversationOptionalParams)	Holen Sie sich Informationen zum Gespräch.
getRole(string, GetRoleOptionalParams)	Holen Sie sich Rolleninformationen.
getRoom(string, GetRoomOptionalParams)	Hol dir Zimmerinformationen.
getUser(string, GetUserOptionalParams)	Erhalten Sie ein Benutzerprofil. Die Antwort ist eine polymorphe ChatUser (z. B. HumanChatUser), die vom kind Discriminator ausgewählt wird.
listMessages(string, ListMessagesOptionalParams)	Fragen Sie Nachrichten in einem Gespräch von der neuesten bis zur frühesten an.
listRoles(ListRolesOptionalParams)	Abfrage von Rollen in einem Hub.
listRoomMembers(string, ListRoomMembersOptionalParams)	Holt euch Zimmermitglieder.
updateMessage(string, string, ChatMessageInput, UpdateMessageOptionalParams)	Aktualisiere eine Nachricht.

Details zum Konstruktor

WebPubSubChatServiceClient(string, string, WebPubSubChatServiceClientOptions)

Aus Verbindungszeichenfolge erstellen

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

Parameter

connectionString

string

hub

string

options

WebPubSubChatServiceClientOptions

WebPubSubChatServiceClient(string, TokenCredential | AzureKeyCredential, string, WebPubSubChatServiceClientOptions)

Vom Endpunkt und Zugangsdaten erstellen

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

Parameter

endpointParam

string

credential

TokenCredential | AzureKeyCredential

hub

string

options

WebPubSubChatServiceClientOptions

Details zur Eigenschaft

pipeline

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

pipeline: Pipeline

Eigenschaftswert

Pipeline

Details zur Methode

createOrReplaceRole(string, ChatRoleInput, CreateOrReplaceRoleOptionalParams)

Erstelle oder ersetze eine Rolle.

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

Parameter

roleName

string

resource

ChatRoleInput

options

CreateOrReplaceRoleOptionalParams

Gibt zurück

Promise<ChatRole>

createOrReplaceRoom(string, ChatRoomInput, CreateOrReplaceRoomOptionalParams)

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

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

Parameter

roomId

string

resource

ChatRoomInput

options

CreateOrReplaceRoomOptionalParams

Gibt zurück

Promise<ChatRoom>

createOrReplaceRoomMember(string, string, ChatRoomMemberInput, CreateOrReplaceRoomMemberOptionalParams)

Erstelle oder ersetze ein Zimmermitglied.

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

Parameter

roomId

string

userId

string

resource

ChatRoomMemberInput

options

CreateOrReplaceRoomMemberOptionalParams

Gibt zurück

Promise<ChatRoomMember>

createOrReplaceUser(string, HumanChatUserInput, CreateOrReplaceUserOptionalParams)

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

userId

string

resource

HumanChatUserInput

options

CreateOrReplaceUserOptionalParams

Gibt zurück

Promise<ChatUserUnion>

deleteMessage(string, string, DeleteMessageOptionalParams)

Löschen einer Nachricht.

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

Parameter

conversationId

string

messageId

string

options

DeleteMessageOptionalParams

Gibt zurück

Promise<void>

deleteRole(string, DeleteRoleOptionalParams)

Lösche eine Rolle.

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

Parameter

roleName

string

options

DeleteRoleOptionalParams

Gibt zurück

Promise<void>

deleteRoom(string, DeleteRoomOptionalParams)

Lösche einen Raum.

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

Parameter

roomId

string

options

DeleteRoomOptionalParams

Gibt zurück

Promise<void>

deleteRoomMember(string, string, DeleteRoomMemberOptionalParams)

Lösche ein Zimmermitglied.

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

Parameter

roomId

string

userId

string

options

DeleteRoomMemberOptionalParams

Gibt zurück

Promise<void>

deleteUser(string, DeleteUserOptionalParams)

Löscht einen Benutzer.

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

Parameter

userId

string

options

DeleteUserOptionalParams

Gibt zurück

Promise<void>

getClientAccessToken(GetClientAccessTokenOptions)

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

options

GetClientAccessTokenOptions

Gibt zurück

Promise<ClientAccessToken>

getConversation(string, GetConversationOptionalParams)

Holen Sie sich Informationen zum Gespräch.

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

Parameter

conversationId

string

options

GetConversationOptionalParams

Gibt zurück

Promise<ChatConversation>

getRole(string, GetRoleOptionalParams)

Holen Sie sich Rolleninformationen.

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

Parameter

roleName

string

options

GetRoleOptionalParams

Gibt zurück

Promise<ChatRole>

getRoom(string, GetRoomOptionalParams)

Hol dir Zimmerinformationen.

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

Parameter

roomId

string

options

GetRoomOptionalParams

Gibt zurück

Promise<ChatRoom>

getUser(string, GetUserOptionalParams)

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

userId

string

options

GetUserOptionalParams

Gibt zurück

Promise<ChatUserUnion>

listMessages(string, ListMessagesOptionalParams)

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

conversationId

string

options

ListMessagesOptionalParams

Gibt zurück

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listRoles(ListRolesOptionalParams)

Abfrage von Rollen in einem Hub.

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

Parameter

options

ListRolesOptionalParams

Gibt zurück

PagedAsyncIterableIterator<ChatRole, ChatRole[], PageSettings>

listRoomMembers(string, ListRoomMembersOptionalParams)

Holt euch Zimmermitglieder.

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

Parameter

roomId

string

options

ListRoomMembersOptionalParams

Gibt zurück

PagedAsyncIterableIterator<ChatRoomMember, ChatRoomMember[], PageSettings>

updateMessage(string, string, ChatMessageInput, UpdateMessageOptionalParams)

Aktualisiere eine Nachricht.

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

Parameter

conversationId

string

messageId

string

resource

ChatMessageInput

options

UpdateMessageOptionalParams

Gibt zurück

Promise<ChatMessage>