Game Session Protocol

NEX Protocols > Game Session (42)

Method ID	Method Name
1	CreateSession
2	UpdateSession
3	DeleteSession
4	MigrateSession
5	LeaveSession
6	GetSession
7	SearchSessions
8	AddParticipants
9	RemoveParticipants
10	GetParticipantCount
11	GetParticipants
12	SendInvitation
13	GetInvitationReceivedCount
14	GetInvitationsReceived
15	GetInvitationSentCount
16	GetInvitationsSent
17	AcceptInvitation
18	DeclineInvitation
19	CancelInvitation
20	SendTextMessage
21	RegisterURLs
22	JoinSession
23	AbandonSession
24	SearchSessionsWithParticipants
25	GetSessions
26	GetParticipantsURLs
27	MigrateSessionHost
28	SplitSession
29	SearchSocialSessions
30	ReportUnsuccessfulJoinSessions

(1) CreateSession

Request

Type	Name
GameSession	gameSession

Response

Type	Name
GameSessionKey	gameSessionKey

(2) UpdateSession

Request

Type	Name
GameSessionUpdate	gameSessionUpdate

Response

This method does not return anything.

(3) DeleteSession

Request

Type	Name
GameSessionKey	gameSessionKey

Response

This method does not return anything.

(4) MigrateSession

Request

Type	Name
GameSessionKey	gameSessionKey

Response

Type	Name
GameSessionKey	gameSessionKeyMigrated

(5) LeaveSession

Request

Type	Name
GameSessionKey	gameSessionKey

Response

This method does not return anything.

(6) GetSession

Request

Type	Name
GameSessionKey	gameSessionKey

Response

Type	Name
GameSessionSearchResult	searchResult

(7) SearchSessions

Request

Type	Name
GameSessionQuery	gameSessionQuery

Response

Type	Name
List<GameSessionSearchResult>	searchResults

(8) AddParticipants

Request

Type	Name
GameSessionKey	gameSessionKey
List<Uint32>	publicParticipantIDs
List<Uint32>	privateParticipantIDs

Response

This method does not return anything.

(9) RemoveParticipants

Request

Type	Name
GameSessionKey	gameSessionKey
List<Uint32>	participantIDs

Response

This method does not return anything.

(10) GetParticipantCount

Request

Type	Name
GameSessionKey	gameSessionKey

Response

Type	Name
Uint32	count

(11) GetParticipants

Request

Type	Name
GameSessionKey	gameSessionKey
ResultRange	resultRange

Response

Type	Name
List<GameSessionParticipant>	participants

(12) SendInvitation

Request

Type	Name
GameSessionInvitation	invitation

Response

This method does not return anything.

(13) GetInvitationReceivedCount

Request

Type	Name
Uint32	gameSessionTypeID

Response

Type	Name
Uint32	count

(14) GetInvitationsReceived

Request

Type	Name
Uint32	gameSessionTypeID
ResultRange	resultRange

Response

Type	Name
List<GameSessionInvitationReceived>	invitations

(15) GetInvitationSentCount

Request

Type	Name
Uint32	gameSessionTypeID

Response

Type	Name
Uint32	count

(16) GetInvitationsSent

Request

Type	Name
Uint32	gameSessionTypeID
ResultRange	resultRange

Response

Type	Name
List<GameSessionInvitationSent>	invitations

(17) AcceptInvitation

Request

Type	Name
GameSessionInvitationReceived	gameSessionInvitation

Response

This method does not return anything.

(18) DeclineInvitation

Request

Type	Name
GameSessionInvitationReceived	gameSessionInvitation

Response

This method does not return anything.

(19) CancelInvitation

Request

Type	Name
GameSessionInvitationSent	gameSessionInvitation

Response

This method does not return anything.

(20) SendTextMessage

Request

Type	Name
GameSessionMessage	gameSessionMessage

Response

This method does not return anything.

(21) RegisterURLs

Request

Type	Name
List<StationURL>	stationURLs

Response

This method does not return anything.

(22) JoinSession

Request

Type	Name
GameSessionKey	gameSessionKey

Response

This method does not return anything.

(23) AbandonSession

Request

Type	Name
GameSessionKey	gameSessionKey

Response

This method does not return anything.

(24) SearchSessionsWithParticipants

Request

Type	Name
Uint32	gameSessionTypeID
List<Uint32>	participantIDs

Response

Type	Name
List<GameSessionSearchWithParticipantsResult>	searchResults

(25) GetSessions

Request

Type	Name
List<GameSessionKey>	gameSessionKeys

Response

Type	Name
List<GameSessionSearchResult>	searchResults

(26) GetParticipantsURLs

Request

Type	Name
GameSessionKey	gameSessionKey
List<Uint32>	participantIDs

Response

Type	Name
List<GameSessionParticipant>	participants

(27) MigrateSessionHost

Request

Type	Name
GameSessionKey	gameSessionKey

Response

This method does not return anything.

(28) SplitSession

Request

Type	Name
GameSessionKey	gameSessionKey

Response

Type	Name
GameSessionKey	gameSessionKeyMigrated

(29) SearchSocialSessions

Request

Type	Name
GameSessionSocialQuery	gameSessionSocialQuery

Response

Type	Name
List<GameSessionSearchWithParticipantsResult>	searchResults

(30) ReportUnsuccessfulJoinSessions

Request

Type	Name
List<GameSessionUnsuccessfulJoinSession>	unsuccessfulJoinSessions

Response

This method does not return anything.

Types

GameSessionKey (Structure)

Type	Name
Uint32	m_typeID
Uint32	m_sessionID

GameSession (Structure)

Type	Name
Uint32	m_typeID
List<Property>	m_attributes

GameSessionSearchResult (Structure)

Type	Name
GameSessionKey	m_sessionKey
Uint32	m_hostPID
List<StationURL>	m_hostURLs
List<Property>	m_attributes

GameSessionUpdate (Structure)

Type	Name
GameSessionKey	m_sessionKey
List<Property>	m_attributes

GameSessionParticipant (Structure)

Type	Name
Uint32	m_PID
String	m_name
List<StationURL>	m_stationURLs

GameSessionInvitation (Structure)

Type	Name
GameSessionKey	m_sessionKey
List<Uint32>	m_recipientPIDs
String	m_message

GameSessionInvitationSent (Structure)

Type	Name
GameSessionKey	m_sessionKey
Uint32	m_recipientPID
String	m_message
DateTime	m_creationTime

GameSessionInvitationReceived (Structure)

Type	Name
GameSessionKey	m_sessionKey
Uint32	m_senderPID
String	m_message
DateTime	m_creationTime

GameSessionQuery (Structure)

Type	Name
Uint32	m_typeID
Uint32	m_queryID
List<Property>	m_parameters

GameSessionSocialQuery (Structure)

Type	Name
Uint32	m_typeID
Uint32	m_queryID
List<Property>	m_parameters
List<Uint32>	m_participantIDs

GameSessionMessage (Structure)

Type	Name
GameSessionKey	m_sessionKey
String	m_message

GameSessionSearchWithParticipantsResult (Structure)

Type	Name
List<Uint32>	m_participantIDs

GameSessionUnsuccessfulJoinSession (Structure)

Type	Name
GameSessionKey	m_sessionKey
Uint32	m_errorCategory
Sint32	m_errorCode

Property (Structure)

Type	Description
Uint32	ID
Uint32	Value