@azure/web-pubsub package
Klasy
| AzureKeyCredential |
Poświadczenie oparte na kluczu statycznym, które obsługuje aktualizowanie bazowej wartości klucza. |
| WebPubSubServiceClient |
Klient do nawiązywania połączenia z internetowym koncentratorem PubSub |
Interfejsy
| ClientTokenResponse |
Odpowiedź zawierająca token klienta. |
| GenerateClientTokenOptions |
Opcje generowania tokenu w celu połączenia klienta z usługą Azure Web Pubsub. |
| GroupAddConnectionOptions |
Opcje dodawania połączenia do grupy. |
| GroupAddUserOptions |
Opcje dodawania użytkownika do grupy. |
| GroupAdminClientOptions |
Opcje konstruowania klienta GroupAdmin. |
| GroupCloseAllConnectionsOptions |
Opcje zamykania wszystkich połączeń z grupą. |
| GroupHasUserOptions |
Opcje sprawdzania, czy użytkownik znajduje się w grupie |
| GroupListConnectionsOptions |
Opcje wyświetlania listy połączeń w grupie. |
| GroupRemoveConnectionOptions |
Opcje usuwania połączenia z grupy |
| GroupRemoveUserOptions |
Opcje usuwania użytkownika z grupy |
| GroupSendTextToAllOptions |
Opcje wysyłania wiadomości TEKSTowych do grupy. |
| GroupSendToAllOptions |
Opcje wysyłania komunikatów do grupy. |
| HasConnectionOptions |
Opcje sprawdzania, czy istnieje połączenie. |
| HubCloseAllConnectionsOptions |
Opcje zamykania wszystkich połączeń z koncentratorem. |
| HubCloseConnectionOptions |
Opcje zamykania połączenia z koncentratorem. |
| HubCloseUserConnectionsOptions |
Opcje zamykania wszystkich połączeń użytkownika z koncentratorem. |
| HubGrantPermissionOptions |
Opcje udzielania uprawnień do połączenia |
| HubHasGroupOptions |
Opcje sprawdzania, czy grupa istnieje. |
| HubHasPermissionOptions |
Opcje sprawdzania, czy połączenie ma określone uprawnienie |
| HubHasUserOptions |
Opcje sprawdzania, czy użytkownik istnieje. |
| HubRemoveUserFromAllGroupsOptions |
Opcje usuwania użytkownika ze wszystkich grup. |
| HubRevokePermissionOptions |
Opcje odwołowywania uprawnień z połączenia |
| HubSendTextToAllOptions |
Opcje wysyłania wiadomości SMS do centrów. |
| HubSendTextToConnectionOptions |
Opcje wysyłania wiadomości SMS do połączenia. |
| HubSendTextToUserOptions |
Opcje wysyłania wiadomości SMS do użytkownika. |
| HubSendToAllOptions |
Opcje wysyłania komunikatów do centrów. |
| HubSendToConnectionOptions |
Opcje wysyłania komunikatu do określonego połączenia. |
| HubSendToUserOptions |
Opcje wysyłania wiadomości do użytkownika. |
| WebPubSubGroup | |
| WebPubSubGroupMember |
Połączenie w grupie w usłudze Web PubSub. |
| WebPubSubServiceClientLogOptions |
Opcje konfigurowania opcji rejestrowania. |
| WebPubSubServiceClientOptions |
Opcje konstruowania klienta HubAdmin. |
Aliasy typu
| JSONTypes |
Typy, które można serializować i wysyłać jako dane JSON. |
| Permission | |
| WebPubSubClientProtocol |
Typ żądanego punktu końcowego klienta. |
Funkcje
| odata(Template |
Unika wyrażenia filtru odata, aby uniknąć błędów z literałami ciągu cudzysłowu. Przykładowe użycie:
|
Szczegóły funkcji
odata(TemplateStringsArray, unknown[])
Unika wyrażenia filtru odata, aby uniknąć błędów z literałami ciągu cudzysłowu. Przykładowe użycie:
import { odata } from "@azure/web-pubsub";
const userId = "vic's";
const anonymous = null;
const length = 3;
const filter = odata`userId eq ${anonymous} or userId eq ${userId} or length(userId) > ${length}`;
function odata(strings: TemplateStringsArray, values: unknown[]): string
Parametry
- strings
-
TemplateStringsArray
Tablica ciągów dla wyrażenia
- values
-
unknown[]
Tablica wartości wyrażenia
Zwraca
string