Module: nintendo.nex.messaging

Provides a client and server for the MessagingProtocol and MessageDeliveryProtocol. This page was generated automatically from messaging.proto.

class MessagingClient
The client for the MessagingProtocol.

class MessageDeliveryClient
The client for the MessageDeliveryProtocol.

class MessagingServer
The server for the MessagingProtocol.

class MessageDeliveryServer
The server for the MessageDeliveryProtocol.

class RecipientType

class BinaryMessage(UserMessage)
class MessageRecipient(Structure)
class TextMessage(UserMessage)
class UserMessage(Data)

MessagingClient

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

async def deliver_message(message: Data) -> RMCResponse
Calls method 1 on the server. The RMC response has the following attributes:
modified_message: Data
sandbox_node_ids: list[int]
participants: list[int]

async def get_number_of_messages(recipient: MessageRecipient) -> int
Calls method 2 on the server.

async def get_message_headers(recipient: MessageRecipient, range: ResultRange) -> list[UserMessage]
Calls method 3 on the server.

async def retrieve_all_messages_within_range(recipient: MessageRecipient, range: ResultRange) -> list[Data]
Calls method 4 on the server.

async def retrieve_messages(recipient: MessageRecipient, message_ids: list[int], leave_on_server: bool) -> list[Data]
Calls method 5 on the server.

async def delete_messages(recipient: MessageRecipient, message_ids: list[int]) -> None
Calls method 6 on the server.

async def delete_all_messages(recipient: MessageRecipient) -> int
Calls method 7 on the server.

MessageDeliveryClient

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

async def deliver_message(message: Data) -> None
Calls method 1 on the server.

MessagingServer

def __init__()
Creates a new MessagingServer.

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

async def deliver_message(client: RMCClient, message: Data) -> RMCResponse
Handler for method 1. This method should be overridden by a subclass. The RMC response must have the following attributes:
modified_message: Data
sandbox_node_ids: list[int]
participants: list[int]

async def get_number_of_messages(client: RMCClient, recipient: MessageRecipient) -> int
Handler for method 2. This method should be overridden by a subclass.

async def get_message_headers(client: RMCClient, recipient: MessageRecipient, range: ResultRange) -> list[UserMessage]
Handler for method 3. This method should be overridden by a subclass.

async def retrieve_all_messages_within_range(client: RMCClient, recipient: MessageRecipient, range: ResultRange) -> list[Data]
Handler for method 4. This method should be overridden by a subclass.

async def retrieve_messages(client: RMCClient, recipient: MessageRecipient, message_ids: list[int], leave_on_server: bool) -> list[Data]
Handler for method 5. This method should be overridden by a subclass.

async def delete_messages(client: RMCClient, recipient: MessageRecipient, message_ids: list[int]) -> None
Handler for method 6. This method should be overridden by a subclass.

async def delete_all_messages(client: RMCClient, recipient: MessageRecipient) -> int
Handler for method 7. This method should be overridden by a subclass.

MessageDeliveryServer

def __init__()
Creates a new MessageDeliveryServer.

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

async def deliver_message(client: RMCClient, message: Data) -> None
Handler for method 1. This method should be overridden by a subclass.

RecipientType

This class defines the following constants:
PRINCIPAL = 1
GATHERING = 2

BinaryMessage

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

The following fields are defined in this class:
body: bytes

MessageRecipient

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

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

TextMessage

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

The following fields are defined in this class:
body: str

UserMessage

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

The following fields are defined in this class:
id: int
parent_id: int
sender: int
reception_time: DateTime
life_time: int
flags: int
subject: str
sender_name: str
recipient: MessageRecipient = MessageRecipient()