Responses

class navmenu.responses.Message(text=None, keyboard=None, payload=None)[source]

An object that represents a message.

Parameters

text (Optional[str]) – The message text.
keyboard (Optional[Keyboard]) – The message keyboard.
payload (Optional[dict]) – The message payload.

get_text()[source]

Format and return message text.

Return type: Optional[str]
Returns: Formatted message text.

serialize()[source]

Serialize the class instance to a dictionary.

Return type: dict
Returns: A serialized class instance.

update_payload(payload)[source]

Update the message payload.

Parameters: payload (dict) – New message payload.
Return type: None

class navmenu.responses.Response(message=None, menu=None, go_back_count=None)[source]

Bases: object

An object that represents a message and can be used to change the current menu.

Parameters

message (Optional[Message]) – The message.
menu (Optional[str]) – The name of the menu to go to.
go_back_count (Optional[int]) – How many steps to go back.

serialize()[source]

Serialize the class instance to a dictionary.

Return type: dict
Returns: A serialized class instance.

update_payload(payload)[source]

Update the message payload.

Parameters: payload (dict) – New message payload.
Return type: None