Menu Items

class navmenu.items.BaseItem(name=None, action=None)[source]

A generic menu item.

Parameters

name (Optional[str]) – The internal item name.
action (Optional[Action]) – The action to execute on item select.

abstract get_content()[source]

Get the menu item content.

Return type: dict
Returns: The item content.

is_available(payload=None)[source]

Check whether the menu item is available.

Parameters: payload (Optional[dict]) – An incoming message payload.
Return type: bool
Returns: A boolean indicating whether the menu item is available.

on_select(payload=None)[source]

Process the payload and return actions.

Parameters: payload (Optional[dict]) – An incoming message payload.
Return type: Iterator[Union[Message, Response]]
Returns: A sequence of responses.

serialize()[source]

Serialize the class instance to a dictionary.

Return type: dict
Returns: A serialized class instance.

class navmenu.items.Item(name, content, action=None)[source]

Bases: navmenu.items.BaseItem

A menu item with content.

Parameters

name (str) – The internal item name.
content (ItemContent) – The item content.
action (Optional[Action]) – The action to execute on item select.

get_content()[source]

Get the menu item content.

Return type: dict
Returns: The item content.

serialize()[source]

Serialize the class instance to a dictionary.

Return type: dict
Returns: A serialized class instance.

class navmenu.items.LineBreakItem(name=None, action=None)[source]

Bases: navmenu.items.BaseItem

A line break.

get_content()[source]

Get the menu item content.

Return type: dict
Returns: The item content.

class navmenu.items.ConditionalItem(name, content, action, condition)[source]

Bases: navmenu.items.Item

A menu item that is available only on certain condition.

Parameters

name (str) – The internal item name.
content (ItemContent) – The item content.
action (Action) – The action to execute on item select.
condition (str) – The condition to check.

is_available(payload=None)[source]

Check whether the menu item is available.

Parameters: payload (Optional[dict]) – An incoming message payload.
Return type: bool
Returns: A boolean indicating whether the menu item is available.

serialize()[source]

Serialize the class instance to a dictionary.

Return type: dict
Returns: A serialized class instance.