@azure/web-pubsub-client package

클래스

InvocationError

호출이 실패하거나 취소될 때 발생하는 오류입니다.

SendMessageError

메시지를 보내지 못한 경우 오류 발생

WebPubSubClient

WebPubSub 클라이언트

인터페이스

AbortGroupStreamOptions

그룹 스트림 옵션 중단.

AckMessage

ack 메시지

AckMessageError

AckMessage의 오류 세부 정보

CancelInvocationMessage

호출 메시지 취소

ConnectedMessage

연결된 메시지

DisconnectedMessage

연결이 끊긴 메시지

EndGroupStreamOptions

그룹 스트림 옵션 종료.

GetClientAccessUrlOptions

시작 옵션

GroupDataMessage

그룹 데이터 메시지

GroupStateItem

그룹 내 단일 연결의 상태 항목

GroupStateSnapshotMessage

성공적인 구독 그룹 상태 후 전송되는 그룹 상태 스냅샷 메시지

GroupStateUpdateMessage

연결 상태가 변경될 때 부정하는 그룹 상태 업데이트 메시지

GroupStream

단일 인바운드 그룹 스트림.

GroupStreamMessage

그룹 스트림의 인바운드 조각 하나.

GroupStreamSubscription

구독 반환 client.onGroupStream(...).

GroupStreamWriteOptions

스트림 쓰기 옵션을 그룹 작성하세요.

GroupStreamWriter

하나의 논리 스트림을 그룹에 전송하는 그룹 스트림 작성자 추상화.

InvocationErrorOptions
InvokeEventOptions

이벤트 운영 옵션 호출

InvokeEventResult

invokeEvent 결과

InvokeMessage

인보크 메시지

InvokeResponseError

응답 오류 정보 호출

InvokeResponseMessage

응답 메시지 호출

JoinGroupMessage

그룹 메시지 조인

JoinGroupOptions

조인 그룹 작업 옵션

LeaveGroupMessage

그룹 메시지 나가기

LeaveGroupOptions

그룹 작업 옵션 나가기

OnConnectedArgs

OnConnected 콜백의 매개 변수

OnDisconnectedArgs

OnDisconnected 콜백의 매개 변수

OnGroupDataMessageArgs

OnGroupDataMessage 콜백의 매개 변수

OnGroupStreamOptions

단일 콜백에서 인 client.onGroupStream(callback, options)바운드 그룹 스트림을 추적하고 디스패치하는 방식을 제어하는 옵션은 .

그립성은 두 단계입니다:

  • 옵션 은 등록(즉, 핸들러별)에 스코프가 지정되어 있으며, 각 onGroupStream 호출은 고유한 값을 가지고 있고, 핸들러마다 다른 값을 사용할 수 있습니다.
  • 옵션 효과 는 각 스트림에 독립적으로 적용되며, 각 스트림의 쌍으로 (group, streamId) 식별됩니다. 동시 스트림 — 심지어 같은 핸들러가 관찰하는 같은 그룹 내 두 스트림도 각각 유휴 타이머와 게 handleFromStart 이트를 가집니다. 스트림이나 그룹 간에 공유되거나 집계되는 것은 없습니다.
OnRejoinGroupFailedArgs

RejoinGroupFailed 콜백의 매개 변수

OnServerDataMessageArgs

OnDataMessage 콜백의 매개 변수

OnStoppedArgs

OnStopped 콜백의 매개 변수

OpenGroupStreamOptions

OpenGroupStream 운영 옵션 공개.

PingMessage

핑 메시지

PongMessage

퐁 메시지

SendEventMessage

사용자 지정 이벤트 메시지 보내기

SendEventOptions

이벤트 작업 옵션 보내기

SendMessageErrorOptions
SendToGroupMessage

그룹 메시지로 보내기

SendToGroupOptions

그룹 작업 옵션으로 보내기

SequenceAckMessage

시퀀스 ack 메시지

ServerDataMessage

서버 데이터 메시지

SetGroupStateMessage

그룹 상태 메시지 설정하세요

StartOptions

시작 옵션

StartStreamOptions

스트림을 열어주는 sendToGroup 제어 프레임에 연결된 스트림 디스크립터입니다.

StreamAckMessage

메시지 스트리밍.

StreamClosedMessage

종료 메시지 스트리밍.

StreamDataError

스트림 오류 상세 정보.

StreamDataMessage

데이터 메시지 스트리밍. 페이로드는 오직 키페얼라이브만 streamId 을 나타냅니다.

StreamEndError

스트림 종료 오류가 아웃바운드 스트림이 서비스로 보낼 수 있습니다. 서비스는 상위 수준의 오류 이름 분류를 결정합니다.

StreamEndMessage

스트림 종료 메시지.

StreamInfo

스트림 메타데이터를 하위 데이터 메시지에 첨부합니다.

StreamNackMessage

나크 메시지를 스트리밍하세요.

SubscribeGroupStateMessage

그룹 상태 메시지 구독

UnsubscribeGroupStateMessage

그룹 상태 메시지 구독 취소

WebPubSubClientCredential

WebPubSubClient 자격 증명

WebPubSubClientOptions

클라이언트 옵션

WebPubSubClientProtocol

웹 pubsub 하위 프로토콜에 대해 구현할 인터페이스입니다.

WebPubSubMessageBase

웹 pubsub 메시지의 공통

WebPubSubResult

ack 결과

WebPubSubRetryOptions

다시 시도 옵션

형식 별칭

DownstreamMessageType

다운스트림 메시지에 대한 형식

JSONTypes

JSON으로 serialize 및 전송할 수 있는 형식입니다.

RetryMode

재시도 모드 유형에 대해 설명합니다.

UpstreamMessageType

업스트림 메시지의 형식

WebPubSubDataType

데이터 형식

WebPubSubMessage

Web pubsub 메시지

함수

WebPubSubJsonProtocol()

"json.webpubsub.azure.v1" 프로토콜 반환

WebPubSubJsonReliableProtocol()

"json.reliable.webpubsub.azure.v1" 프로토콜 반환

함수 세부 정보

WebPubSubJsonProtocol()

"json.webpubsub.azure.v1" 프로토콜 반환

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

반품

WebPubSubJsonReliableProtocol()

"json.reliable.webpubsub.azure.v1" 프로토콜 반환

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

반품