aries_cloudagent.protocols.introduction package¶
Subpackages¶
Submodules¶
aries_cloudagent.protocols.introduction.base_service module¶
Introduction service base classes.
-
class
aries_cloudagent.protocols.introduction.base_service.
BaseIntroductionService
(context: aries_cloudagent.messaging.request_context.RequestContext)[source]¶ Bases:
abc.ABC
Service handler for allowing connections to exchange invitations.
-
return_invitation
(target_connection_id: str, invitation: aries_cloudagent.protocols.introduction.messages.invitation.Invitation, 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
- outbound_handler – The outbound handler coroutine for sending a message
-
start_introduction
(init_connection_id: str, target_connection_id: str, outbound_handler, message: 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
- message – The message to use when requesting the invitation
-
-
exception
aries_cloudagent.protocols.introduction.base_service.
IntroductionError
(*args, error_code: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.core.error.BaseError
Generic introduction service error.
aries_cloudagent.protocols.introduction.demo_service module¶
Introduction service demo classes.
-
class
aries_cloudagent.protocols.introduction.demo_service.
DemoIntroductionService
(context: aries_cloudagent.messaging.request_context.RequestContext)[source]¶ Bases:
aries_cloudagent.protocols.introduction.base_service.BaseIntroductionService
Service handler for allowing connections to exchange invitations.
-
RECORD_TYPE
= 'introduction_record'¶
-
return_invitation
(target_connection_id: str, invitation: aries_cloudagent.protocols.introduction.messages.invitation.Invitation, 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
- outbound_handler – The outbound handler coroutine for sending a message
-
start_introduction
(init_connection_id: str, target_connection_id: str, message: str, 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
- message – The message to use when requesting the invitation
-
aries_cloudagent.protocols.introduction.message_types module¶
Message type identifiers for Introductions.
aries_cloudagent.protocols.introduction.routes module¶
Introduction service admin routes.