Class PlayClient

Namespace

Coherence.Runtime

Assembly

Coherence.Runtime.dll

[Obsolete("You should use the CloudService instance from CoherenceBridge to communicate with the coherence Cloud.")]
[Deprecated("01/03/2023", 1, 0, 0, Reason = "PlayClient has been deprecated, use CloudService instead.")]
public class PlayClient : IRequestFactory

Inheritance

object

PlayClient

Implements

IRequestFactory

Constructors

PlayClient(string, IRuntimeSettings)

public PlayClient(string id, IRuntimeSettings runtimeSettings)

Parameters

id string

runtimeSettings IRuntimeSettings

Properties

AuthClient

public AuthClient AuthClient { get; }

Property Value

AuthClient

IsReady

public bool IsReady { get; }

Property Value

bool

KvStoreClient

public KvStoreClient KvStoreClient { get; }

Property Value

KvStoreClient

MatchmakerClient

public MatchmakerClient MatchmakerClient { get; }

Property Value

MatchmakerClient

RoomsResolverClient

public RoomsResolverClient RoomsResolverClient { get; }

Property Value

RoomsResolverClient

RuntimeSettings

public IRuntimeSettings RuntimeSettings { get; }

Property Value

IRuntimeSettings

WorldsResolverClient

public WorldsResolverClient WorldsResolverClient { get; }

Property Value

WorldsResolverClient

Methods

DisconnectWebSocket()

public void DisconnectWebSocket()

Dispose()

public void Dispose()

GetRequestCooldown(string, string)

public TimeSpan GetRequestCooldown(string request, string method)

Parameters

request string

method string

Returns

TimeSpan

SendCustomRequest(string, string, string, string, Action<RequestResponse<string>>)

public void SendCustomRequest(string endpoint, string path, string method, string body, Action<RequestResponse<string>> callback)

Parameters

endpoint string

path string

method string

body string

callback Action<RequestResponse<string>>

SendCustomRequestAsync(string, string, string, string)

public Task<string> SendCustomRequestAsync(string endpoint, string path, string method, string body)

Parameters

endpoint string

path string

method string

body string

Returns

Task<string>

SendRequest(string, string, string, Dictionary<string, string>, string, string, Action<RequestResponse<string>>)

public void SendRequest(string basePath, string method, string body, Dictionary<string, string> headers, string requestName, string sessionToken, Action<RequestResponse<string>> callback)

Parameters

basePath string

method string

body string

headers Dictionary<string, string>

requestName string

sessionToken string

callback Action<RequestResponse<string>>

SendRequest(string, string, string, string, Dictionary<string, string>, string, string, Action<RequestResponse<string>>)

public void SendRequest(string basePath, string pathParams, string method, string body, Dictionary<string, string> headers, string requestName, string sessionToken, Action<RequestResponse<string>> callback)

Parameters

basePath string

pathParams string

method string

body string

headers Dictionary<string, string>

requestName string

sessionToken string

callback Action<RequestResponse<string>>

SendRequestAsync(string, string, string, Dictionary<string, string>, string, string)

public Task<string> SendRequestAsync(string basePath, string method, string body, Dictionary<string, string> headers, string requestName, string sessionToken)

Parameters

basePath string

method string

body string

headers Dictionary<string, string>

requestName string

sessionToken string

Returns

Task<string>

SendRequestAsync(string, string, string, string, Dictionary<string, string>, string, string)

public Task<string> SendRequestAsync(string basePath, string pathParams, string method, string body, Dictionary<string, string> headers, string requestName, string sessionToken)

Parameters

basePath string

pathParams string

method string

body string

headers Dictionary<string, string>

requestName string

sessionToken string

Returns

Task<string>

SetRequestThrottling(TimeSpan)

public void SetRequestThrottling(TimeSpan requestInterval)

Parameters

requestInterval TimeSpan

Events

OnWebSocketConnect

public event Action OnWebSocketConnect

Event Type

Action

OnWebSocketConnectionError

public event Action OnWebSocketConnectionError

Event Type

Action

OnWebSocketDisconnect

public event Action OnWebSocketDisconnect

Event Type

Action