ClientSocket

Inherits IDisposable

Public Member Functions

void

Dispose()

Releases the resources used by this instance.

bool

IsTokenValid()

Checks whether the current JWT token is valid based on its structure and expiration time. if the current token is valid; otherwise, .

void

Connect()

Opens the WebSocket connection.

void

Disconnect()

Closes the WebSocket connection and disposes of the client.

Task

GetAuthCode()

Requests an application auth code from the service. A task that resolves to the received ApplicationAuthCode.

Task

ExtendToken()

Extends the validity period of the current user token. if the token was successfully extended; otherwise, . This method requires the functionality to be enabled for the application on the Crowd Control service. If the application is not authorized to extend tokens, this method will always return false. Please contact Crowd Control support for more information.

Task

RedeemAuthCode(string code)

Redeems an application auth code for a user token and decodes the user information. if the auth code was redeemed successfully; otherwise, .

string?

GetInteractLink()

Gets the Crowd Control interact page link for the current user. The interact page URL for the current user, or if no user is available.

Task

SubscribeTopic(params string[] topic)

Subscribes to one or more PubSub topics. if the subscription message was sent successfully; otherwise, .

Task

SubscribeTopic(IEnumerable topic)

Subscribes to one or more PubSub topics. if the subscription message was sent successfully; otherwise, .

void

RestartSessionIfNeeded(object _)

Timer callback that attempts to restart the session when reconnect conditions are met.

Task

RestartSessionIfNeeded()

Checks the connection and session status, and attempts to restart the session if the connection was lost but auto-reconnect is enabled. A task that completes when the reconnection attempt, if any, has finished.

Task

RestartSession()

Restarts the current game session by resubscribing to the necessary PubSub topics. if the session was successfully restarted; otherwise, .

Task

StartSession(bool forceNew)

Starts a game session for the configured game pack. if the session was successfully started; otherwise, .

Task

StopSession()

Stops the current game session. if the session was successfully stopped; otherwise, .

Task

LoadCustomEffects(IEnumerable effects, CustomEffects.OperationMode mode)

Loads a set of custom effects to the service for the current game pack. if the effects were successfully loaded; otherwise, .

Task

DeleteCustomEffects(IEnumerable effects)

Removes custom effects from the service by their effect IDs. A task that resolves to true when the removal request completes successfully; otherwise false.

Task

DeleteCustomEffects(IEnumerable effects)

Removes custom effects from the service by their effect IDs. A task that resolves to true when the removal request completes successfully; otherwise false.

Task

Ping()

Sends a ping message to the service and waits for a pong response to verify connectivity. if a pong response was received within the timeout period; otherwise, .

Task

Send(string method, JObject payload)

Sends an RPC message with the specified method and payload. if the message was sent successfully; otherwise, .

Task

SendRaw(MessageData message)

Sends message data by wrapping it into a local message payload. if the message was sent successfully; otherwise, .

Task

SendRaw(LocalMessage message)

Sends a raw JSON message over the WebSocket connection. if the message was sent successfully; otherwise, .

Task

SendRaw(JObject message)

Sends a raw JSON message over the WebSocket connection. if the message was sent successfully; otherwise, .

Task

Call(string method, params object[] args)

Sends an RPC call with the specified method and arguments. if the message was sent successfully; otherwise, .

Task

Call(string method, IEnumerable