docs

Gameye.Sdk

Contents

• GameyeClient
  • #ctor(clientConfig)
  • LogStore
  • SessionStore
  • StatisticsStore
  • CommandStartMatch(matchKey,gameKey,locationKeys,templateKey,config,endCallbackUrl)
  • CommandStopMatch(matchKey)
  • SubscribeLogEvents(matchKey,onStreamClosed)
  • SubscribeSessionEvents(onStreamClosed)
  • SubscribeStatisticsEvents(matchKey,onStreamClosed)
• GameyeClientConfig
  • #ctor(endpoint,token)
• LogLine
  • LineKey
  • Payload
  • ToString()
• LogSelectors
  • SelectAllLogs(logState)
  • SelectLogsSince(logState,lineNumber)
• LogStore
  • OnChange
• MissingConfigException
• Player
  • Connected
  • Name
  • PlayerKey
  • Statistic
  • Uid
• Session
  • Created
  • Host
  • Id
  • Image
  • Location
  • Port
• SessionSelectors
  • SelectSession(sessionState,sessionId)
  • SelectSessionList(sessionState)
  • SelectSessionListForGame(sessionState,gameKey)
• SessionStore
  • OnChange
• StatisticsSelectors
  • SelectPlayer(statisticsState,playerKey)
  • SelectPlayerList(statisticsState)
  • SelectPlayerListForTeam(statisticsState,teamKey)
  • SelectRawStatistics(statisticsState)
  • SelectRounds(statisticsState)
  • SelectTeam(statisticsState,teamKey)
  • SelectTeamList(statisticsState)
• StatisticsStore
  • OnChange
• Team
  • Name
  • Player
  • Statistic
  • TeamKey

GameyeClient type

Namespace

Gameye.Sdk

#ctor(clientConfig) constructor

Summary

Create a new client

Parameters

Name	Type	Description
clientConfig	Gameye.Sdk.GameyeClientConfig

LogStore property

Summary

LogStore. Used to add callbacks for events.

SessionStore property

Summary

SessionStore. Used to add callbacks for events.

StatisticsStore property

Summary

StatisticsStore. Used to add callbacks for events.

CommandStartMatch(matchKey,gameKey,locationKeys,templateKey,config,endCallbackUrl) method

Summary

Start a match

Returns

An awaitable task that finishes when the command is executed

Parameters

Name	Type	Description
matchKey	System.String	Unique identifier for the match. Also known as SessionId
gameKey	System.String	Identifier for the game (eg: csgo)
locationKeys	System.String[]	Array of locations
templateKey	System.String	Game template
config	System.Collections.Generic.Dictionary{System.String,System.Object}	Game config dictionary
endCallbackUrl	System.String	(Optional) The url callback when the game is finished

Exceptions

Name	Description
Gameye.Messaging.Client.CommandException	Thrown if the command fails

CommandStopMatch(matchKey) method

Summary

Stop a match

Returns

An awaitable task that finishes when the command is executed

Parameters

Name	Type	Description
matchKey	System.String	Unique identifier for the match. Also known as SessionId

Exceptions

Name	Description
Gameye.Messaging.Client.CommandException	Thrown if the command fails

SubscribeLogEvents(matchKey,onStreamClosed) method

Summary

Subscribe to all log events for a given match

Returns

An awaitable task that finishes when the stream is opened

Parameters

Name	Type	Description
matchKey	System.String	Unique identifier for the match. Also known as SessionId
onStreamClosed	System.Action	(Optional) callback when the stream is closed. This occurs when a match ends

Exceptions

Name	Description
Gameye.Messaging.Client.CommandException	Thrown if the event stream subscription fails

SubscribeSessionEvents(onStreamClosed) method

Summary

Subscribe to all session events

Returns

An awaitable task that finishes when the stream is opened

Parameters

Name	Type	Description
onStreamClosed	System.Action	(Optional) callback when the stream is closed. This occurs when a match ends

Exceptions

Name	Description
Gameye.Messaging.Client.CommandException	Thrown if the event stream subscription fails

SubscribeStatisticsEvents(matchKey,onStreamClosed) method

Summary

Subscribe to all statistic events for a given match

Returns

An awaitable task that finishes when the stream is opened

Parameters

Name	Type	Description
matchKey	System.String	Unique identifier for the match. Also known as SessionId
onStreamClosed	System.Action	(Optional) callback when the stream is closed. This occurs when a match ends

Exceptions

Name	Description
Gameye.Messaging.Client.CommandException	Thrown if the event stream subscription fails

GameyeClientConfig type

Namespace

Gameye.Sdk

Summary

Client config for the Gameye SDK

#ctor(endpoint,token) constructor

Summary

Create a new client config

Parameters

Name	Type	Description
endpoint	System.String	The endpoint provided to you by Gameye
token	System.String	The API token provided to you by Gameye

Exceptions

Name	Description
Gameye.Sdk.MissingConfigException	When a required element is missing from the config

LogLine type

Namespace

Gameye.Sdk

Summary

Log Line Object

LineKey property

Summary

The line number

Payload property

Summary

The log message

ToString() method

