Module: nintendo.nex.account

Provides a client and server for the AccountProtocol. This page was generated automatically from account.proto.

class AccountClient
The client for the AccountProtocol.

class AccountServer
The server for the AccountProtocol.

class AccountData(Structure)
class BasicAccountInfo(Structure)

AccountClient

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

async def create_account(name: str, key: str, groups: int, email: str) -> Result
Calls method 1 on the server.

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

async def disable_account(pid: int, until: DateTime, message: str) -> Result
Calls method 3 on the server.

async def change_password(new_key: str) -> bool
Calls method 4 on the server.

async def test_capability(capability: int) -> bool
Calls method 5 on the server.

async def get_name(pid: int) -> str
Calls method 6 on the server.

async def get_account_data() -> RMCResponse
Calls method 7 on the server. The RMC response has the following attributes:
result: Result
data: AccountData

async def get_private_data() -> RMCResponse
Calls method 8 on the server. The RMC response has the following attributes:
result: bool
data: Data

async def get_public_data(pid: int) -> RMCResponse
Calls method 9 on the server. The RMC response has the following attributes:
result: bool
data: Data

async def get_multiple_public_data(pids: list[int]) -> RMCResponse
Calls method 10 on the server. The RMC response has the following attributes:
result: bool
data: list[Data]

async def update_account_name(name: str) -> Result
Calls method 11 on the server.

async def update_account_email(email: str) -> Result
Calls method 12 on the server.

async def update_custom_data(public_data: Data, private_data: Data) -> Result
Calls method 13 on the server.

async def find_by_name_regex(groups: int, regex: str, range: ResultRange) -> list[BasicAccountInfo]
Calls method 14 on the server.

async def update_account_expiry_date(pid: int, expiry: DateTime, message: str) -> None
Calls method 15 on the server.

async def update_account_effective_date(pid: int, effective_from: DateTime, message: str) -> None
Calls method 16 on the server.

async def update_status(status: str) -> None
Calls method 17 on the server.

async def get_status(pid: int) -> str
Calls method 18 on the server.

async def get_last_connection_stats(pid: int) -> RMCResponse
Calls method 19 on the server. The RMC response has the following attributes:
last_session_login: DateTime
last_session_logout: DateTime
current_session_login: DateTime

async def reset_password() -> bool
Calls method 20 on the server.

async def create_account_with_custom_data(name: str, key: str, groups: int, email: str, public_data: Data, private_data: Data) -> None
Calls method 21 on the server.

async def retrieve_account() -> RMCResponse
Calls method 22 on the server. The RMC response has the following attributes:
account_data: AccountData
public_data: Data
private_data: Data

async def update_account(key: str, email: str, public_data: Data, private_data: Data) -> None
Calls method 23 on the server.

async def change_password_by_guest(name: str, email: str, key: str) -> None
Calls method 24 on the server.

async def find_by_name_like(groups: int, like: str, range: ResultRange) -> list[BasicAccountInfo]
Calls method 25 on the server.

async def custom_create_account(name: str, key: str, groups: int, email: str, auth_data: Data) -> int
Calls method 26 on the server.

async def nintendo_create_account(name: str, key: str, groups: int, email: str, auth_data: Data) -> RMCResponse
Calls method 27 on the server. The RMC response has the following attributes:
pid: int
pid_hmac: str

async def lookup_or_create_account(name: str, key: str, groups: int, email: str, auth_data: Data) -> int
Calls method 28 on the server.

async def disconnect_principal(pid: int) -> bool
Calls method 29 on the server.

async def disconnect_all_principals() -> bool
Calls method 30 on the server.

AccountServer

def __init__()
Creates a new AccountServer.

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

async def create_account(client: RMCClient, name: str, key: str, groups: int, email: str) -> Result
Handler for method 1. This method should be overridden by a subclass.

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

async def disable_account(client: RMCClient, pid: int, until: DateTime, message: str) -> Result
Handler for method 3. This method should be overridden by a subclass.

async def change_password(client: RMCClient, new_key: str) -> bool
Handler for method 4. This method should be overridden by a subclass.

