你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure/web-pubsub package

类

AzureKeyCredential	支持更新基础密钥值的基于静态密钥的凭据。
WebPubSubServiceClient	用于连接到 Web PubSub 中心的客户端

接口

ClientTokenResponse	包含客户端令牌的响应。
GenerateClientTokenOptions	用于生成令牌以将客户端连接到 Azure Web Pubsub 服务的选项。
GroupAddConnectionOptions	用于向组添加连接的选项。
GroupAddUserOptions	用于将用户添加到组的选项。
GroupAdminClientOptions	用于构造 GroupAdmin 客户端的选项。
GroupCloseAllConnectionsOptions	用于关闭与组的所有连接的选项。
GroupHasUserOptions	用于检查用户是否在组中的选项
GroupRemoveConnectionOptions	用于从组中删除连接的选项
GroupRemoveUserOptions	用于从组中删除用户的选项
GroupSendTextToAllOptions	用于向组发送短信的选项。
GroupSendToAllOptions	用于将消息发送到组的选项。
HasConnectionOptions	用于检查连接是否存在的选项。
HubCloseAllConnectionsOptions	用于关闭与中心的所有连接的选项。
HubCloseConnectionOptions	用于关闭与中心的连接的选项。
HubCloseUserConnectionsOptions	用于关闭用户与中心的所有连接的选项。
HubGrantPermissionOptions	授予连接权限的选项
HubHasGroupOptions	用于检查组是否存在的选项。
HubHasPermissionOptions	用于检查连接是否具有指定权限的选项
HubHasUserOptions	用于检查用户是否存在的选项。
HubRemoveUserFromAllGroupsOptions	用于从所有组中删除用户的选项。
HubRevokePermissionOptions	用于从连接撤消权限的选项
HubSendTextToAllOptions	用于向中心发送短信的选项。
HubSendTextToConnectionOptions	用于向连接发送短信的选项。
HubSendTextToUserOptions	向用户发送短信的选项。
HubSendToAllOptions	用于将消息发送到中心的选项。
HubSendToConnectionOptions	用于将消息发送到特定连接的选项。
HubSendToUserOptions	向用户发送消息的选项。
WebPubSubGroup
WebPubSubServiceClientLogOptions	用于配置日志记录选项的选项。
WebPubSubServiceClientOptions	用于构造 HubAdmin 客户端的选项。

类型别名

JSONTypes	可以序列化和发送为 JSON 的类型。
Permission
WebPubSubClientProtocol	正在请求的客户端终结点的类型。

函数

odata(TemplateStringsArray, unknown[])

转义 odata 筛选器表达式，以避免引用字符串文本的错误。 示例用法： 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 筛选器表达式，以避免引用字符串文本的错误。 示例用法：

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