aries_cloudagent.protocols.introduction.v0_1 package

Subpackages

Submodules

aries_cloudagent.protocols.introduction.v0_1.base_service module

Introduction service base classes.

class aries_cloudagent.protocols.introduction.v0_1.base_service.BaseIntroductionService[source]

Bases: ABC

Service handler for allowing connections to exchange invitations.

abstract async return_invitation(target_connection_id: str, invitation: Invitation, session: ProfileSession, outbound_handler)[source]

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()[source]

Quick accessor for conductor to use.

abstract async start_introduction(init_connection_id: str, target_connection_id: str, outbound_handler, session: ProfileSession, message: Optional[str] = None)[source]

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)[source]

Bases: 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[source]

Bases: BaseIntroductionService

Service handler for allowing connections to exchange invitations.

RECORD_TYPE = 'introduction_record'
async return_invitation(target_connection_id: str, invitation: Invitation, session: ProfileSession, outbound_handler)[source]

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: ProfileSession, outbound_handler)[source]

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)[source]

Bases: OpenAPISchema

Path parameters and validators for request taking connection id.

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

Bases: OpenAPISchema

Response schema for Introduction Module.

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

Bases: OpenAPISchema

Query string parameters for request to start introduction.

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

Amend swagger API.

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

Register routes.