Skip to content

Match Making Protocol

Yannik Marchand edited this page Feb 4, 2021 · 18 revisions

NEX Protocols > Match Making (21)

Method ID Method Name
1 RegisterGathering
2 UnregisterGathering
3 UnregisterGatherings
4 UpdateGathering
5 Invite
6 AcceptInvitation
7 DeclineInvitation
8 CancelInvitation
9 GetInvitationsSent
10 GetInvitationsReceived
11 Participate
12 CancelParticipation
13 GetParticipants
14 AddParticipants
15 GetDetailedParticipants
16 GetParticipantsURLs
17 FindByType
18 FindByDescription
19 FindByDescriptionRegex
20 FindByID
21 FindBySingleID
22 FindByOwner
23 FindByParticipants
24 FindInvitations
25 FindBySQLQuery
26 LaunchSession
27 UpdateSessionURL
28 GetSessionURL
29 GetState
30 SetState
31 ReportStats
32 GetStats
33 DeleteGathering
34 GetPendingDeletions
35 DeleteFromDeletions
36 MigrateGatheringOwnershipV1
37 FindByDescriptionLike
38 RegisterLocalURL
39 RegisterLocalURLs
40 UpdateSessionHostV1
41 GetSessionURLs
42 UpdateSessionHost
43 UpdateGatheringOwnership
44 MigrateGatheringOwnership

(1) RegisterGathering

Request

Type Name Description
Data<Gathering> anyGathering Gathering

Response

Type Name Description
Uint32 %retval% Gathering id

(2) UnregisterGathering

Request

Type Name Description
Uint32 idGathering Gathering id

Response

Type Name Description
Bool %retval% Result

(3) UnregisterGatherings

Request

Type Name Description
List<Uint32> lstGatherings Gathering ids

Response

Type Name Description
Bool %retval% Result

(4) UpdateGathering

Request

Type Name Description
Data<Gathering> anyGathering Gathering

Response

Type Name Description
Bool %retval% Result

(5) Invite

Request

Type Name Description
Uint32 idGathering Gathering id
List<PID> lstPrincipals Invited user pids
String strMessage Message

Response

Type Name Description
Bool %retval% Result

(6) AcceptInvitation

Request

Type Name Description
Uint32 idGathering Gathering id
String strMessage Message

Response

Type Name Description
Bool %retval% Result

(7) DeclineInvitation

Request

Type Name Description
Uint32 idGathering Gathering id
String strMessage Message

Response

Type Name Description
Bool %retval% Result

(8) CancelInvitation

Request

Type Name Description
Uint32 idGathering Gathering id
List<PID> lstPrincipals User pids
String strMessage Message

Response

Type Name Description
Bool %retval% Result

(9) GetInvitationsSent

Request

Type Name Description
Uint32 idGathering Gathering id

Response

Type Name Description
List<Invitation> lstInvitations Invitations

(10) GetInvitationsReceived

Request

This method does not take any parameters.

Response

Type Name Description
List<Invitation> lstInvitations Invitations

(11) Participate

Request

Type Name Description
Uint32 idGathering Gathering id
String strMessage Message

Response

Type Name Description
Bool %retval% Result

(12) CancelParticipation

Request

Type Name Description
Uint32 idGathering Gathering id
String strMessage Message

Response

Type Name Description
Bool %retval% Result

(13) GetParticipants

Request

Type Name Description
Uint32 idGathering Gathering id

Response

Type Name Description
List<PID> lstParticipants Participant pids

(14) AddParticipants

Request

Type Name Description
Uint32 idGathering Gathering id
List<PID> lstParticipants Participant pids
String strMessage Message

Response

Type Name Description
Bool %retval% Result

(15) GetDetailedParticipants

Request

Type Name Description
Uint32 idGathering Gathering id

Response

Type Name Description
List<ParticipantDetails> lstParticipants Participant details

(16) GetParticipantsURLs

Request

Type Name Description
Uint32 idGathering Gathering id

Response

Type Name Description
List<StationURL> lstStationURL Participant urls

(17) FindByType

Request

Type Name Description
String strType Type
ResultRange resultRange Result range

Response

Type Name Description
List<Data<Gathering>> lstGathering Gatherings

(18) FindByDescription

Request

Type Name Description
String strDescription Description
ResultRange resultRange ResultRange

Response

Type Name Description
List<Data<Gathering>> lstGathering Gatherings

(19) FindByDescriptionRegex

Request

Type Name Description
String strDescriptionRegex Description regex
ResultRange resultRange ResultRange

