Skip to content

Matchmake Extension Protocol

Yannik Marchand edited this page Feb 16, 2022 · 27 revisions

NEX Protocols > Matchmake Extension (109)

The following games have additional methods in the matchmake extension protocol:

This remainder of this page describes the methods that are not specific to any game.

Method ID Method Name
1 CloseParticipation
2 OpenParticipation
3 AutoMatchmake_Postpone
4 BrowseMatchmakeSession
5 BrowseMatchmakeSessionWithHostUrls
6 CreateMatchmakeSession
7 JoinMatchmakeSession
8 ModifyCurrentGameAttribute
9 UpdateNotificationData
10 GetFriendNotificationData
11 UpdateApplicationBuffer
12 UpdateMatchmakeSessionAttribute
13 GetlstFriendNotificationData
14 UpdateMatchmakeSession
15 AutoMatchmakeWithSearchCriteria_Postpone
16 GetPlayingSession
17 CreateCommunity
18 UpdateCommunity
19 JoinCommunity
20 FindCommunityByGatheringId
21 FindOfficialCommunity
22 FindCommunityByParticipant
23 UpdatePrivacySetting
24 GetMyBlockList
25 AddToBlockList
26 RemoveFromBlockList
27 ClearMyBlockList
28 ReportViolation
29 IsViolationUser
30 JoinMatchmakeSessionEx
31 GetSimplePlayingSession
32 GetSimpleCommunity
33 AutoMatchmakeWithGatheringId_Postpone
34 UpdateProgressScore
35 DebugNotifyEvent
36 GenerateMatchmakeSessionSystemPassword
37 ClearMatchmakeSessionSystemPassword
38 CreateMatchmakeSessionWithParam
39 JoinMatchmakeSessionWithParam
40 AutoMatchmakeWithParam_Postpone
41 FindMatchmakeSessionByGatheringIdDetail
42 BrowseMatchmakeSessionNoHolder
43 BrowseMatchmakeSessionWithHostUrlsNoHolder
44 UpdateMatchmakeSessionPart
45 RequestMatchmaking
46 WithdrawMatchmaking
47 WithdrawMatchmakingAll
48 FindMatchmakeSessionByGatheringId
49 FindMatchmakeSessionBySingleGatheringId
50 FindMatchmakeSessionByOwner
51 FindMatchmakeSessionByParticipant
52 BrowseMatchmakeSessionNoHolderNoResultRange
53 BrowseMatchmakeSessionWithHostUrlsNoHolderNoResultRange
54 FindCommunityByOwner

(1) CloseParticipation

Request

Type Name
Uint32 gid

Response

This method does not return anything.

(2) OpenParticipation

Request

Type Name
Uint32 gid

Response

This method does not return anything.

(3) AutoMatchmake_Postpone

Request

Type Name
Data<Gathering> anyGathering
String strMessage

Response

Type Name
Data<Gathering> joinedGathering

(4) BrowseMatchmakeSession

Request

Type Name
MatchmakeSessionSearchCriteria searchCriteria
ResultRange resultRange

Response

Type Name
List<Data<Gathering>> lstGathering

(5) BrowseMatchmakeSessionWithHostUrls

Request

Type Name
MatchmakeSessionSearchCriteria searchCriteria
ResultRange resultRange

Response

Type Name
List<Data<Gathering>> lstGathering
List<GatheringURLs> lstGatheringUrls

(6) CreateMatchmakeSession

Request

Type Name Only present in
Data<Gathering> anyGathering
String strMessage
Uint16 participationCount NEX v3.5.0 and later

Response

Type Name
Uint32 gid
Buffer sessionKey

(7) JoinMatchmakeSession

Request

Type Name
Uint32 gid
String strMessage

Response

Type Name
Buffer sessionKey

(8) ModifyCurrentGameAttribute

Request

Type Name
Uint32 gid
Uint32 attribIndex
Uint32 newValue

Response

This method does not return anything.

(9) UpdateNotificationData

Request

Wii U:

Type Name
Uint32 uiType
Uint32 uiParam1
Uint32 uiParam2
String strParam

Switch:

Type Name
Uint32 uiType
Uint64 uiParam1
Uint64 uiParam2
String strParam

Response

This method does not return anything.

(10) GetFriendNotificationData

Request

Type Name
Sint32 uiType

Response

Type Name
List<NotificationEvent> dataList

(11) UpdateApplicationBuffer

Request

Type Name
Uint32 gid
Buffer applicationBuffer

Response

This method does not return anything.

(12) UpdateMatchmakeSessionAttribute

Request

Type Name
Uint32 gid
List<Uint32> attribs

Response

This method does not return anything.

(13) GetlstFriendNotificationData

Request

Type Name
List<Uint32> lstTypes

Response

Type Name
List<NotificationEvent> dataList

(14) UpdateMatchmakeSession

Request

Type Name
Data<Gathering> anyGathering

Response

This method does not return anything.

(15) AutoMatchmakeWithSearchCriteria_Postpone

Request

Type Name
List<MatchmakeSessionSearchCriteria> lstSearchCriteria
Data<Gathering> anyGathering
String strMessage

Response

Type Name
Data<Gathering> joinedGathering

(16) GetPlayingSession

Request

Type Name
List<PID> lstPid

Response

Type Name
List<PlayingSession> lstPlayingSession

(17) CreateCommunity

Request

Type Name
PersistentGathering community
String strMessage

Response

Type Name
Uint32 gid

(18) UpdateCommunity

Request

Type Name
PersistentGathering community

Response

This method does not return anything.

(19) JoinCommunity

Request

Type Name
Uint32 gid
String strMessage
String strPassword

Response

This method does not return anything.

(20) FindCommunityByGatheringId

Request