async def test_capability(client: RMCClient, capability: int) -> bool
Handler for method 5. This method should be overridden by a subclass.

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

async def get_account_data(client: RMCClient) -> RMCResponse
Handler for method 7. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: Result
data: AccountData

async def get_private_data(client: RMCClient) -> RMCResponse
Handler for method 8. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: bool
data: Data

async def get_public_data(client: RMCClient, pid: int) -> RMCResponse
Handler for method 9. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: bool
data: Data

async def get_multiple_public_data(client: RMCClient, pids: list[int]) -> RMCResponse
Handler for method 10. This method should be overridden by a subclass. The RMC response must have the following attributes:
result: bool
data: list[Data]

async def update_account_name(client: RMCClient, name: str) -> Result
Handler for method 11. This method should be overridden by a subclass.

async def update_account_email(client: RMCClient, email: str) -> Result
Handler for method 12. This method should be overridden by a subclass.

async def update_custom_data(client: RMCClient, public_data: Data, private_data: Data) -> Result
Handler for method 13. This method should be overridden by a subclass.

async def find_by_name_regex(client: RMCClient, groups: int, regex: str, range: ResultRange) -> list[BasicAccountInfo]
Handler for method 14. This method should be overridden by a subclass.

async def update_account_expiry_date(client: RMCClient, pid: int, expiry: DateTime, message: str) -> None
Handler for method 15. This method should be overridden by a subclass.

async def update_account_effective_date(client: RMCClient, pid: int, effective_from: DateTime, message: str) -> None
Handler for method 16. This method should be overridden by a subclass.

async def update_status(client: RMCClient, status: str) -> None
Handler for method 17. This method should be overridden by a subclass.

async def get_status(client: RMCClient, pid: int) -> str
Handler for method 18. This method should be overridden by a subclass.

async def get_last_connection_stats(client: RMCClient, pid: int) -> RMCResponse
Handler for method 19. This method should be overridden by a subclass. The RMC response must have the following attributes:
last_session_login: DateTime
last_session_logout: DateTime
current_session_login: DateTime

async def reset_password(client: RMCClient) -> bool
Handler for method 20. This method should be overridden by a subclass.

async def create_account_with_custom_data(client: RMCClient, name: str, key: str, groups: int, email: str, public_data: Data, private_data: Data) -> None
Handler for method 21. This method should be overridden by a subclass.

async def retrieve_account(client: RMCClient) -> RMCResponse
Handler for method 22. This method should be overridden by a subclass. The RMC response must have the following attributes:
account_data: AccountData
public_data: Data
private_data: Data

async def update_account(client: RMCClient, key: str, email: str, public_data: Data, private_data: Data) -> None
Handler for method 23. This method should be overridden by a subclass.

async def change_password_by_guest(client: RMCClient, name: str, email: str, key: str) -> None
Handler for method 24. This method should be overridden by a subclass.

async def find_by_name_like(client: RMCClient, groups: int, like: str, range: ResultRange) -> list[BasicAccountInfo]
Handler for method 25. This method should be overridden by a subclass.

async def custom_create_account(client: RMCClient, name: str, key: str, groups: int, email: str, auth_data: Data) -> int
Handler for method 26. This method should be overridden by a subclass.

async def nintendo_create_account(client: RMCClient, name: str, key: str, groups: int, email: str, auth_data: Data) -> RMCResponse
Handler for method 27. This method should be overridden by a subclass. The RMC response must have the following attributes:
pid: int
pid_hmac: str

async def lookup_or_create_account(client: RMCClient, name: str, key: str, groups: int, email: str, auth_data: Data) -> int
Handler for method 28. This method should be overridden by a subclass.

async def disconnect_principal(client: RMCClient, pid: int) -> bool
Handler for method 29. This method should be overridden by a subclass.

async def disconnect_all_principals(client: RMCClient) -> bool
Handler for method 30. This method should be overridden by a subclass.

AccountData

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

The following fields are defined in this class:
pid: int
name: str
groups: int
email: str
creation_date: DateTime
effective_date: DateTime
not_effective_message: str
expiry_date: DateTime
expired_message: str

BasicAccountInfo

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

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