Module: `nintendo.nex.matchmaking_eagle`

Provides a client and server for the MatchMakingProtocol, MatchMakingProtocolExt, MatchmakeExtensionProtocol and MatchmakeRefereeProtocol. This page was generated automatically from matchmaking_eagle.proto.

class MatchMakingClient
The client for the MatchMakingProtocol.

class MatchMakingClientExt
The client for the MatchMakingProtocolExt.

class MatchmakeExtensionClient
The client for the MatchmakeExtensionProtocol.

class MatchmakeRefereeClient
The client for the MatchmakeRefereeProtocol.

class MatchMakingServer
The server for the MatchMakingProtocol.

class MatchMakingServerExt
The server for the MatchMakingProtocolExt.

class MatchmakeExtensionServer
The server for the MatchmakeExtensionProtocol.

class MatchmakeRefereeServer
The server for the MatchmakeRefereeProtocol.

class MatchmakeSystem

MatchMakingClient

def __init__(client: RMCClient / HppClient)
Creates a new MatchMakingClient.

async def register_gathering(gathering: Gathering) -> int
Calls method 1 on the server.

async def unregister_gathering(gid: int) -> bool
Calls method 2 on the server.

async def unregister_gatherings(gids: list[int]) -> bool
Calls method 3 on the server.

async def update_gathering(gathering: Gathering) -> bool
Calls method 4 on the server.

async def invite(gid: int, pids: list[int], message: str) -> bool
Calls method 5 on the server.

async def accept_invitation(gid: int, message: str) -> bool
Calls method 6 on the server.

async def decline_invitation(gid: int, message: str) -> bool
Calls method 7 on the server.

async def cancel_invitation(gid: int, pids: list[int], message: str) -> bool
Calls method 8 on the server.

async def get_invitations_sent(gid: int) -> list[Invitation]
Calls method 9 on the server.

async def get_invitations_received() -> list[Invitation]
Calls method 10 on the server.

async def participate(gid: int, message: str) -> bool
Calls method 11 on the server.

async def cancel_participation(gid: int, message: str) -> bool
Calls method 12 on the server.

async def get_participants(gid: int) -> list[int]
Calls method 13 on the server.

async def add_participants(gid: int, pids: list[int], message: str) -> bool
Calls method 14 on the server.

async def get_detailed_participants(gid: int) -> list[ParticipantDetails]
Calls method 15 on the server.

async def get_participants_urls(gid: int) -> list[StationURL]
Calls method 16 on the server.

async def find_by_type(type: str, range: ResultRange) -> list[Gathering]
Calls method 17 on the server.

async def find_by_description(description: str, range: ResultRange) -> list[Gathering]
Calls method 18 on the server.

async def find_by_description_regex(regex: str, range: ResultRange) -> list[Gathering]
Calls method 19 on the server.

async def find_by_id(ids: list[int]) -> list[Gathering]
Calls method 20 on the server.

async def find_by_single_id(gid: int) -> RMCResponse
Calls method 21 on the server. The RMC response has the following attributes:
result: bool
gathering: Gathering

async def find_by_owner(owner: int, range: ResultRange) -> list[Gathering]
Calls method 22 on the server.

async def find_by_participants(pids: list[int]) -> list[Gathering]
Calls method 23 on the server.

async def find_invitations(range: ResultRange) -> list[Gathering]
Calls method 24 on the server.

async def find_by_sql_query(query: str, range: ResultRange) -> list[Gathering]
Calls method 25 on the server.

async def launch_session(gid: int, url: str) -> bool
Calls method 26 on the server.

async def update_session_url(gid: int, url: str) -> bool
Calls method 27 on the server.

async def get_session_url(gid: int) -> RMCResponse
Calls method 28 on the server. The RMC response has the following attributes:
result: bool
url: str

async def get_state(gid: int) -> RMCResponse
Calls method 29 on the server. The RMC response has the following attributes:
result: bool
state: int

async def set_state(gid: int, state: int) -> bool
Calls method 30 on the server.

async def report_stats(gid: int, stats: list[GatheringStats]) -> bool
Calls method 31 on the server.

async def get_stats(gid: int, pids: list[int], columns: list[int]) -> RMCResponse
Calls method 32 on the server. The RMC response has the following attributes:
result: bool
stats: list[GatheringStats]

async def delete_gathering(gid: int) -> bool
Calls method 33 on the server.

async def get_pending_deletions(reason: int, range: ResultRange) -> RMCResponse
Calls method 34 on the server. The RMC response has the following attributes:
result: bool
deletions: list[DeletionEntry]

async def delete_from_deletions(deletions: list[int]) -> bool
Calls method 35 on the server.

async def migrate_gathering_ownership_v1(gid: int, potential_owners: list[int]) -> bool
Calls method 36 on the server.

async def find_by_description_like(description: str, range: ResultRange) -> list[Gathering]
Calls method 37 on the server.

async def register_local_url(gid: int, url: StationURL) -> None
Calls method 38 on the server.

async def register_local_urls(gid: int, urls: list[StationURL]) -> None
Calls method 39 on the server.

async def update_session_host_v1(gid: int) -> None
Calls method 40 on the server.

async def get_session_urls(gid: int) -> list[StationURL]
Calls method 41 on the server.

async def update_session_host(gid: int, is_migrate_owner: bool) -> None
Calls method 42 on the server.

async def update_gathering_ownership(gid: int, participants_only: bool) -> bool
Calls method 43 on the server.

