aries_cloudagent.protocols.actionmenu package

Subpackages

• aries_cloudagent.protocols.actionmenu.handlers package
  • Submodules
  • aries_cloudagent.protocols.actionmenu.handlers.menu_handler module
  • aries_cloudagent.protocols.actionmenu.handlers.menu_request_handler module
  • aries_cloudagent.protocols.actionmenu.handlers.perform_handler module
• aries_cloudagent.protocols.actionmenu.messages package
  • Submodules
  • aries_cloudagent.protocols.actionmenu.messages.menu module
  • aries_cloudagent.protocols.actionmenu.messages.menu_request module
  • aries_cloudagent.protocols.actionmenu.messages.perform module
• aries_cloudagent.protocols.actionmenu.models package
  • Submodules
  • aries_cloudagent.protocols.actionmenu.models.menu_form module
  • aries_cloudagent.protocols.actionmenu.models.menu_form_param module
  • aries_cloudagent.protocols.actionmenu.models.menu_option module

Submodules

aries_cloudagent.protocols.actionmenu.base_service module

Base action menu service classes.

class aries_cloudagent.protocols.actionmenu.base_service.BaseMenuService(context: aries_cloudagent.config.injection_context.InjectionContext)

Bases: abc.ABC

Base action menu service interface.

get_active_menu(connection: aries_cloudagent.connections.models.connection_record.ConnectionRecord = None, thread_id: str = None) → aries_cloudagent.protocols.actionmenu.messages.menu.Menu

Render the current menu.

Parameters:

• connection – The active connection record
• thread_id – The thread identifier from the requesting message.

perform_menu_action(action_name: str, action_params: dict, connection: aries_cloudagent.connections.models.connection_record.ConnectionRecord = None, thread_id: str = None) → aries_cloudagent.messaging.agent_message.AgentMessage

Perform an action defined by the active menu.

Parameters:

• action_name – The unique name of the action being performed
• action_params – A collection of parameters for the action
• connection – The active connection record
• thread_id – The thread identifier from the requesting message.

classmethod service_handler()

Quick accessor for conductor to use.

aries_cloudagent.protocols.actionmenu.controller module

Protocol controller for the action menu message family.

class aries_cloudagent.protocols.actionmenu.controller.Controller(protocol: str)

Bases: object

Action menu protocol controller.

determine_roles(context: aries_cloudagent.config.injection_context.InjectionContext) → Sequence[str]

Determine what action menu roles are defined.

aries_cloudagent.protocols.actionmenu.driver_service module

Driver-based action menu service classes.

class aries_cloudagent.protocols.actionmenu.driver_service.DriverMenuService(context: aries_cloudagent.config.injection_context.InjectionContext)

Bases: aries_cloudagent.protocols.actionmenu.base_service.BaseMenuService

Driver-based action menu service.

get_active_menu(connection: aries_cloudagent.connections.models.connection_record.ConnectionRecord = None, thread_id: str = None) → aries_cloudagent.protocols.actionmenu.messages.menu.Menu

Render the current menu.

Parameters:

• connection – The active connection record
• thread_id – The thread identifier from the requesting message.

perform_menu_action(action_name: str, action_params: dict, connection: aries_cloudagent.connections.models.connection_record.ConnectionRecord = None, thread_id: str = None) → aries_cloudagent.messaging.agent_message.AgentMessage

Perform an action defined by the active menu.

Parameters:

• action_name – The unique name of the action being performed
• action_params – A collection of parameters for the action
• connection – The active connection record
• thread_id – The thread identifier from the requesting message.

send_webhook(topic: str, payload: dict)

Dispatch a webhook through the registered responder.

aries_cloudagent.protocols.actionmenu.message_types module

Message type identifiers for Action Menus.

aries_cloudagent.protocols.actionmenu.routes module

Action menu admin routes.

class aries_cloudagent.protocols.actionmenu.routes.MenuJsonSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Matches MenuSchema but without the inherited AgentMessage properties.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.actionmenu.routes.PerformRequestSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Request schema for performing a menu action.

opts = <marshmallow.schema.SchemaOpts object>

class aries_cloudagent.protocols.actionmenu.routes.SendMenuSchema(*, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

Request schema for sending a menu to a connection.

opts = <marshmallow.schema.SchemaOpts object>

aries_cloudagent.protocols.actionmenu.routes.actionmenu_close(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68f69748>)

Request handler for closing the menu associated with a connection.

Parameters:request – aiohttp request object

aries_cloudagent.protocols.actionmenu.routes.actionmenu_fetch(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68f69748>)

Request handler for fetching the previously-received menu for a connection.

Parameters:request – aiohttp request object

aries_cloudagent.protocols.actionmenu.routes.actionmenu_perform(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68f69748>)

Request handler for performing a menu action.

Parameters:request – aiohttp request object

aries_cloudagent.protocols.actionmenu.routes.actionmenu_request(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68f69748>)

Request handler for requesting a menu from the connection target.

Parameters:request – aiohttp request object

aries_cloudagent.protocols.actionmenu.routes.actionmenu_send(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68f69748>)

Request handler for requesting a menu from the connection target.

Parameters:request – aiohttp request object

aries_cloudagent.protocols.actionmenu.routes.register(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7faf68f69748>)

Register routes.

aries_cloudagent.protocols.actionmenu.util module

Action menu utility methods.

aries_cloudagent.protocols.actionmenu.util.retrieve_connection_menu(connection_id: str, context: aries_cloudagent.config.injection_context.InjectionContext) → aries_cloudagent.protocols.actionmenu.messages.menu.Menu

Retrieve the previously-received action menu.

aries_cloudagent.protocols.actionmenu.util.save_connection_menu(menu: aries_cloudagent.protocols.actionmenu.messages.menu.Menu, connection_id: str, context: aries_cloudagent.config.injection_context.InjectionContext)

Save a received action menu.