Type Name
List<Uint32> lstGid

Response

Type Name
List<PersistentGathering> lstCommunity

(21) FindOfficialCommunity

Request

Type Name
Bool isAvailableOnly
ResultRange resultRange

Response

Type Name
List<PersistentGathering> lstCommunity

(22) FindCommunityByParticipant

Request

Type Name
PID pid
ResultRange resultRange

Response

Type Name
List<PersistentGathering> lstCommunity

(23) UpdatePrivacySetting

Request

Type Name
Bool onlineStatus
Bool participationCommunity

Response

This method does not return anything.

(24) GetMyBlockList

Request

This method does not take any parameters.

Response

Type Name
List<PID> lstPrincipalId

(25) AddToBlockList

Request

Type Name
List<PID> lstPrincipalId

Response

This method does not return anything.

(26) RemoveFromBlockList

Request

Type Name
List<PID> lstPrincipalId

Response

This method does not return anything.

(27) ClearMyBlockList

Request

This method does not take any parameters.

Response

This method does not return anything.

(28) ReportViolation

Request

Type Name
PID pid
String userName
Uint32 violationCode

Response

This method does not return anything.

(29) IsViolationUser

Request

This method does not take any parameters.

Response

Type Name
Bool flag
Uint32 score

(30) JoinMatchmakeSessionEx

Request

Type Name
Uint32 gid
String strMessage
Bool dontCareMyBlockList
Uint16 participationCount

Response

Type Name
Buffer sessionKey

(31) GetSimplePlayingSession

Request

Type Name
List<PID> lstPrincipalId
Bool includeLoginUser

Response

Type Name
List<SimplePlayingSession> lstSimplePlayingSession

(32) GetSimpleCommunity

Request

Type Name
List<Uint32> gatheringIdList

Response

Type Name
List<SimpleCommunity> lstSimpleCommunityList

(33) AutoMatchmakeWithGatheringId_Postpone

Request

Type Name
List<Uint32> lstGid
Data<Gathering> anyGathering
String strMessage

Response

Type Name
Data<Gathering> joinedGathering

(34) UpdateProgressScore

Request

Type Name
Uint32 gid
Uint8 progressScore

Response

This method does not return anything.

(35) DebugNotifyEvent

Request

Type Name
PID pid
Uint32 mainType
Uint32 subType
Uint64 param1
Uint64 param2
String stringParam

Response

This method does not return anything.

(36) GenerateMatchmakeSessionSystemPassword

Request

Type Name
Uint32 gid

Response

Type Name
String password

(37) ClearMatchmakeSessionSystemPassword

Request

Type Name
Uint32 gid

Response

This method does not return anything.

(38) CreateMatchmakeSessionWithParam

Request

Type Name
CreateMatchmakeSessionParam createMatchmakeSessionParam

Response

Type Name
MatchmakeSession joinedMatchmakeSession

(39) JoinMatchmakeSessionWithParam

Request

Type Name
JoinMatchmakeSessionParam joinMatchmakeSessionParam

Response

Type Name
MatchmakeSession joinedMatchmakeSession

(40) AutoMatchmakeWithParam_Postpone

Request

Type Name
AutoMatchmakeParam autoMatchmakeParam

Response

Type Name
MatchmakeSession joinedMatchmakeSession

(41) FindMatchmakeSessionByGatheringIdDetail

Request

Type Name
Uint32 gid

Response

Type Name
MatchmakeSession matchmakeSession

(42) BrowseMatchmakeSessionNoHolder

Request

Type Name
MatchmakeSessionSearchCriteria searchCriteria
ResultRange resultRange

Response

Type Name
List<MatchmakeSession> lstMatchmakeSession

(43) BrowseMatchmakeSessionWithHostUrlsNoHolder

Request

Type Name
MatchmakeSessionSearchCriteria searchCriteria
ResultRange resultRange

Response

Type Name
List<MatchmakeSession> lstMatchmakeSession
List<GatheringURLs> lstGatheringUrls

(44) UpdateMatchmakeSessionPart

Request

Type Name
UpdateMatchmakeSessionParam updateMatchmakeSessionParam

Response

This method does not return anything.

(45) RequestMatchmaking

Request

Type Name
AutoMatchmakeParam autoMatchmakeParam

Response

Type Name
Uint64 requestId

(46) WithdrawMatchmaking

Request

Type Name
Uint64 requestId

Response

This method does not return anything.

(47) WithdrawMatchmakingAll

Request

This method does not take any parameters.

Response

This method does not return anything.

(48) FindMatchmakeSessionByGatheringId

Request

Type Name
List<Uint32> lstGid

Response

Type Name
List<MatchmakeSession> lstMatchmakeSession

(49) FindMatchmakeSessionBySingleGatheringId

Request

Type Name
Uint32 gid

Response

Type Name
MatchmakeSession matchmakeSession

(50) FindMatchmakeSessionByOwner

Request

Type Name
PID id
ResultRange resultRange

Response

Type Name
List<MatchmakeSession> lstMatchmakeSession

(51) FindMatchmakeSessionByParticipant

Request

Type Name
FindMatchmakeSessionByParticipantParam param

Response

Type Name
List<FindMatchmakeSessionByParticipantResult> lstSession

(52) BrowseMatchmakeSessionNoHolderNoResultRange

Request

Type Name
MatchmakeSessionSearchCriteria searchCriteria

Response

Type Name
List<MatchmakeSession> lstMatchmakeSession

(53) BrowseMatchmakeSessionWithHostUrlsNoHolderNoResultRange

Request

Type Name
MatchmakeSessionSearchCriteria searchCriteria

Response

Type Name
List<MatchmakeSession> lstMatchmakeSession
List<GatheringURLs> lstGatheringUrls
Clone this wiki locally