async def migrate_gathering_ownership(gid: int, potential_owners: list[int], participants_only: bool) -> None
Calls method 44 on the server.

MatchMakingClientExt

def __init__(client: RMCClient / HppClient)
Creates a new MatchMakingClientExt.

async def end_participation(gid: int, message: str) -> bool
Calls method 1 on the server.

async def get_participants(gid: int, only_active: bool) -> list[int]
Calls method 2 on the server.

async def get_detailed_participants(gid: int, only_active: bool) -> list[ParticipantDetails]
Calls method 3 on the server.

async def get_participants_urls(gids: list[int]) -> list[GatheringURLs]
Calls method 4 on the server.

async def get_gathering_relations(id: int, descr: str) -> str
Calls method 5 on the server.

async def delete_from_deletions(deletions: list[int], pid: int) -> None
Calls method 6 on the server.

MatchmakeExtensionClient

def __init__(client: RMCClient / HppClient)
Creates a new MatchmakeExtensionClient.

async def close_participation(gid: int) -> None
Calls method 1 on the server.

async def open_participation(gid: int) -> None
Calls method 2 on the server.

async def auto_matchmake_postpone(gathering: Gathering, message: str) -> Gathering
Calls method 3 on the server.

async def browse_matchmake_session(search_criteria: MatchmakeSessionSearchCriteria, range: ResultRange) -> list[Gathering]
Calls method 4 on the server.

async def browse_matchmake_session_with_host_urls(search_criteria: MatchmakeSessionSearchCriteria, range: ResultRange) -> RMCResponse
Calls method 5 on the server. The RMC response has the following attributes:
gatherings: list[Gathering]
urls: list[GatheringURLs]

async def create_matchmake_session(gathering: Gathering, description: str, num_participants: int) -> RMCResponse
Calls method 6 on the server. The RMC response has the following attributes:
gid: int
session_key: bytes

async def join_matchmake_session(gid: int, message: str) -> bytes
Calls method 7 on the server.

async def modify_current_game_attribute(gid: int, attrib: int, value: int) -> None
Calls method 8 on the server.

async def update_notification_data(type: int, param1: int, param2: int, param3: str) -> None
Calls method 9 on the server.

async def get_friend_notification_data(type: int) -> list[NotificationEvent]
Calls method 10 on the server.

async def update_application_buffer(gid: int, buffer: bytes) -> None
Calls method 11 on the server.

async def update_matchmake_session_attribute(gid: int, attribs: list[int]) -> None
Calls method 12 on the server.

async def get_friend_notification_data_list(types: list[int]) -> list[NotificationEvent]
Calls method 13 on the server.

async def update_matchmake_session(gathering: Gathering) -> None
Calls method 14 on the server.

async def auto_matchmake_with_search_criteria_postpone(search_criteria: list[MatchmakeSessionSearchCriteria], gathering: Gathering, message: str) -> Gathering
Calls method 15 on the server.

async def get_playing_session(pids: list[int]) -> list[PlayingSession]
Calls method 16 on the server.

async def create_community(community: PersistentGathering, message: str) -> int
Calls method 17 on the server.

async def update_community(community: PersistentGathering) -> None
Calls method 18 on the server.

async def join_community(gid: int, message: str, password: str) -> None
Calls method 19 on the server.

async def find_community_by_gathering_id(gids: list[int]) -> list[PersistentGathering]
Calls method 20 on the server.

async def find_official_community(available_only: bool, range: ResultRange) -> list[PersistentGathering]
Calls method 21 on the server.

async def find_community_by_participant(pid: int, range: ResultRange) -> list[PersistentGathering]
Calls method 22 on the server.

async def update_privacy_setting(online_status: bool, community_participation: bool) -> None
Calls method 23 on the server.

async def get_my_block_list() -> list[int]
Calls method 24 on the server.

async def add_to_block_list(pids: list[int]) -> None
Calls method 25 on the server.

async def remove_from_block_list(pids: list[int]) -> None
Calls method 26 on the server.

async def clear_my_block_list() -> None
Calls method 27 on the server.

async def report_violation(pid: int, username: str, violation_code: int) -> None
Calls method 28 on the server.

async def is_violation_user() -> RMCResponse
Calls method 29 on the server. The RMC response has the following attributes:
flag: bool
score: int

async def join_matchmake_session_ex(gid: int, gmessage: str, ignore_block_list: bool, num_participants: int) -> bytes
Calls method 30 on the server.

async def get_simple_playing_session(pids: list[int], include_login_user: bool) -> list[SimplePlayingSession]
Calls method 31 on the server.

async def get_simple_community(gids: list[int]) -> list[SimpleCommunity]
Calls method 32 on the server.

async def auto_matchmake_with_gathering_id_postpone(gids: list[int], gathering: Gathering, message: str) -> Gathering
Calls method 33 on the server.

async def update_progress_score(gid: int, score: int) -> None
Calls method 34 on the server.

async def debug_notify_event(pid: int, main_type: int, sub_type: int, param1: int, param2: int, param3: str) -> None
Calls method 35 on the server.

async def generate_matchmake_session_system_password(gid: int) -> str
Calls method 36 on the server.

async def clear_matchmake_session_system_password(gid: int) -> None
Calls method 37 on the server.

async def create_matchmake_session_with_param(param: CreateMatchmakeSessionParam) -> MatchmakeSession
Calls method 38 on the server.

async def join_matchmake_session_with_param(param: JoinMatchmakeSessionParam) -> MatchmakeSession
Calls method 39 on the server.