Summary

Print this LogLine object in the format $"{LineKey}: {Payload}"

Returns

Parameters

This method has no parameters.

LogSelectors type

Namespace

Gameye.Sdk

SelectAllLogs(logState) method

Summary

Select all the LogLines in the store. Use this as an extension method on LogState

Returns

An ImmutableArray of LogLine

Parameters

Name	Type	Description
logState	Gameye.Sdk.LogState

SelectLogsSince(logState,lineNumber) method

Summary

Select all the LogLines since a given line number. Use this as an extension method on LogState

Returns

An ImmutableArrayof LogLines

Parameters

Name	Type	Description
logState	Gameye.Sdk.LogState
lineNumber	System.Int32	The line number after which to select LogLines

LogStore type

Namespace

Gameye.Sdk

OnChange property

Summary

Triggered when a Log subsciption receieves new events

MissingConfigException type

Namespace

Gameye.Sdk

Summary

Exception representing a missing field in the GameyeClientConfig

Player type

Namespace

Gameye.Sdk

Summary

Player object for Statistics purposes

Connected property

Summary

Is the player currently connected

Name property

Summary

Player name

PlayerKey property

Summary

Player key

Statistic property

Summary

Player statistics

Uid property

Summary

Unique identifier of a player

Session type

Namespace

Gameye.Sdk

Summary

Session object

Created property

Summary

Unix epoch time of when the session was created

Host property

Summary

IP address of the Host of the session

Id property

Summary

The unique identifier of a session. Also known as the Match Key.

Image property

Summary

Game image used to launch the session. Also known as the Game Key

Location property

Summary

Hosted location of the session

Port property

Summary

Dictionary of Ports available for this session

SessionSelectors type

Namespace

Gameye.Sdk

SelectSession(sessionState,sessionId) method

Summary

Select a single Session with the given id. Use this as an extension method on SessionState

Returns

A Session object or null if not found

Parameters

Name	Type	Description
sessionState	Gameye.Sdk.SessionState
sessionId	System.String	Unique identifier of the Session. Also known as Match Key

SelectSessionList(sessionState) method

Summary

Select all the active Sessions. Use this as an extension method on SessionState

Returns

An ImmutableArray of Session

Parameters

Name	Type	Description
sessionState	Gameye.Sdk.SessionState

SelectSessionListForGame(sessionState,gameKey) method

Summary

Select Sessions with the given game key. Use this as an extension method on SessionState

Returns

An ImmutableArray of Session

Parameters

Name	Type	Description
sessionState	Gameye.Sdk.SessionState
gameKey	System.String	Key of the game (eg: csgo)

SessionStore type

Namespace

Gameye.Sdk

OnChange property

Summary

Triggered when a session subsciption receieves new events

StatisticsSelectors type

Namespace

Gameye.Sdk

SelectPlayer(statisticsState,playerKey) method

Summary

Select a single Player by key. Use this as an extension method on StatisticsState

Returns

A Player object or null if not found

Parameters

Name	Type	Description
statisticsState	Gameye.Sdk.StatisticsState
playerKey	System.String	Key of the Player

SelectPlayerList(statisticsState) method

Summary

Select the list of all Players. Use this as an extension method on StatisticsState

Returns

An ImmutableArray of Player

Parameters

Name	Type	Description
statisticsState	Gameye.Sdk.StatisticsState

SelectPlayerListForTeam(statisticsState,teamKey) method

Summary

Select the list of Players on a given Team. Use this as an extension method on StatisticsState

Returns

An ImmutableArray of Player

Parameters

Name	Type	Description
statisticsState	Gameye.Sdk.StatisticsState
teamKey	System.String	Key of the Team

SelectRawStatistics(statisticsState) method

Summary

Select the raw statistics Json. Use this as an extension method on StatisticsState

Returns

A JObject containing the current statistics snapshot

Parameters

Name	Type	Description
statisticsState	Gameye.Sdk.StatisticsState

SelectRounds(statisticsState) method

Summary

Select the number of started rounds. Use this as an extension method on StatisticsState

Returns

A long representing the number of started rounds

Parameters

Name	Type	Description
statisticsState	Gameye.Sdk.StatisticsState

SelectTeam(statisticsState,teamKey) method

Summary

Select a single Team by key. Use this as an extension method on StatisticsState

Returns

A Team object or null if not found

Parameters

Name	Type	Description
statisticsState	Gameye.Sdk.StatisticsState
teamKey	System.String	Key of the Team

SelectTeamList(statisticsState) method

Summary

Select the list of all Teams. Use this as an extension method on StatisticsState

Returns

An ImmutableArray of Team

Parameters

Name	Type	Description
statisticsState	Gameye.Sdk.StatisticsState

StatisticsStore type

Namespace

Gameye.Sdk

OnChange property

Summary

Triggered when a statistics subsciption receieves new events

Team type

Namespace

Gameye.Sdk

Summary

Team object for Statistics purposes

Name property

Summary

Team name

Player property

Summary

Dictionary of players and whether they are currently on this team

Statistic property

Summary

Team statistics

TeamKey property

Summary

Team key