WebPubSubClient class

Pakiet:

@azure/web-pubsub-client

Klient WebPubSub

Konstruktory

WebPubSubClient(string, WebPubSubClientOptions)	Tworzenie wystąpienia klasy WebPubSubClient
WebPubSubClient(WebPubSubClientCredential, WebPubSubClientOptions)	Tworzenie wystąpienia klasy WebPubSubClient

Metody

invokeEvent(string, JSONTypes | ArrayBuffer, WebPubSubDataType, InvokeEventOptions)	Wywołaj zdarzenie upstream i czekaj na skorelowaną odpowiedź.
joinGroup(string, JoinGroupOptions)	Dołączanie klienta do grupy
leaveGroup(string, LeaveGroupOptions)	Pozostaw klienta z grupy
off("connected", (e: OnConnectedArgs) => void)	Usuń procedurę obsługi dla połączonego zdarzenia
off("disconnected", (e: OnDisconnectedArgs) => void)	Usuń procedurę obsługi dla zdarzenia rozłączonego
off("group-message", (e: OnGroupDataMessageArgs) => void)	Usuń procedurę obsługi komunikatu grupy
off("rejoin-group-failed", (e: OnRejoinGroupFailedArgs) => void)	Usuwanie procedury obsługi ponownego dołączania grupy nie powiodło się
off("server-message", (e: OnServerDataMessageArgs) => void)	Usuń procedurę obsługi komunikatu serwera
off("stopped", (e: OnStoppedArgs) => void)	Usuwanie procedury obsługi zatrzymanych zdarzeń
on("connected", (e: OnConnectedArgs) => void)	Dodawanie procedury obsługi dla połączonego zdarzenia
on("disconnected", (e: OnDisconnectedArgs) => void)	Dodawanie procedury obsługi dla zdarzenia rozłączonego
on("group-message", (e: OnGroupDataMessageArgs) => void)	Dodawanie obsługi komunikatów grupowych
on("rejoin-group-failed", (e: OnRejoinGroupFailedArgs) => void)	Dodawanie procedury obsługi ponownego dołączania grupy nie powiodło się
on("server-message", (e: OnServerDataMessageArgs) => void)	Dodawanie programu obsługi dla komunikatów serwera
on("stopped", (e: OnStoppedArgs) => void)	Dodawanie procedury obsługi dla zatrzymanych zdarzeń
sendEvent(string, JSONTypes | ArrayBuffer, WebPubSubDataType, SendEventOptions)	Wyślij zdarzenie niestandardowe na serwer.
sendToGroup(string, JSONTypes | ArrayBuffer, WebPubSubDataType, SendToGroupOptions)	Wyślij wiadomość do grupy.
start(StartOptions)	Rozpocznij pracę z usługą.
stop()	Zatrzymaj klienta.

Szczegóły konstruktora

WebPubSubClient(string, WebPubSubClientOptions)

Tworzenie wystąpienia klasy WebPubSubClient

new WebPubSubClient(clientAccessUrl: string, options?: WebPubSubClientOptions)

Parametry

clientAccessUrl

string

Identyfikator URI do nawiązania połączenia

options

WebPubSubClientOptions

Opcje klienta

WebPubSubClient(WebPubSubClientCredential, WebPubSubClientOptions)

Tworzenie wystąpienia klasy WebPubSubClient

new WebPubSubClient(credential: WebPubSubClientCredential, options?: WebPubSubClientOptions)

Parametry

credential

WebPubSubClientCredential

Poświadczenie do użycia podczas nawiązywania połączenia

options

WebPubSubClientOptions

Opcje klienta

Szczegóły metody

invokeEvent(string, JSONTypes | ArrayBuffer, WebPubSubDataType, InvokeEventOptions)

Wywołaj zdarzenie upstream i czekaj na skorelowaną odpowiedź.

function invokeEvent(eventName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: InvokeEventOptions): Promise<InvokeEventResult>

Parametry

eventName

string

Nazwa zdarzenia

content

JSONTypes | ArrayBuffer

Ładunek

dataType

WebPubSubDataType

Typ ładunku

options

InvokeEventOptions

Opcje wywołania

Zwraca

Promise<InvokeEventResult>

joinGroup(string, JoinGroupOptions)

Dołączanie klienta do grupy

function joinGroup(groupName: string, options?: JoinGroupOptions): Promise<WebPubSubResult>

Parametry

groupName

string

Nazwa grupy

options

JoinGroupOptions

Opcje grupy dołączania

Zwraca

Promise<WebPubSubResult>

leaveGroup(string, LeaveGroupOptions)

Pozostaw klienta z grupy

function leaveGroup(groupName: string, options?: LeaveGroupOptions): Promise<WebPubSubResult>

Parametry

groupName

string

Nazwa grupy

options

LeaveGroupOptions

Zwraca

Promise<WebPubSubResult>

off("connected", (e: OnConnectedArgs) => void)

Usuń procedurę obsługi dla połączonego zdarzenia

function off(event: "connected", listener: (e: OnConnectedArgs) => void)

Parametry

event

"connected"

Nazwa zdarzenia

listener

(e: OnConnectedArgs) => void

Procedura obsługi