Response

Type Name Description
List<Data<Gathering>> lstGathering Gatherings

(20) FindByID

Request

Type Name Description
List<Uint32> lstID Gathering ids

Response

Type Name Description
List<Data<Gathering>> lstGathering Gatherings

(21) FindBySingleID

Request

Type Name Description
Uint32 id Gathering id

Response

Type Name Description
Bool bResult Result
Data<Gathering> pGathering Gathering

(22) FindByOwner

Request

Type Name Description
PID id Owner pid
ResultRange resultRange ResultRange

Response

Type Name Description
List<Data<Gathering>> lstGathering Gatherings

(23) FindByParticipants

Request

Type Name Description
List<PID> pid Participant pids

Response

Type Name Description
List<Data<Gathering>> lstGathering Gatherings

(24) FindInvitations

Request

Type Name Description
ResultRange resultRange Result range

Response

Type Name Description
List<Data<Gathering>> lstGathering Gatherings

(25) FindBySQLQuery

Request

Type Name Description
String strQuery SQL query
ResultRange resultRange Result range

Response

Type Name Description
List<Data<Gathering>> lstGathering Gatherings

(26) LaunchSession

Request

Type Name Description
Uint32 idGathering Gathering id
String strURL Session url

Response

Type Name Description
Bool %retval% Result

(27) UpdateSessionURL

Request

Type Name Description
Uint32 idGathering Gathering id
String strURL Session url

Response

Type Name Description
Bool %retval% Result

(28) GetSessionURL

Request

Type Name Description
Uint32 idGathering Gathering id

Response

Type Name Description
Bool %retval% Result
String strURL Session url

(29) GetState

Request

Type Name Description
Uint32 idGathering Gathering id

Response

Type Name Description
Bool %retval% Result
Uint32 uiState State

(30) SetState

Request

Type Name Description
Uint32 idGathering Gathering id
Uint32 uiNewState New state

Response

Type Name Description
Bool %retval% Result

(31) ReportStats

Request

Type Name Description
Uint32 idGathering Gathering id
List<GatheringStats> lstStats Stats

Response

Type Name Description
Bool %retval% Result

(32) GetStats

Request

Type Name Description
Uint32 idGathering Gathering id
List<PID> lstParticipants Participant pids
List<byte> lstColumns Columns

Response

Type Name Description
Bool %retval% Result
List<GatheringStats> plstStats Stats

(33) DeleteGathering

Request

Type Name Description
Uint32 gid Gathering id

Response

Type Name Description
Bool %retval% Result

(34) GetPendingDeletions

Request

Type Name Description
Uint32 uiReason Reason
ResultRange resultRange Result range

Response

Type Name Description
Bool %retval% Result
List<DeletionEntry> lstDeletions Deletions

(35) DeleteFromDeletions

Request

Type Name Description
List<Uint32> lstDeletions Deletions

Response

Type Name Description
Bool %retval% Result

(36) MigrateGatheringOwnershipV1

Request

Type Name Description
Uint32 gid Gathering id
List<PID> lstPotentialNewOwnersID Potential new owner pids

Response

Type Name Description
Bool %retval% Result

(37) FindByDescriptionLike

Request

Type Name Description
String strDescriptionLike Description like
ResultRange resultRange Result range

Response

Type Name Description
List<Data<Gathering>> lstGathering Gatherings

(38) RegisterLocalURL

Request

Type Name Description
Uint32 gid Gathering id
StationURL url Url

Response

This method does not return anything.

(39) RegisterLocalURLs

Request

Type Name Description
Uint32 gid Gathering id
List<StationURL> lstUrls Urls

Response

This method does not return anything.

(40) UpdateSessionHostV1

Request

Type Name Description
Uint32 gid Gathering id

Response

This method does not return anything.

(41) GetSessionURLs

Request

Type Name Description
Uint32 gid Gathering id

Response

Type Name Description
List<StationURL> lstURLs Session urls

(42) UpdateSessionHost

Request

Type Name Description
Uint32 gid Gathering id
Bool isMigrateOwner Migrate owner

Response

This method does not return anything.

(43) UpdateGatheringOwnership

Request

Type Name Description
Uint32 gid Gathering id
Bool participantsOnly Participants only

Response

Type Name Description
Bool %retval% Result

(44) MigrateGatheringOwnership

Request

Type Name Description
Uint32 gid Gathering id
List<PID> lstPotentialNewOwnersID Potential new owner pids
Bool participantsOnly Participants only

Response

This method does not return anything.

Clone this wiki locally