aries_cloudagent.protocols.out_of_band.v1_0.messages package¶

Submodules¶

aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation module¶

An invitation content message.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.HSProto[source]¶

Bases: enum.Enum

Handshake protocol enum for invitation message.

RFC160 = HSProtoSpec(rfc=160, name='connections/1.0', aka={'connection', 'conn', 'old', 'connections', '160', 'rfc160', 'conns'})¶

RFC23 = HSProtoSpec(rfc=23, name='didexchange/1.0', aka={'didex', 'didx', '23', 'rfc23', 'new', 'didexchange'})¶

aka¶: Accessor for also-known-as.

get = <bound method HSProto.get of <enum 'HSProto'>>[source]¶

rfc¶: Accessor for RFC.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.HSProtoSpec(rfc, name, aka)¶

Bases: tuple

aka¶: Alias for field number 2

name¶: Alias for field number 1

rfc¶: Alias for field number 0

class aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessage(*, comment: str = None, label: str = None, image_url: str = None, handshake_protocols: Sequence[str] = None, requests_attach: Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator] = None, services: Sequence[Union[aries_cloudagent.protocols.out_of_band.v1_0.messages.service.Service, str]] = None, accept: Optional[Sequence[str]] = None, version: str = '1.1', msg_type: Optional[str] = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing an out of band invitation message.

class Meta[source]¶

Bases: object

InvitationMessage metadata.

message_type = 'out-of-band/1.1/invitation'¶

schema_class = 'InvitationMessageSchema'¶

classmethod from_url(url: str) → aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessage[source]¶

Parse a URL-encoded invitation into an InvitationMessage instance.

Parameters:	url – Url to decode
Returns:	An InvitationMessage object.

to_url(base_url: str = None) → str[source]¶

Convert an invitation message to URL format for sharing.

Returns:	An invite url

classmethod wrap_message(message: dict) → aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator[source]¶: Convert an aries message to an attachment decorator.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessageSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

InvitationMessage schema.

class Meta[source]¶

Bases: object

InvitationMessage schema metadata.

model_class¶: alias of InvitationMessage

unknown¶: Used by autodoc_mock_imports.

accept¶: Used by autodoc_mock_imports.

handshake_protocols¶: Used by autodoc_mock_imports.

image_url¶: Used by autodoc_mock_imports.

label¶: Used by autodoc_mock_imports.

post_dump(data, **kwargs)[source]¶: Post dump hook.

requests_attach¶: Used by autodoc_mock_imports.

services¶: Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]¶

Validate schema fields.

Parameters:	data – The data to validate
Raises:	`ValidationError` – If any of the fields do not validate

class aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.ServiceOrDIDField(*args, **kwargs)[source]¶

Bases: sphinx.ext.autodoc.importer._MockObject

DIDComm Service object or DID string field for Marshmallow.

aries_cloudagent.protocols.out_of_band.v1_0.messages.problem_report module¶

Represents an OOB connection reuse problem report message.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.problem_report.OOBProblemReport(version: str = '1.1', msg_type: Optional[str] = None, *args, **kwargs)[source]¶

Bases: aries_cloudagent.protocols.problem_report.v1_0.message.ProblemReport

Base class representing an OOB connection reuse problem report message.

class Meta[source]¶

Bases: object

OOB connection reuse problem report metadata.

handler_class = 'aries_cloudagent.protocols.out_of_band.v1_0.handlers.problem_report_handler.OOBProblemReportMessageHandler'¶

message_type = 'out-of-band/1.1/problem_report'¶

schema_class = 'OOBProblemReportSchema'¶

class aries_cloudagent.protocols.out_of_band.v1_0.messages.problem_report.OOBProblemReportSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.protocols.problem_report.v1_0.message.ProblemReportSchema

Schema for ProblemReport base class.

class Meta[source]¶

Bases: object

Metadata for problem report schema.

model_class¶: alias of OOBProblemReport

unknown¶: Used by autodoc_mock_imports.

check_thread_deco(obj, **kwargs)[source]¶: Thread decorator, and its thid and pthid, are mandatory.

validate_fields(data, **kwargs)[source]¶: Validate schema fields.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.problem_report.ProblemReportReason[source]¶

Bases: enum.Enum

Supported reason codes.

EXISTING_CONNECTION_NOT_ACTIVE = 'existing_connection_not_active'¶

NO_EXISTING_CONNECTION = 'no_existing_connection'¶

aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse module¶

Represents a Handshake Reuse message under RFC 0434.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse.HandshakeReuse(version: str = '1.1', msg_type: Optional[str] = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a Handshake Reuse message.

class Meta[source]¶

Bases: object

Metadata for Handshake Reuse message.

handler_class = 'aries_cloudagent.protocols.out_of_band.v1_0.handlers.reuse_handler.HandshakeReuseMessageHandler'¶

message_type = 'out-of-band/1.1/handshake-reuse'¶

schema_class = 'HandshakeReuseSchema'¶

class aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse.HandshakeReuseSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Handshake Reuse schema class.

class Meta[source]¶

Bases: object

Handshake Reuse schema metadata.

model_class¶: alias of HandshakeReuse

unknown¶: Used by autodoc_mock_imports.

check_thread_deco(obj, **kwargs)[source]¶: Thread decorator, and its thid and pthid, are mandatory.

aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse_accept module¶

Represents a Handshake Reuse Accept message under RFC 0434.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse_accept.HandshakeReuseAccept(version: str = '1.1', msg_type: Optional[str] = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a Handshake Reuse Accept message.

class Meta[source]¶

Bases: object

Metadata for Handshake Reuse Accept message.

handler_class = 'aries_cloudagent.protocols.out_of_band.v1_0.handlers.reuse_accept_handler.HandshakeReuseAcceptMessageHandler'¶

message_type = 'out-of-band/1.1/handshake-reuse-accepted'¶

schema_class = 'HandshakeReuseAcceptSchema'¶

class aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse_accept.HandshakeReuseAcceptSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Handshake Reuse Accept schema class.

class Meta[source]¶

Bases: object

Handshake Reuse Accept schema metadata.

model_class¶: alias of HandshakeReuseAccept

unknown¶: Used by autodoc_mock_imports.

check_thread_deco(obj, **kwargs)[source]¶: Thread decorator, and its thid and pthid, are mandatory.

aries_cloudagent.protocols.out_of_band.v1_0.messages.service module¶

Record used to represent a service block of an out of band invitation.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.service.Service(*, _id: str = None, _type: str = None, did: str = None, recipient_keys: Sequence[str] = None, routing_keys: Sequence[str] = None, service_endpoint: str = None)[source]¶