@azure/web-pubsub package

類別

AzureKeyCredential

支援更新基礎金鑰值的靜態金鑰型認證。

WebPubSubServiceClient

聯機到 Web PubSub 中樞的用戶端

介面

ClientTokenResponse

包含用戶端令牌的回應。

GenerateClientTokenOptions

產生令牌以將客戶端連線至 Azure Web Pubsub 服務的選項。

GroupAddConnectionOptions

將連線新增至群組的選項。

GroupAddUserOptions

將使用者新增至群組的選項。

GroupAdminClientOptions

建構 GroupAdmin 客戶端的選項。

GroupCloseAllConnectionsOptions

關閉群組所有連線的選項。

GroupHasUserOptions

檢查使用者是否在群組中的選項

GroupListConnectionsOptions

用於列出組中連接的選項。

GroupRemoveConnectionOptions

從群組移除連線的選項

GroupRemoveUserOptions

從群組中移除用戶的選項

GroupSendTextToAllOptions

將簡訊傳送至群組的選項。

GroupSendToAllOptions

將訊息傳送至群組的選項。

HasConnectionOptions

檢查連線是否存在的選項。

HubCloseAllConnectionsOptions

關閉中樞所有連線的選項。

HubCloseConnectionOptions

關閉中樞連線的選項。

HubCloseUserConnectionsOptions

關閉使用者與中樞連線的選項。

HubGrantPermissionOptions

授與連線許可權的選項

HubHasGroupOptions

檢查群組是否存在的選項。

HubHasPermissionOptions

檢查連接是否具有指定許可權的選項

HubHasUserOptions

檢查使用者是否存在的選項。

HubRemoveUserFromAllGroupsOptions

從所有群組移除用戶的選項。

HubRevokePermissionOptions

從線上撤銷許可權的選項

HubSendTextToAllOptions

將簡訊傳送至中樞的選項。

HubSendTextToConnectionOptions

將簡訊傳送至連線的選項。

HubSendTextToUserOptions

將簡訊傳送給用戶的選項。

HubSendToAllOptions

將訊息傳送至中樞的選項。

HubSendToConnectionOptions

將訊息傳送至特定連線的選項。

HubSendToUserOptions

將訊息傳送給用戶的選項。

WebPubSubGroup
WebPubSubGroupMember

Web PubSub 服務中組中的連接。

WebPubSubServiceClientLogOptions

設定記錄選項的選項。

WebPubSubServiceClientOptions

建構 HubAdmin 客戶端的選項。

類型別名

JSONTypes

可串行化並傳送為 JSON 的類型。

Permission
WebPubSubClientProtocol

要求的用戶端端點類型。

函式

odata(TemplateStringsArray, unknown[])

逸出 odata 篩選表示式,以避免使用引用字串常值的錯誤。 範例用法:

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}`;

函式詳細資料

odata(TemplateStringsArray, unknown[])

逸出 odata 篩選表示式,以避免使用引用字串常值的錯誤。 範例用法:

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

參數

strings

TemplateStringsArray

表達式的字串數位

values

unknown[]

表達式的值陣列

傳回

string