async def auto_matchmake_with_param_postpone(param: AutoMatchmakeParam) -> MatchmakeSession
Calls method 40 on the server.

async def find_matchmake_session_by_gathering_id_detail(gid: int) -> MatchmakeSession
Calls method 41 on the server.

async def browse_matchmake_session_no_holder(search_criteria: MatchmakeSessionSearchCriteria, range: ResultRange) -> list[MatchmakeSession]
Calls method 42 on the server.

async def browse_matchmake_session_with_host_urls_no_holder(search_criteria: MatchmakeSessionSearchCriteria, range: ResultRange) -> RMCResponse
Calls method 43 on the server. The RMC response has the following attributes:
sessions: list[MatchmakeSession]
urls: list[GatheringURLs]

async def update_matchmake_session_part(param: UpdateMatchmakeSessionParam) -> None
Calls method 44 on the server.

async def request_matchmaking(param: AutoMatchmakeParam) -> int
Calls method 45 on the server.

async def withdraw_matchmaking(request_id: int) -> None
Calls method 46 on the server.

async def withdraw_matchmaking_all() -> None
Calls method 47 on the server.

async def find_matchmake_session_by_gathering_id(gids: list[int]) -> list[MatchmakeSession]
Calls method 48 on the server.

async def find_matchmake_session_by_single_gathering_id(gid: int) -> MatchmakeSession
Calls method 49 on the server.

async def find_matchmake_session_by_owner(pid: int, range: ResultRange) -> list[MatchmakeSession]
Calls method 50 on the server.

async def find_matchmake_session_by_participant(param: FindMatchmakeSessionByParticipantParam) -> list[FindMatchmakeSessionByParticipantResult]
Calls method 51 on the server.

async def browse_matchmake_session_no_holder_no_result_range(search_criteria: MatchmakeSessionSearchCriteria) -> list[MatchmakeSession]
Calls method 52 on the server.

async def browse_matchmake_session_with_host_urls_no_holder_no_result_range(search_criteria: MatchmakeSessionSearchCriteria) -> RMCResponse
Calls method 53 on the server. The RMC response has the following attributes:
sessions: list[MatchmakeSession]
urls: list[GatheringURLs]

MatchmakeRefereeClient

def __init__(client: RMCClient / HppClient)
Creates a new MatchmakeRefereeClient.

async def start_round(param: MatchmakeRefereeStartRoundParam) -> int
Calls method 1 on the server.

async def get_start_round_param(round_id: int) -> MatchmakeRefereeStartRoundParam
Calls method 2 on the server.

async def end_round(param: MatchmakeRefereeEndRoundParam) -> None
Calls method 3 on the server.

async def end_round_with_partial_report(param: MatchmakeRefereeEndRoundParam) -> None
Calls method 4 on the server.

async def end_round_without_report(round_id: int) -> None
Calls method 5 on the server.

async def get_round_participants(round_id: int) -> list[int]
Calls method 6 on the server.

async def get_not_summarized_round() -> list[MatchmakeRefereeRound]
Calls method 7 on the server.

async def get_round(round: int) -> MatchmakeRefereeRound
Calls method 8 on the server.

async def get_stats_primary(target: MatchmakeRefereeStatsTarget) -> MatchmakeRefereeStats
Calls method 9 on the server.

async def get_stats_primaries(targets: list[MatchmakeRefereeStatsTarget]) -> RMCResponse
Calls method 10 on the server. The RMC response has the following attributes:
stats: list[MatchmakeRefereeStats]
results: list[Result]

async def get_stats_all(target: MatchmakeRefereeStatsTarget) -> list[MatchmakeRefereeStats]
Calls method 11 on the server.

async def create_stats(param: MatchmakeRefereeStatsInitParam) -> MatchmakeRefereeStats
Calls method 12 on the server.

async def get_or_create_stats(param: MatchmakeRefereeStatsInitParam) -> MatchmakeRefereeStats
Calls method 13 on the server.

async def reset_stats() -> None
Calls method 14 on the server.

MatchMakingServer

def __init__()
Creates a new MatchMakingServer.

async def logout(client: RMCClient) -> None
Called whenever a client is disconnected. May be overridden by a subclass.

async def register_gathering(client: RMCClient, gathering: Gathering) -> int
Handler for method 1. This method should be overridden by a subclass.

async def unregister_gathering(client: RMCClient, gid: int) -> bool
Handler for method 2. This method should be overridden by a subclass.

async def unregister_gatherings(client: RMCClient, gids: list[int]) -> bool
Handler for method 3. This method should be overridden by a subclass.

async def update_gathering(client: RMCClient, gathering: Gathering) -> bool
Handler for method 4. This method should be overridden by a subclass.

async def invite(client: RMCClient, gid: int, pids: list[int], message: str) -> bool
Handler for method 5. This method should be overridden by a subclass.

async def accept_invitation(client: RMCClient, gid: int, message: str) -> bool
Handler for method 6. This method should be overridden by a subclass.

async def decline_invitation(client: RMCClient, gid: int, message: str) -> bool
Handler for method 7. This method should be overridden by a subclass.

async def cancel_invitation(client: RMCClient, gid: int, pids: list[int], message: str) -> bool
Handler for method 8. This method should be overridden by a subclass.

async def get_invitations_sent(client: RMCClient, gid: int) -> list[Invitation]
Handler for method 9. This method should be overridden by a subclass.

