aries_cloudagent.protocols.introduction.v0_1 package

Subpackages

• aries_cloudagent.protocols.introduction.v0_1.handlers package
  • Submodules
  • aries_cloudagent.protocols.introduction.v0_1.handlers.forward_invitation_handler module
  • aries_cloudagent.protocols.introduction.v0_1.handlers.invitation_handler module
  • aries_cloudagent.protocols.introduction.v0_1.handlers.invitation_request_handler module
• aries_cloudagent.protocols.introduction.v0_1.messages package
  • Submodules
  • aries_cloudagent.protocols.introduction.v0_1.messages.forward_invitation module
  • aries_cloudagent.protocols.introduction.v0_1.messages.invitation module
  • aries_cloudagent.protocols.introduction.v0_1.messages.invitation_request module

Submodules

aries_cloudagent.protocols.introduction.v0_1.base_service module

Introduction service base classes.

class aries_cloudagent.protocols.introduction.v0_1.base_service.BaseIntroductionService

Bases: abc.ABC

Service handler for allowing connections to exchange invitations.

abstract async return_invitation(target_connection_id: str, invitation: aries_cloudagent.protocols.introduction.v0_1.messages.invitation.Invitation, session: aries_cloudagent.core.profile.ProfileSession, outbound_handler)

Handle the forwarding of an invitation to the responder.

Parameters

• target_connection_id – The ID of the connection sending the Invitation

• invitation – The received Invitation message

• session – Profile session to use for introduction records

• outbound_handler – The outbound handler coroutine for sending a message

classmethod service_handler()

Quick accessor for conductor to use.

abstract async start_introduction(init_connection_id: str, target_connection_id: str, outbound_handler, session: aries_cloudagent.core.profile.ProfileSession, message: Optional[str] = None)

Start the introduction process between two connections.

Parameters

• init_connection_id – The connection initiating the request

• target_connection_id – The connection which is asked for an invitation

• outbound_handler – The outbound handler coroutine for sending a message

• session – Profile session to use for connection, introduction records

• message – The message to use when requesting the invitation

exception aries_cloudagent.protocols.introduction.v0_1.base_service.IntroductionError(*args, error_code: Optional[str] = None, **kwargs)

Bases: aries_cloudagent.core.error.BaseError

Generic introduction service error.

aries_cloudagent.protocols.introduction.v0_1.demo_service module

Introduction service demo classes.

class aries_cloudagent.protocols.introduction.v0_1.demo_service.DemoIntroductionService

Bases: aries_cloudagent.protocols.introduction.v0_1.base_service.BaseIntroductionService

Service handler for allowing connections to exchange invitations.

RECORD_TYPE = 'introduction_record'

async return_invitation(target_connection_id: str, invitation: aries_cloudagent.protocols.introduction.v0_1.messages.invitation.Invitation, session: aries_cloudagent.core.profile.ProfileSession, outbound_handler)

Handle the forwarding of an invitation to the responder.

Parameters

• target_connection_id – The ID of the connection sending the Invitation

• invitation – The received (Introduction) Invitation message

• session – Profile session to use for introduction records

• outbound_handler – The outbound handler coroutine for sending a message

async start_introduction(init_connection_id: str, target_connection_id: str, message: str, session: aries_cloudagent.core.profile.ProfileSession, outbound_handler)

Start the introduction process between two connections.

Parameters

• init_connection_id – The connection initiating the request

• target_connection_id – The connection which is asked for an invitation

• outbound_handler – The outbound handler coroutine for sending a message

• session – Profile session to use for connection, introduction records

• message – The message to use when requesting the invitation

aries_cloudagent.protocols.introduction.v0_1.message_types module

Message type identifiers for Introductions.

aries_cloudagent.protocols.introduction.v0_1.routes module

Introduction service admin routes.

class aries_cloudagent.protocols.introduction.v0_1.routes.IntroConnIdMatchInfoSchema(*args: Any, **kwargs: Any)

Bases: marshmallow.

Path parameters and validators for request taking connection id.

conn_id

class aries_cloudagent.protocols.introduction.v0_1.routes.IntroModuleResponseSchema(*args: Any, **kwargs: Any)

Bases: marshmallow.

Response schema for Introduction Module.

class aries_cloudagent.protocols.introduction.v0_1.routes.IntroStartQueryStringSchema(*args: Any, **kwargs: Any)

Bases: marshmallow.

Query string parameters for request to start introduction.

message

target_connection_id

aries_cloudagent.protocols.introduction.v0_1.routes.post_process_routes(app: aiohttp.web.Application)

Amend swagger API.

async aries_cloudagent.protocols.introduction.v0_1.routes.register(app: aiohttp.web.Application)

Register routes.