@azure/web-pubsub-chat package
Klassen
| AzureKeyCredential |
Statische Schlüsselbasierte Anmeldeinformationen, die das Aktualisieren des zugrunde liegenden Schlüsselwerts unterstützen. |
| WebPubSubChatServiceClient |
Ein Client zur Verwaltung von Chat-Ressourcen in einem Azure Web PubSub Chat-Hub. |
Schnittstellen
| ChatConversation |
Stellt ein Chat-Gespräch dar. |
| ChatMessage |
Stellt eine Chatnachricht dar. |
| ChatMessageInput |
Die Eigenschaften werden beim Aktualisieren einer Chatnachricht akzeptiert. |
| ChatRole |
Stellt eine Chat-Rolle dar. Ein Rollenname muss mit 'Benutzer' beginnen. oder 'Zimmer'. Präfix. Eine Rolle muss entweder Benutzerberechtigungen oder Raumberechtigungen enthalten, aber nicht beide. |
| ChatRoleInput |
Die Eigenschaften, die erforderlich sind, um eine Chat-Rolle zu erstellen oder zu ersetzen. |
| ChatRoom |
Stellt einen Chatraum dar. |
| ChatRoomInput |
Die Eigenschaften, die benötigt werden, um einen Chatraum zu erstellen oder zu ersetzen. |
| ChatRoomMember |
Steht für ein Raummitglied. |
| ChatRoomMemberInput |
Die Eigenschaften, die erforderlich sind, um ein Raummitglied zu schaffen oder zu ersetzen. |
| ChatUser |
Repräsentiert ein Benutzerprofil im Chatsystem. Dies ist ein differenzierter Basistyp; Betonnutzlasten werden durch das |
| ChatUserInput |
Die Eigenschaften, die erforderlich sind, um einen Chat-Nutzer zu erstellen oder zu ersetzen. |
| ClientAccessToken |
Ein Chat-Client-Zugriffstoken und Verbindungs-URLs. |
| CreateOrReplaceRoleOptionalParams |
Optionale Parameter. |
| CreateOrReplaceRoomMemberOptionalParams |
Optionale Parameter. |
| CreateOrReplaceRoomOptionalParams |
Optionale Parameter. |
| CreateOrReplaceUserOptionalParams |
Optionale Parameter. |
| DeleteMessageOptionalParams |
Optionale Parameter. |
| DeleteRoleOptionalParams |
Optionale Parameter. |
| DeleteRoomMemberOptionalParams |
Optionale Parameter. |
| DeleteRoomOptionalParams |
Optionale Parameter. |
| DeleteUserOptionalParams |
Optionale Parameter. |
| GetClientAccessTokenOptions |
Optionen zur Generierung eines Chat-Client-Zugangstokens. |
| GetConversationOptionalParams |
Optionale Parameter. |
| GetRoleOptionalParams |
Optionale Parameter. |
| GetRoomOptionalParams |
Optionale Parameter. |
| GetUserOptionalParams |
Optionale Parameter. |
| HumanChatUser |
Ein menschlicher Endnutzer, identifiziert durch eine Benutzerrolle. |
| HumanChatUserInput |
Die Eigenschaften, die erforderlich sind, um einen menschlichen Chat-Nutzer zu erstellen oder zu ersetzen. |
| ListMessagesOptionalParams |
Optionale Parameter. |
| ListRolesOptionalParams |
Optionale Parameter. |
| ListRoomMembersOptionalParams |
Optionale Parameter. |
| MessageContent |
Inhaltstext der Nachricht. |
| PageSettings |
Optionen für die byPage-Methode |
| PagedAsyncIterableIterator |
Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht. |
| UpdateMessageOptionalParams |
Optionale Parameter. |
| WebPubSubChatServiceClientOptionalParams |
Optionale Parameter für den Client. |
| WebPubSubChatServiceClientOptions |
Optionen zur Konfiguration des Web PubSub Chat-Serviceclients. |
Typaliase
| ChatPermission |
Eine Berechtigung, die einer Chat-Rolle zugewiesen werden kann. KnownChatPermission kann austauschbar mit ChatPermission verwendet werden; dieses Enum enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werdenuser.create_room: Ermöglicht es einem Nutzer, Chatrooms zu erstellen. user.fetch_all_rooms: Ermöglicht es einem Nutzer, die Räume aufzulisten, zu denen er gehört. room.publish_message: Erlaubt einem Raummitglied, Nachrichten zu veröffentlichen. room.history: Ermöglicht es einem Raummitglied, den Nachrichtenverlauf zu lesen. room.invite: Ermöglicht es einem Raummitglied, Benutzer zu einem Raum hinzuzufügen. room.remove_user: Ermöglicht es einem Raumbetreiber, Benutzer aus einem Raum zu entfernen. |
| ChatUserInputUnion |
Alias für ChatUserInputUnion |
| ChatUserKind |
Diskriminator für die Art von Chat-Nutzer. |
| ChatUserUnion |
Alias für ChatUserUnion |
| ContinuablePage |
Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt. |
Enumerationen
| KnownChatPermission |
Eine Berechtigung, die einer Chat-Rolle zugewiesen werden kann. |
| KnownVersions |
Service-API-Versionen. |
Functions
| is |
Typeguard für RestError |
Variablen
| Rest |
Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen. |
| Built |
Eingebaute Rollen werden vom Web PubSub Chat unterstützt. |
Details zur Funktion
isRestError(unknown)
Typeguard für RestError
function isRestError(e: unknown): e is RestErrorParameter
- e
-
unknown
Etwas, das von einer Catch-Klausel abgefangen wird.
Gibt zurück
e is RestError
Details zu Variablen
RestError
Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.
RestError: RestErrorConstructorTyp
BuiltInChatRoles
Eingebaute Rollen werden vom Web PubSub Chat unterstützt.
BuiltInChatRoles: { RoomMember: "room.member", RoomOperator: "room.operator", UserNormal: "user.normal" }Typ
{ RoomMember: "room.member", RoomOperator: "room.operator", UserNormal: "user.normal" }