async def get_invitations_received(client: RMCClient) -> list[Invitation]
Handler for method 10. This method should be overridden by a subclass.

async def participate(client: RMCClient, gid: int, message: str) -> bool
Handler for method 11. This method should be overridden by a subclass.

async def cancel_participation(client: RMCClient, gid: int, message: str) -> bool
Handler for method 12. This method should be overridden by a subclass.

async def get_participants(client: RMCClient, gid: int) -> list[int]
Handler for method 13. This method should be overridden by a subclass.

async def add_participants(client: RMCClient, gid: int, pids: list[int], message: str) -> bool
Handler for method 14. This method should be overridden by a subclass.

async def get_detailed_participants(client: RMCClient, gid: int) -> list[ParticipantDetails]
Handler for method 15. This method should be overridden by a subclass.

async def get_participants_urls(client: RMCClient, gid: int) -> list[StationURL]
Handler for method 16. This method should be overridden by a subclass.

async def find_by_type(client: RMCClient, type: str, range: ResultRange) -> list[Gathering]
Handler for method 17. This method should be overridden by a subclass.

async def find_by_description(client: RMCClient, description: str, range: ResultRange) -> list[Gathering]
Handler for method 18. This method should be overridden by a subclass.

async def find_by_description_regex(client: RMCClient, regex: str, range: ResultRange) -> list[Gathering]
Handler for method 19. This method should be overridden by a subclass.

async def find_by_id(client: RMCClient, ids: list[int]) -> list[Gathering]
Handler for method 20. This method should be overridden by a subclass.

async def find_by_single_id(client: RMCClient, gid: int) -> RMCResponse
Handler for method 21. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: bool
gathering: Gathering

async def find_by_owner(client: RMCClient, owner: int, range: ResultRange) -> list[Gathering]
Handler for method 22. This method should be overridden by a subclass.

async def find_by_participants(client: RMCClient, pids: list[int]) -> list[Gathering]
Handler for method 23. This method should be overridden by a subclass.

async def find_invitations(client: RMCClient, range: ResultRange) -> list[Gathering]
Handler for method 24. This method should be overridden by a subclass.

async def find_by_sql_query(client: RMCClient, query: str, range: ResultRange) -> list[Gathering]
Handler for method 25. This method should be overridden by a subclass.

async def launch_session(client: RMCClient, gid: int, url: str) -> bool
Handler for method 26. This method should be overridden by a subclass.

async def update_session_url(client: RMCClient, gid: int, url: str) -> bool
Handler for method 27. This method should be overridden by a subclass.

async def get_session_url(client: RMCClient, gid: int) -> RMCResponse
Handler for method 28. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: bool
url: str

async def get_state(client: RMCClient, gid: int) -> RMCResponse
Handler for method 29. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: bool
state: int

async def set_state(client: RMCClient, gid: int, state: int) -> bool
Handler for method 30. This method should be overridden by a subclass.

async def report_stats(client: RMCClient, gid: int, stats: list[GatheringStats]) -> bool
Handler for method 31. This method should be overridden by a subclass.

async def get_stats(client: RMCClient, gid: int, pids: list[int], columns: list[int]) -> RMCResponse
Handler for method 32. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: bool
stats: list[GatheringStats]

async def delete_gathering(client: RMCClient, gid: int) -> bool
Handler for method 33. This method should be overridden by a subclass.

async def get_pending_deletions(client: RMCClient, reason: int, range: ResultRange) -> RMCResponse
Handler for method 34. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: bool
deletions: list[DeletionEntry]

async def delete_from_deletions(client: RMCClient, deletions: list[int]) -> bool
Handler for method 35. This method should be overridden by a subclass.

async def migrate_gathering_ownership_v1(client: RMCClient, gid: int, potential_owners: list[int]) -> bool
Handler for method 36. This method should be overridden by a subclass.

async def find_by_description_like(client: RMCClient, description: str, range: ResultRange) -> list[Gathering]
Handler for method 37. This method should be overridden by a subclass.

async def register_local_url(client: RMCClient, gid: int, url: StationURL) -> None
Handler for method 38. This method should be overridden by a subclass.

async def register_local_urls(client: RMCClient, gid: int, urls: list[StationURL]) -> None
Handler for method 39. This method should be overridden by a subclass.

async def update_session_host_v1(client: RMCClient, gid: int) -> None
Handler for method 40. This method should be overridden by a subclass.

async def get_session_urls(client: RMCClient, gid: int) -> list[StationURL]
Handler for method 41. This method should be overridden by a subclass.

async def update_session_host(client: RMCClient, gid: int, is_migrate_owner: bool) -> None
Handler for method 42. This method should be overridden by a subclass.

async def update_gathering_ownership(client: RMCClient, gid: int, participants_only: bool) -> bool
Handler for method 43. This method should be overridden by a subclass.

async def migrate_gathering_ownership(client: RMCClient, gid: int, potential_owners: list[int], participants_only: bool) -> None
Handler for method 44. This method should be overridden by a subclass.

MatchMakingServerExt

def __init__()
Creates a new MatchMakingServerExt.

async def logout(client: RMCClient) -> None
Called whenever a client is disconnected. May be overridden by a subclass.

async def end_participation(client: RMCClient, gid: int, message: str) -> bool
Handler for method 1. This method should be overridden by a subclass.

async def get_participants(client: RMCClient, gid: int, only_active: bool) -> list[int]
Handler for method 2. This method should be overridden by a subclass.

