aries_cloudagent.messaging.actionmenu.models package¶

Submodules¶

aries_cloudagent.messaging.actionmenu.models.menu_form module¶

Record used to represent the form associated with an action menu option.

class aries_cloudagent.messaging.actionmenu.models.menu_form.MenuForm(*, title: str = None, description: str = None, params: Sequence[aries_cloudagent.messaging.actionmenu.models.menu_form_param.MenuFormParam] = None, submit_label: str = None)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModel

Instance of a form associated with an action menu item.

class Meta[source]¶

Bases: object

Menu form metadata.

schema_class = 'MenuFormSchema'¶

class aries_cloudagent.messaging.actionmenu.models.menu_form.MenuFormSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

MenuForm schema.

class Meta[source]¶

Bases: object

MenuFormSchema metadata.

model_class¶: alias of MenuForm

description¶: Used by autodoc_mock_imports.

params¶: Used by autodoc_mock_imports.

submit_label¶: Used by autodoc_mock_imports.

title¶: Used by autodoc_mock_imports.

aries_cloudagent.messaging.actionmenu.models.menu_form_param module¶

Record used to represent a parameter in a menu form.

class aries_cloudagent.messaging.actionmenu.models.menu_form_param.MenuFormParam(*, name: str = None, title: str = None, default: str = None, description: str = None, input_type: str = None, required: bool = None)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModel

Instance of a menu form param associated with an action menu option.

class Meta[source]¶

Bases: object

Menu form param metadata.

schema_class = 'MenuFormParamSchema'¶

class aries_cloudagent.messaging.actionmenu.models.menu_form_param.MenuFormParamSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

MenuFormParam schema.

class Meta[source]¶

Bases: object

MenuFormParamSchema metadata.

model_class¶: alias of MenuFormParam

default¶: Used by autodoc_mock_imports.

description¶: Used by autodoc_mock_imports.

input_type¶: Used by autodoc_mock_imports.

name¶: Used by autodoc_mock_imports.

required¶: Used by autodoc_mock_imports.

title¶: Used by autodoc_mock_imports.

aries_cloudagent.messaging.actionmenu.models.menu_option module¶

Record used to represent individual menu options in an action menu.

class aries_cloudagent.messaging.actionmenu.models.menu_option.MenuOption(*, name: str = None, title: str = None, description: str = None, disabled: bool = None, form: aries_cloudagent.messaging.actionmenu.models.menu_form.MenuForm = None)[source]¶