off("disconnected", (e: OnDisconnectedArgs) => void)

Usuń procedurę obsługi dla zdarzenia rozłączonego

function off(event: "disconnected", listener: (e: OnDisconnectedArgs) => void)

Parametry

event

"disconnected"

Nazwa zdarzenia

listener

(e: OnDisconnectedArgs) => void

Procedura obsługi

off("group-message", (e: OnGroupDataMessageArgs) => void)

Usuń procedurę obsługi komunikatu grupy

function off(event: "group-message", listener: (e: OnGroupDataMessageArgs) => void)

Parametry

event

"group-message"

Nazwa zdarzenia

listener

(e: OnGroupDataMessageArgs) => void

Procedura obsługi

off("rejoin-group-failed", (e: OnRejoinGroupFailedArgs) => void)

Usuwanie procedury obsługi ponownego dołączania grupy nie powiodło się

function off(event: "rejoin-group-failed", listener: (e: OnRejoinGroupFailedArgs) => void)

Parametry

event

"rejoin-group-failed"

Nazwa zdarzenia

listener

(e: OnRejoinGroupFailedArgs) => void

Procedura obsługi

off("server-message", (e: OnServerDataMessageArgs) => void)

Usuń procedurę obsługi komunikatu serwera

function off(event: "server-message", listener: (e: OnServerDataMessageArgs) => void)

Parametry

event

"server-message"

Nazwa zdarzenia

listener

(e: OnServerDataMessageArgs) => void

Procedura obsługi

off("stopped", (e: OnStoppedArgs) => void)

Usuwanie procedury obsługi zatrzymanych zdarzeń

function off(event: "stopped", listener: (e: OnStoppedArgs) => void)

Parametry

event

"stopped"

Nazwa zdarzenia

listener

(e: OnStoppedArgs) => void

Procedura obsługi

on("connected", (e: OnConnectedArgs) => void)

Dodawanie procedury obsługi dla połączonego zdarzenia

function on(event: "connected", listener: (e: OnConnectedArgs) => void)

Parametry

event

"connected"

Nazwa zdarzenia

listener

(e: OnConnectedArgs) => void

Procedura obsługi

on("disconnected", (e: OnDisconnectedArgs) => void)

Dodawanie procedury obsługi dla zdarzenia rozłączonego

function on(event: "disconnected", listener: (e: OnDisconnectedArgs) => void)

Parametry

event

"disconnected"

Nazwa zdarzenia

listener

(e: OnDisconnectedArgs) => void

Procedura obsługi

on("group-message", (e: OnGroupDataMessageArgs) => void)

Dodawanie obsługi komunikatów grupowych

function on(event: "group-message", listener: (e: OnGroupDataMessageArgs) => void)

Parametry

event

"group-message"

Nazwa zdarzenia

listener

(e: OnGroupDataMessageArgs) => void

Procedura obsługi

on("rejoin-group-failed", (e: OnRejoinGroupFailedArgs) => void)

Dodawanie procedury obsługi ponownego dołączania grupy nie powiodło się

function on(event: "rejoin-group-failed", listener: (e: OnRejoinGroupFailedArgs) => void)

Parametry

event

"rejoin-group-failed"

Nazwa zdarzenia

listener

(e: OnRejoinGroupFailedArgs) => void

Procedura obsługi

on("server-message", (e: OnServerDataMessageArgs) => void)

Dodawanie programu obsługi dla komunikatów serwera

function on(event: "server-message", listener: (e: OnServerDataMessageArgs) => void)

Parametry

event

"server-message"

Nazwa zdarzenia

listener

(e: OnServerDataMessageArgs) => void

Procedura obsługi

on("stopped", (e: OnStoppedArgs) => void)

Dodawanie procedury obsługi dla zatrzymanych zdarzeń

function on(event: "stopped", listener: (e: OnStoppedArgs) => void)

Parametry

event

"stopped"

Nazwa zdarzenia

listener

(e: OnStoppedArgs) => void

Procedura obsługi

sendEvent(string, JSONTypes | ArrayBuffer, WebPubSubDataType, SendEventOptions)

Wyślij zdarzenie niestandardowe na serwer.

function sendEvent(eventName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: SendEventOptions): Promise<WebPubSubResult>

Parametry

eventName

string

Nazwa zdarzenia

content

JSONTypes | ArrayBuffer

Zawartość danych

dataType

WebPubSubDataType

Typ danych

options

SendEventOptions

Opcje

Zwraca

Promise<WebPubSubResult>

sendToGroup(string, JSONTypes | ArrayBuffer, WebPubSubDataType, SendToGroupOptions)

Wyślij wiadomość do grupy.

function sendToGroup(groupName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: SendToGroupOptions): Promise<WebPubSubResult>

Parametry

groupName

string

Nazwa grupy

content

JSONTypes | ArrayBuffer

Zawartość danych

dataType

WebPubSubDataType

Typ danych

options

SendToGroupOptions

Opcje

Zwraca

Promise<WebPubSubResult>

start(StartOptions)

Rozpocznij pracę z usługą.

function start(options?: StartOptions): Promise<void>

Parametry

options

StartOptions

Zwraca

Promise<void>

stop()

Zatrzymaj klienta.

function stop()