async def get_detailed_participants(client: RMCClient, gid: int, only_active: bool) -> list[ParticipantDetails]
Handler for method 3. This method should be overridden by a subclass.

async def get_participants_urls(client: RMCClient, gids: list[int]) -> list[GatheringURLs]
Handler for method 4. This method should be overridden by a subclass.

async def get_gathering_relations(client: RMCClient, id: int, descr: str) -> str
Handler for method 5. This method should be overridden by a subclass.

async def delete_from_deletions(client: RMCClient, deletions: list[int], pid: int) -> None
Handler for method 6. This method should be overridden by a subclass.

MatchmakeExtensionServer

def __init__()
Creates a new MatchmakeExtensionServer.

async def logout(client: RMCClient) -> None
Called whenever a client is disconnected. May be overridden by a subclass.

async def close_participation(client: RMCClient, gid: int) -> None
Handler for method 1. This method should be overridden by a subclass.

async def open_participation(client: RMCClient, gid: int) -> None
Handler for method 2. This method should be overridden by a subclass.

async def auto_matchmake_postpone(client: RMCClient, gathering: Gathering, message: str) -> Gathering
Handler for method 3. This method should be overridden by a subclass.

async def browse_matchmake_session(client: RMCClient, search_criteria: MatchmakeSessionSearchCriteria, range: ResultRange) -> list[Gathering]
Handler for method 4. This method should be overridden by a subclass.

async def browse_matchmake_session_with_host_urls(client: RMCClient, search_criteria: MatchmakeSessionSearchCriteria, range: ResultRange) -> RMCResponse
Handler for method 5. This method should be overridden by a subclass. The RMC response must have the following attributes:
gatherings: list[Gathering]
urls: list[GatheringURLs]

async def create_matchmake_session(client: RMCClient, gathering: Gathering, description: str, num_participants: int) -> RMCResponse
Handler for method 6. This method should be overridden by a subclass. The RMC response must have the following attributes:
gid: int
session_key: bytes

async def join_matchmake_session(client: RMCClient, gid: int, message: str) -> bytes
Handler for method 7. This method should be overridden by a subclass.

async def modify_current_game_attribute(client: RMCClient, gid: int, attrib: int, value: int) -> None
Handler for method 8. This method should be overridden by a subclass.

async def update_notification_data(client: RMCClient, type: int, param1: int, param2: int, param3: str) -> None
Handler for method 9. This method should be overridden by a subclass.

async def get_friend_notification_data(client: RMCClient, type: int) -> list[NotificationEvent]
Handler for method 10. This method should be overridden by a subclass.

async def update_application_buffer(client: RMCClient, gid: int, buffer: bytes) -> None
Handler for method 11. This method should be overridden by a subclass.

async def update_matchmake_session_attribute(client: RMCClient, gid: int, attribs: list[int]) -> None
Handler for method 12. This method should be overridden by a subclass.

async def get_friend_notification_data_list(client: RMCClient, types: list[int]) -> list[NotificationEvent]
Handler for method 13. This method should be overridden by a subclass.

async def update_matchmake_session(client: RMCClient, gathering: Gathering) -> None
Handler for method 14. This method should be overridden by a subclass.

async def auto_matchmake_with_search_criteria_postpone(client: RMCClient, search_criteria: list[MatchmakeSessionSearchCriteria], gathering: Gathering, message: str) -> Gathering
Handler for method 15. This method should be overridden by a subclass.

async def get_playing_session(client: RMCClient, pids: list[int]) -> list[PlayingSession]
Handler for method 16. This method should be overridden by a subclass.

async def create_community(client: RMCClient, community: PersistentGathering, message: str) -> int
Handler for method 17. This method should be overridden by a subclass.

async def update_community(client: RMCClient, community: PersistentGathering) -> None
Handler for method 18. This method should be overridden by a subclass.

async def join_community(client: RMCClient, gid: int, message: str, password: str) -> None
Handler for method 19. This method should be overridden by a subclass.

async def find_community_by_gathering_id(client: RMCClient, gids: list[int]) -> list[PersistentGathering]
Handler for method 20. This method should be overridden by a subclass.

async def find_official_community(client: RMCClient, available_only: bool, range: ResultRange) -> list[PersistentGathering]
Handler for method 21. This method should be overridden by a subclass.

async def find_community_by_participant(client: RMCClient, pid: int, range: ResultRange) -> list[PersistentGathering]
Handler for method 22. This method should be overridden by a subclass.

async def update_privacy_setting(client: RMCClient, online_status: bool, community_participation: bool) -> None
Handler for method 23. This method should be overridden by a subclass.

async def get_my_block_list(client: RMCClient) -> list[int]
Handler for method 24. This method should be overridden by a subclass.

async def add_to_block_list(client: RMCClient, pids: list[int]) -> None
Handler for method 25. This method should be overridden by a subclass.

async def remove_from_block_list(client: RMCClient, pids: list[int]) -> None
Handler for method 26. This method should be overridden by a subclass.

async def clear_my_block_list(client: RMCClient) -> None
Handler for method 27. This method should be overridden by a subclass.

async def report_violation(client: RMCClient, pid: int, username: str, violation_code: int) -> None
Handler for method 28. This method should be overridden by a subclass.

async def is_violation_user(client: RMCClient) -> RMCResponse
Handler for method 29. This method should be overridden by a subclass. The RMC response must have the following attributes:
flag: bool
score: int

