aries_cloudagent.messaging.actionmenu.messages package

Submodules

aries_cloudagent.messaging.actionmenu.messages.menu module

Represents an action menu.

class aries_cloudagent.messaging.actionmenu.messages.menu.Menu(*, title: str = None, description: str = None, errormsg: str = None, options: Sequence[aries_cloudagent.messaging.actionmenu.models.menu_option.MenuOption] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing an action menu.

class Meta[source]

Bases: object

Metadata for an action menu.

handler_class = 'aries_cloudagent.messaging.actionmenu.handlers.menu_handler.MenuHandler'
message_type = 'did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/action-menu/1.0/menu'
schema_class = 'MenuSchema'
class aries_cloudagent.messaging.actionmenu.messages.menu.MenuSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Menu schema class.

class Meta[source]

Bases: object

Menu schema metadata.

model_class

alias of Menu

description

Used by autodoc_mock_imports.

errormsg

Used by autodoc_mock_imports.

options

Used by autodoc_mock_imports.

title

Used by autodoc_mock_imports.

aries_cloudagent.messaging.actionmenu.messages.menu_request module

Represents a request for an action menu.

class aries_cloudagent.messaging.actionmenu.messages.menu_request.MenuRequest(**kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a request for an action menu.

class Meta[source]

Bases: object

Metadata for action menu request.

handler_class = 'aries_cloudagent.messaging.actionmenu.handlers.menu_request_handler.MenuRequestHandler'
message_type = 'did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/action-menu/1.0/menu-request'
schema_class = 'MenuRequestSchema'
class aries_cloudagent.messaging.actionmenu.messages.menu_request.MenuRequestSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

MenuRequest schema class.

class Meta[source]

Bases: object

MenuRequest schema metadata.

model_class

alias of MenuRequest

aries_cloudagent.messaging.actionmenu.messages.perform module

Represents a request to perform a menu action.

class aries_cloudagent.messaging.actionmenu.messages.perform.Perform(*, name: str = None, params: Mapping[str, str] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a request to perform a menu action.

class Meta[source]

Bases: object

Perform metadata.

handler_class = 'aries_cloudagent.messaging.actionmenu.handlers.perform_handler.PerformHandler'
message_type = 'did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/action-menu/1.0/perform'
schema_class = 'PerformSchema'
class aries_cloudagent.messaging.actionmenu.messages.perform.PerformSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Perform schema class.

class Meta[source]

Bases: object

Perform schema metadata.

model_class

alias of Perform

name

Used by autodoc_mock_imports.

params

Used by autodoc_mock_imports.