@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