async def join_matchmake_session_ex(client: RMCClient, gid: int, gmessage: str, ignore_block_list: bool, num_participants: int) -> bytes
Handler for method 30. This method should be overridden by a subclass.

async def get_simple_playing_session(client: RMCClient, pids: list[int], include_login_user: bool) -> list[SimplePlayingSession]
Handler for method 31. This method should be overridden by a subclass.

async def get_simple_community(client: RMCClient, gids: list[int]) -> list[SimpleCommunity]
Handler for method 32. This method should be overridden by a subclass.

async def auto_matchmake_with_gathering_id_postpone(client: RMCClient, gids: list[int], gathering: Gathering, message: str) -> Gathering
Handler for method 33. This method should be overridden by a subclass.

async def update_progress_score(client: RMCClient, gid: int, score: int) -> None
Handler for method 34. This method should be overridden by a subclass.

async def debug_notify_event(client: RMCClient, pid: int, main_type: int, sub_type: int, param1: int, param2: int, param3: str) -> None
Handler for method 35. This method should be overridden by a subclass.

async def generate_matchmake_session_system_password(client: RMCClient, gid: int) -> str
Handler for method 36. This method should be overridden by a subclass.

async def clear_matchmake_session_system_password(client: RMCClient, gid: int) -> None
Handler for method 37. This method should be overridden by a subclass.

async def create_matchmake_session_with_param(client: RMCClient, param: CreateMatchmakeSessionParam) -> MatchmakeSession
Handler for method 38. This method should be overridden by a subclass.

async def join_matchmake_session_with_param(client: RMCClient, param: JoinMatchmakeSessionParam) -> MatchmakeSession
Handler for method 39. This method should be overridden by a subclass.

async def auto_matchmake_with_param_postpone(client: RMCClient, param: AutoMatchmakeParam) -> MatchmakeSession
Handler for method 40. This method should be overridden by a subclass.

async def find_matchmake_session_by_gathering_id_detail(client: RMCClient, gid: int) -> MatchmakeSession
Handler for method 41. This method should be overridden by a subclass.

async def browse_matchmake_session_no_holder(client: RMCClient, search_criteria: MatchmakeSessionSearchCriteria, range: ResultRange) -> list[MatchmakeSession]
Handler for method 42. This method should be overridden by a subclass.

async def browse_matchmake_session_with_host_urls_no_holder(client: RMCClient, search_criteria: MatchmakeSessionSearchCriteria, range: ResultRange) -> RMCResponse
Handler for method 43. This method should be overridden by a subclass. The RMC response must have the following attributes:
sessions: list[MatchmakeSession]
urls: list[GatheringURLs]

async def update_matchmake_session_part(client: RMCClient, param: UpdateMatchmakeSessionParam) -> None
Handler for method 44. This method should be overridden by a subclass.

async def request_matchmaking(client: RMCClient, param: AutoMatchmakeParam) -> int
Handler for method 45. This method should be overridden by a subclass.

async def withdraw_matchmaking(client: RMCClient, request_id: int) -> None
Handler for method 46. This method should be overridden by a subclass.

async def withdraw_matchmaking_all(client: RMCClient) -> None
Handler for method 47. This method should be overridden by a subclass.

async def find_matchmake_session_by_gathering_id(client: RMCClient, gids: list[int]) -> list[MatchmakeSession]
Handler for method 48. This method should be overridden by a subclass.

async def find_matchmake_session_by_single_gathering_id(client: RMCClient, gid: int) -> MatchmakeSession
Handler for method 49. This method should be overridden by a subclass.

async def find_matchmake_session_by_owner(client: RMCClient, pid: int, range: ResultRange) -> list[MatchmakeSession]
Handler for method 50. This method should be overridden by a subclass.

async def find_matchmake_session_by_participant(client: RMCClient, param: FindMatchmakeSessionByParticipantParam) -> list[FindMatchmakeSessionByParticipantResult]
Handler for method 51. This method should be overridden by a subclass.

async def browse_matchmake_session_no_holder_no_result_range(client: RMCClient, search_criteria: MatchmakeSessionSearchCriteria) -> list[MatchmakeSession]
Handler for method 52. This method should be overridden by a subclass.

async def browse_matchmake_session_with_host_urls_no_holder_no_result_range(client: RMCClient, search_criteria: MatchmakeSessionSearchCriteria) -> RMCResponse
Handler for method 53. This method should be overridden by a subclass. The RMC response must have the following attributes:
sessions: list[MatchmakeSession]
urls: list[GatheringURLs]

MatchmakeRefereeServer

def __init__()
Creates a new MatchmakeRefereeServer.

async def logout(client: RMCClient) -> None
Called whenever a client is disconnected. May be overridden by a subclass.

async def start_round(client: RMCClient, param: MatchmakeRefereeStartRoundParam) -> int
Handler for method 1. This method should be overridden by a subclass.

async def get_start_round_param(client: RMCClient, round_id: int) -> MatchmakeRefereeStartRoundParam
Handler for method 2. This method should be overridden by a subclass.

async def end_round(client: RMCClient, param: MatchmakeRefereeEndRoundParam) -> None
Handler for method 3. This method should be overridden by a subclass.

async def end_round_with_partial_report(client: RMCClient, param: MatchmakeRefereeEndRoundParam) -> None
Handler for method 4. This method should be overridden by a subclass.

async def end_round_without_report(client: RMCClient, round_id: int) -> None
Handler for method 5. This method should be overridden by a subclass.

async def get_round_participants(client: RMCClient, round_id: int) -> list[int]
Handler for method 6. This method should be overridden by a subclass.

