@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으로 serialize 및 전송할 수 있는 형식입니다.

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