Class EOS

Namespace

OpenGSQ.Protocols

Assembly

OpenGSQ.dll

Epic Online Services (EOS) Protocol

public class EOS : ProtocolBase

Inheritance

object

ProtocolBase

EOS

Inherited Members

ProtocolBase.Host

ProtocolBase.Port

ProtocolBase.Timeout

ProtocolBase.GetIPAddress()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

EOS(string, int, string, string, int)

Initializes a new instance of the EOS class.

public EOS(string host, int port, string deploymentId, string accessToken, int timeout = 5000)

Parameters

host string

The host name of the server.

port int

The port number of the server.

deploymentId string

The deployment ID for the application.

accessToken string

The access token for the application.

timeout int

The timeout value for the connection, in milliseconds. Default is 5000.

Exceptions

ArgumentException

Thrown when either deploymentId or accessToken is null.

Properties

FullName

Gets the full name of the protocol.

public override string FullName { get; }

Property Value

string

Methods

GetAccessTokenAsync(string, string, string, string, string, string)

Asynchronously gets an access token.

public static Task<string> GetAccessTokenAsync(string clientId, string clientSecret, string deploymentId, string grantType, string externalAuthType, string externalAuthToken)

Parameters

clientId string

clientSecret string

deploymentId string

grantType string

externalAuthType string

externalAuthToken string

Returns

Task<string>

A task that represents the asynchronous operation. The task result contains the access token.

GetExternalAuthTokenAsync(string, string, string)

Asynchronously retrieves an external authentication token.

public static Task<string> GetExternalAuthTokenAsync(string clientId, string clientSecret, string externalAuthType)

Parameters

clientId string

The client ID.

clientSecret string

The client secret.

externalAuthType string

The type of external authentication.

Returns

Task<string>

A task that represents the asynchronous operation. The task result contains the access token.

Exceptions

ArgumentException

Thrown when either clientId or clientSecret is null.

NotImplementedException

Thrown when the provided externalAuthType hasn't been implemented yet.

GetInfo()

Retrieves the information about the game server.

public Task<Dictionary<string, JsonElement>> GetInfo()

Returns

Task<Dictionary<string, JsonElement>>

A task that represents the asynchronous operation. The task result contains a dictionary of the server information.

Exceptions

ServerNotFoundException

Thrown when the server is not found.

AuthenticationException

Thrown when there is a failure in getting the access token.

GetMatchmakingAsync(string, string)

Asynchronously retrieves matchmaking data without any filter parameters.

public static Task<Matchmaking> GetMatchmakingAsync(string deploymentId, string accessToken)

Parameters

deploymentId string

The deployment ID.

accessToken string

The access token.

Returns

Task<Matchmaking>

A task that represents the asynchronous operation. The task result contains the matchmaking data.

GetMatchmakingAsync(string, string, Dictionary<string, object>)

Asynchronously retrieves matchmaking data.

public static Task<Matchmaking> GetMatchmakingAsync(string deploymentId, string accessToken, Dictionary<string, object> filter)

Parameters

deploymentId string

The deployment ID.

accessToken string

The access token.

filter Dictionary<string, object>

The filter parameters for the matchmaking request.

Returns

Task<Matchmaking>

A task that represents the asynchronous operation. The task result contains the matchmaking data.