async def get_not_summarized_round(client: RMCClient) -> list[MatchmakeRefereeRound]
Handler for method 7. This method should be overridden by a subclass.

async def get_round(client: RMCClient, round: int) -> MatchmakeRefereeRound
Handler for method 8. This method should be overridden by a subclass.

async def get_stats_primary(client: RMCClient, target: MatchmakeRefereeStatsTarget) -> MatchmakeRefereeStats
Handler for method 9. This method should be overridden by a subclass.

async def get_stats_primaries(client: RMCClient, targets: list[MatchmakeRefereeStatsTarget]) -> RMCResponse
Handler for method 10. This method should be overridden by a subclass. The RMC response must have the following attributes:
stats: list[MatchmakeRefereeStats]
results: list[Result]

async def get_stats_all(client: RMCClient, target: MatchmakeRefereeStatsTarget) -> list[MatchmakeRefereeStats]
Handler for method 11. This method should be overridden by a subclass.

async def create_stats(client: RMCClient, param: MatchmakeRefereeStatsInitParam) -> MatchmakeRefereeStats
Handler for method 12. This method should be overridden by a subclass.

async def get_or_create_stats(client: RMCClient, param: MatchmakeRefereeStatsInitParam) -> MatchmakeRefereeStats
Handler for method 13. This method should be overridden by a subclass.

async def reset_stats(client: RMCClient) -> None
Handler for method 14. This method should be overridden by a subclass.

MatchmakeSystem

This class defines the following constants:
GLOBAL = 1
FRIENDS = 2

AutoMatchmakeParam

def __init__()
Creates a new AutoMatchmakeParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
session: MatchmakeSession = MatchmakeSession()
participants: list[int]
gid_for_participation_check: int
options: int
join_message: str
num_participants: int
search_criteria: list[MatchmakeSessionSearchCriteria]
target_gids: list[int]
block_list: MatchmakeBlockListParam = MatchmakeBlockListParam()

CreateMatchmakeSessionParam

def __init__()
Creates a new CreateMatchmakeSessionParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
session: MatchmakeSession = MatchmakeSession()
additional_participants: list[int]
gid_for_participation_check: int
options: int
join_message: str
num_participants: int

DeletionEntry

def __init__()
Creates a new DeletionEntry instance. Required fields must be filled in manually.

The following fields are defined in this class:
gid: int
pid: int
reason: int

FindMatchmakeSessionByParticipantParam

def __init__()
Creates a new FindMatchmakeSessionByParticipantParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
pids: list[int]
options: int
block_list: MatchmakeBlockListParam = MatchmakeBlockListParam()

FindMatchmakeSessionByParticipantResult

def __init__()
Creates a new FindMatchmakeSessionByParticipantResult instance. Required fields must be filled in manually.

The following fields are defined in this class:
pid: int
session: MatchmakeSession = MatchmakeSession()

Gathering

def __init__()
Creates a new Gathering instance. Required fields must be filled in manually.

The following fields are defined in this class:
id: int = 0
owner: int = 0
host: int = 0
min_participants: int = 0
max_participants: int = 0
participation_policy: int = 1
policy_argument: int = 0
flags: int = 512
state: int = 0
description: str = ""

GatheringStats

def __init__()
Creates a new GatheringStats instance. Required fields must be filled in manually.

The following fields are defined in this class:
pid: int
flags: int
values: list[float]

GatheringURLs

def __init__()
Creates a new GatheringURLs instance. Required fields must be filled in manually.

The following fields are defined in this class:
gid: int
urls: list[StationURL]

Invitation

def __init__()
Creates a new Invitation instance. Required fields must be filled in manually.

The following fields are defined in this class:
gid: int
guest: int
message: str

JoinMatchmakeSessionParam

def __init__()
Creates a new JoinMatchmakeSessionParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
gid: int
participants: list[int]
gid_for_participation_check: int
options: int
behavior: int
user_password: str
system_password: str
join_message: str
num_participants: int
extra_participants: int
block_list: MatchmakeBlockListParam = MatchmakeBlockListParam()

MatchmakeBlockListParam

def __init__()
Creates a new MatchmakeBlockListParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
options: int = 0

MatchmakeParam

def __init__()
Creates a new MatchmakeParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
param: dict[str, object] = {}

MatchmakeRefereeEndRoundParam

def __init__()
Creates a new MatchmakeRefereeEndRoundParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
round_id: int
results: list[MatchmakeRefereePersonalRoundResult]

MatchmakeRefereePersonalRoundResult

def __init__()
Creates a new MatchmakeRefereePersonalRoundResult instance. Required fields must be filled in manually.

The following fields are defined in this class:
pid: int
personal_round_result_flag: int
round_win_loss: int
rating_value_change: int
buffer: bytes
report_summary_mode: int
event_id: int

MatchmakeRefereeRound

def __init__()
Creates a new MatchmakeRefereeRound instance. Required fields must be filled in manually.

The following fields are defined in this class:
id: int
gid: int
state: int
personal_data_category: int
results: list[MatchmakeRefereePersonalRoundResult]

MatchmakeRefereeStartRoundParam

def __init__()
Creates a new MatchmakeRefereeStartRoundParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
personal_data_category: int
gid: int
pids: list[int]
report_summary_mode: int
event_id: int

MatchmakeRefereeStats

def __init__()
Creates a new MatchmakeRefereeStats instance. Required fields must be filled in manually.

