Actions

class navmenu.actions.Action[source]

A generic action. Every action must inherit from this class and override its methods.

abstract process(payload=None)[source]

Process the payload and return a response.

Parameters: payload (Optional[dict]) – An incoming message payload.
Return type: Union[Message, Response]
Returns: A message or a response object.

abstract serialize()[source]

Serialize the class instance to a dictionary.

Return type: dict
Returns: A serialized class instance.

class navmenu.actions.MessageAction(text)[source]

Bases: navmenu.actions.Action

An action that returns a message.

Parameters: text (str) – The message text.

process(payload=None)[source]

Process the payload and return a response.

Parameters: payload (Optional[dict]) – An incoming message payload.
Return type: Message
Returns: A message or a response object.

serialize()[source]

Serialize the class instance to a dictionary.

Return type: dict
Returns: A serialized class instance.

class navmenu.actions.SubmenuAction(menu_name)[source]

Bases: navmenu.actions.Action

An action that opens a submenu.

Parameters: menu_name (str) – The name of the menu to open.

process(payload=None)[source]

Process the payload and return a response.

Parameters: payload (Optional[dict]) – An incoming message payload.
Return type: Response
Returns: A message or a response object.

serialize()[source]

Serialize the class instance to a dictionary.

Return type: dict
Returns: A serialized class instance.

class navmenu.actions.GoBackAction(count=1)[source]

Bases: navmenu.actions.Action

An action that returns user to the one of previous menus.

Parameters: count (int) – How many times to go back.

process(payload=None)[source]

Process the payload and return a response.

Parameters: payload (Optional[dict]) – An incoming message payload.
Return type: Response
Returns: A message or a response object.

serialize()[source]

Serialize the class instance to a dictionary.

Return type: dict
Returns: A serialized class instance.

class navmenu.actions.ExecuteAction(command, return_text=False)[source]

Bases: navmenu.actions.Action

An action that executes a code and optionally returns a message with the result.

Parameters

command (str) – The code to execute.
return_text (bool) – Whether to return result as a message with text.

process(payload=None)[source]

Process the payload and return a response.

Parameters: payload (Optional[dict]) – An incoming message payload.
Return type: Optional[Message]
Returns: A message or a response object.

serialize()[source]

Serialize the class instance to a dictionary.

Return type: dict
Returns: A serialized class instance.

class navmenu.actions.FunctionAction(function, templates=None)[source]

Bases: navmenu.actions.Action

An action that runs a function and optionally returns a response.

Parameters

function – The function to run.
templates (Optional[Dict[Any, Union[Message, Response]]]) – The response templates.

process(payload=None)[source]

Process the payload and return a response.

Parameters: payload (Optional[dict]) – An incoming message payload.
Return type: Union[Message, Response]
Returns: A message or a response object.

serialize()[source]

Serialize the class instance to a dictionary.

Return type: dict
Returns: A serialized class instance.