Module: nintendo.nex.utility

Provides a client and server for the UtilityProtocol. This page was generated automatically from utility.proto.

class UtilityClient
The client for the UtilityProtocol.

class UtilityServer
The server for the UtilityProtocol.

class UniqueIdInfo(Structure)

UtilityClient

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

async def acquire_nex_unique_id() -> int
Calls method 1 on the server.

async def acquire_nex_unique_id_with_password() -> UniqueIdInfo
Calls method 2 on the server.

async def associate_nex_unique_id_with_my_principal_id(info: UniqueIdInfo) -> None
Calls method 3 on the server.

async def associate_nex_unique_ids_with_my_principal_id(infos: list[UniqueIdInfo]) -> None
Calls method 4 on the server.

async def get_associated_nex_unique_id_with_my_principal_id() -> UniqueIdInfo
Calls method 5 on the server.

async def get_associated_nex_unique_ids_with_my_principal_id() -> list[UniqueIdInfo]
Calls method 6 on the server.

async def get_integer_settings(index: int) -> dict[int, int]
Calls method 7 on the server.

async def get_string_settings(index: int) -> dict[int, str]
Calls method 8 on the server.

UtilityServer

def __init__()
Creates a new UtilityServer.

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

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

async def acquire_nex_unique_id_with_password(client: RMCClient) -> UniqueIdInfo
Handler for method 2. This method should be overridden by a subclass.

async def associate_nex_unique_id_with_my_principal_id(client: RMCClient, info: UniqueIdInfo) -> None
Handler for method 3. This method should be overridden by a subclass.

async def associate_nex_unique_ids_with_my_principal_id(client: RMCClient, infos: list[UniqueIdInfo]) -> None
Handler for method 4. This method should be overridden by a subclass.

async def get_associated_nex_unique_id_with_my_principal_id(client: RMCClient) -> UniqueIdInfo
Handler for method 5. This method should be overridden by a subclass.

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

async def get_integer_settings(client: RMCClient, index: int) -> dict[int, int]
Handler for method 7. This method should be overridden by a subclass.

async def get_string_settings(client: RMCClient, index: int) -> dict[int, str]
Handler for method 8. This method should be overridden by a subclass.

UniqueIdInfo

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

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