The following fields are defined in this class:
unique_id: int
category: int
pid: int
recent_disconnection: int
recent_violation: int
recent_mismatch: int
recent_win: int
recent_loss: int
recent_draw: int
total_disconnect: int
total_violation: int
total_mismatch: int
total_win: int
total_loss: int
total_draw: int
rating_value: int

MatchmakeRefereeStatsInitParam

def __init__()
Creates a new MatchmakeRefereeStatsInitParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
category: int
initial_rating: int

MatchmakeRefereeStatsTarget

def __init__()
Creates a new MatchmakeRefereeStatsTarget instance. Required fields must be filled in manually.

The following fields are defined in this class:
pid: int
category: int

MatchmakeSession

def __init__()
Creates a new MatchmakeSession instance. Required fields must be filled in manually.

The following fields are defined in this class:
game_mode: int = 0
attribs: list[int] = [0, 0, 0, 0, 0, 0]
open_participation: bool = True
matchmake_system: int = 0
application_data: bytes = b""
num_participants: int = 0
If 30000 <= nex.version < 40000:
If nex.version >= 30500:
progress_score: int = 100

If nex.version >= 30000:
session_key: bytes = b""

If nex.version >= 30500:
option: int = 0

If nex.version >= 30600:
If revision >= 1:
param: MatchmakeParam = MatchmakeParam()
started_time: DateTime = DateTime.never()

If nex.version >= 30700:
If revision >= 2:
user_password: str = ""

If nex.version >= 30800:
If revision >= 3:
refer_gid: int = 0
user_password_enabled: bool = False
system_password_enabled: bool = False

If nex.version >= 40000:
progress_score: int = 100
session_key: bytes = b""
option: int = 0
param: MatchmakeParam = MatchmakeParam()
started_time: DateTime = DateTime.never()
user_password: str = ""
refer_gid: int = 0
user_password_enabled: bool = False
system_password_enabled: bool = False
codeword: str = ""

MatchmakeSessionSearchCriteria

def __init__()
Creates a new MatchmakeSessionSearchCriteria instance. Required fields must be filled in manually.

The following fields are defined in this class:
attribs: list[str] = ["", "", "", "", "", ""]
game_mode: str = ""
min_participants: str = ""
max_participants: str = ""
matchmake_system: str = ""
vacant_only: bool = True
exclude_locked: bool = True
exclude_non_host_pid: bool = False
selection_method: int = 0
If nex.version >= 30500:
vacant_participants: int = 1

If nex.version >= 40000:
param: MatchmakeParam = MatchmakeParam()
exclude_user_password: bool = False
exclude_system_password: bool = False
refer_gid: int = 0
codeword: str = ""
range: ResultRange = ResultRange()

ParticipantDetails

def __init__()
Creates a new ParticipantDetails instance. Required fields must be filled in manually.

The following fields are defined in this class:
pid: int
name: str
message: str
participants: int

PersistentGathering

def __init__()
Creates a new PersistentGathering instance. Required fields must be filled in manually.

The following fields are defined in this class:
type: int
password: str
attribs: list[int]
application_buffer: bytes
participation_start: DateTime
participation_end: DateTime
matchmake_session_count: int
num_participants: int

PlayingSession

def __init__()
Creates a new PlayingSession instance. Required fields must be filled in manually.

The following fields are defined in this class:
pid: int
gathering: Gathering

SimpleCommunity

def __init__()
Creates a new SimpleCommunity instance. Required fields must be filled in manually.

The following fields are defined in this class:
gid: int
matchmake_session_count: int

SimplePlayingSession

def __init__()
Creates a new SimplePlayingSession instance. Required fields must be filled in manually.

The following fields are defined in this class:
pid: int
gid: int
game_mode: int
attribute: int

UpdateMatchmakeSessionParam

def __init__()
Creates a new UpdateMatchmakeSessionParam instance. Required fields must be filled in manually.

The following fields are defined in this class:
gid: int
modification_flags: int
attributes: list[int]
open_participation: bool
application_buffer: bytes
progress_score: int
param: MatchmakeParam = MatchmakeParam()
started_time: DateTime
user_password: str
game_mode: int
description: str
min_participants: int
max_participants: int
matchmake_system: int
participation_policy: int
policy_argument: int
codeword: str

Module: nintendo.nex.matchmaking_eagle

MatchMakingClient

MatchMakingClientExt

MatchmakeExtensionClient

MatchmakeRefereeClient

MatchMakingServer

MatchMakingServerExt

MatchmakeExtensionServer

MatchmakeRefereeServer

MatchmakeSystem

AutoMatchmakeParam

CreateMatchmakeSessionParam

DeletionEntry

FindMatchmakeSessionByParticipantParam

FindMatchmakeSessionByParticipantResult

Gathering

GatheringStats

GatheringURLs

Invitation

JoinMatchmakeSessionParam

MatchmakeBlockListParam

MatchmakeParam

MatchmakeRefereeEndRoundParam

MatchmakeRefereePersonalRoundResult

MatchmakeRefereeRound

MatchmakeRefereeStartRoundParam

MatchmakeRefereeStats

MatchmakeRefereeStatsInitParam

MatchmakeRefereeStatsTarget

MatchmakeSession

MatchmakeSessionSearchCriteria

ParticipantDetails

PersistentGathering

PlayingSession

SimpleCommunity

SimplePlayingSession

UpdateMatchmakeSessionParam

Module: `nintendo.nex.matchmaking_eagle`