WebPubSubClient class
The WebPubSub client
Constructors
| Web |
Create an instance of WebPubSubClient |
| Web |
Create an instance of WebPubSubClient |
Methods
Constructor Details
WebPubSubClient(string, WebPubSubClientOptions)
Create an instance of WebPubSubClient
new WebPubSubClient(clientAccessUrl: string, options?: WebPubSubClientOptions)Parameters
- clientAccessUrl
-
string
The uri to connect
- options
- WebPubSubClientOptions
The client options
WebPubSubClient(WebPubSubClientCredential, WebPubSubClientOptions)
Create an instance of WebPubSubClient
new WebPubSubClient(credential: WebPubSubClientCredential, options?: WebPubSubClientOptions)Parameters
- credential
- WebPubSubClientCredential
The credential to use when connecting
- options
- WebPubSubClientOptions
The client options
Method Details
invokeEvent(string, JSONTypes | ArrayBuffer, WebPubSubDataType, InvokeEventOptions)
Invoke an upstream event and wait for the correlated response.
function invokeEvent(eventName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: InvokeEventOptions): Promise<InvokeEventResult>Parameters
- eventName
-
string
The event name
- content
-
JSONTypes | ArrayBuffer
The payload
- dataType
- WebPubSubDataType
The payload type
- options
- InvokeEventOptions
Invoke options
Returns
Promise<InvokeEventResult>
joinGroup(string, JoinGroupOptions)
Join the client to group
function joinGroup(groupName: string, options?: JoinGroupOptions): Promise<WebPubSubResult>Parameters
- groupName
-
string
The group name
- options
- JoinGroupOptions
The join group options
Returns
Promise<WebPubSubResult>
leaveGroup(string, LeaveGroupOptions)
Leave the client from group
function leaveGroup(groupName: string, options?: LeaveGroupOptions): Promise<WebPubSubResult>Parameters
- groupName
-
string
The group name
- options
- LeaveGroupOptions
Returns
Promise<WebPubSubResult>
off("connected", (e: OnConnectedArgs) => void)
Remove handler for connected event
function off(event: "connected", listener: (e: OnConnectedArgs) => void)Parameters
- event
-
"connected"
The event name
- listener
-
(e: OnConnectedArgs) => void
The handler
off("disconnected", (e: OnDisconnectedArgs) => void)
Remove handler for disconnected event
function off(event: "disconnected", listener: (e: OnDisconnectedArgs) => void)Parameters
- event
-
"disconnected"
The event name
- listener
-
(e: OnDisconnectedArgs) => void
The handler
off("group-message", (e: OnGroupDataMessageArgs) => void)
Remove handler for group message
function off(event: "group-message", listener: (e: OnGroupDataMessageArgs) => void)Parameters
- event
-
"group-message"
The event name
- listener
-
(e: OnGroupDataMessageArgs) => void
The handler
off("rejoin-group-failed", (e: OnRejoinGroupFailedArgs) => void)
Remove handler for rejoining group failed
function off(event: "rejoin-group-failed", listener: (e: OnRejoinGroupFailedArgs) => void)Parameters
- event
-
"rejoin-group-failed"
The event name
- listener
-
(e: OnRejoinGroupFailedArgs) => void
The handler
off("server-message", (e: OnServerDataMessageArgs) => void)
Remove handler for server message
function off(event: "server-message", listener: (e: OnServerDataMessageArgs) => void)Parameters
- event
-
"server-message"
The event name
- listener
-
(e: OnServerDataMessageArgs) => void
The handler
off("stopped", (e: OnStoppedArgs) => void)
Remove handler for stopped event
function off(event: "stopped", listener: (e: OnStoppedArgs) => void)Parameters
- event
-
"stopped"
The event name
- listener
-
(e: OnStoppedArgs) => void
The handler
on("connected", (e: OnConnectedArgs) => void)
Add handler for connected event
function on(event: "connected", listener: (e: OnConnectedArgs) => void)Parameters
- event
-
"connected"
The event name
- listener
-
(e: OnConnectedArgs) => void
The handler
on("disconnected", (e: OnDisconnectedArgs) => void)
Add handler for disconnected event
function on(event: "disconnected", listener: (e: OnDisconnectedArgs) => void)Parameters
- event
-
"disconnected"
The event name
- listener
-
(e: OnDisconnectedArgs) => void
The handler
on("group-message", (e: OnGroupDataMessageArgs) => void)
Add handler for group messags
function on(event: "group-message", listener: (e: OnGroupDataMessageArgs) => void)Parameters
- event
-
"group-message"
The event name
- listener
-
(e: OnGroupDataMessageArgs) => void
The handler
on("rejoin-group-failed", (e: OnRejoinGroupFailedArgs) => void)
Add handler for rejoining group failed
function on(event: "rejoin-group-failed", listener: (e: OnRejoinGroupFailedArgs) => void)Parameters
- event
-
"rejoin-group-failed"
The event name
- listener
-
(e: OnRejoinGroupFailedArgs) => void
The handler
on("server-message", (e: OnServerDataMessageArgs) => void)
Add handler for server messages
function on(event: "server-message", listener: (e: OnServerDataMessageArgs) => void)Parameters
- event
-
"server-message"
The event name
- listener
-
(e: OnServerDataMessageArgs) => void
The handler
on("stopped", (e: OnStoppedArgs) => void)
Add handler for stopped event
function on(event: "stopped", listener: (e: OnStoppedArgs) => void)Parameters
- event
-
"stopped"
The event name
- listener
-
(e: OnStoppedArgs) => void
The handler
onGroupStream((stream: GroupStream) => void | Promise<void>, OnGroupStreamOptions)
Subscribe to inbound group streams. The callback is invoked once for each newly observed stream.
function onGroupStream(callback: (stream: GroupStream) => void | Promise<void>, options?: OnGroupStreamOptions): GroupStreamSubscriptionParameters
- callback
-
(stream: GroupStream) => void | Promise<void>
Callback invoked with each inbound stream.
- options
- OnGroupStreamOptions
Per-subscription options controlling how streams are tracked.
Returns
openGroupStream(string, OpenGroupStreamOptions)
Open an outbound stream to a group.
function openGroupStream(groupName: string, options?: OpenGroupStreamOptions): Promise<GroupStreamWriter>Parameters
- groupName
-
string
Target group name.
- options
- OpenGroupStreamOptions
Stream open options.
Returns
Promise<GroupStreamWriter>
sendEvent(string, JSONTypes | ArrayBuffer, WebPubSubDataType, SendEventOptions)
Send custom event to server.
function sendEvent(eventName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: SendEventOptions): Promise<WebPubSubResult>Parameters
- eventName
-
string
The event name
- content
-
JSONTypes | ArrayBuffer
The data content
- dataType
- WebPubSubDataType
The data type
- options
- SendEventOptions
The options
Returns
Promise<WebPubSubResult>
sendToGroup(string, JSONTypes | ArrayBuffer, WebPubSubDataType, SendToGroupOptions)
Send message to group.
function sendToGroup(groupName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: SendToGroupOptions): Promise<WebPubSubResult>Parameters
- groupName
-
string
The group name
- content
-
JSONTypes | ArrayBuffer
The data content
- dataType
- WebPubSubDataType
The data type
- options
- SendToGroupOptions
The options
Returns
Promise<WebPubSubResult>
start(StartOptions)
Start to start to the service.
function start(options?: StartOptions): Promise<void>Parameters
- options
- StartOptions
Returns
Promise<void>
stop()
Stop the client.
function stop()