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={'connections', 'old', 'rfc160', 'conns', 'connection', 'conn', '160'})¶
-
RFC23
= HSProtoSpec(rfc=23, name='didexchange/1.0', aka={'23', 'didx', 'new', 'rfc23', 'didexchange', 'didex'})¶
-
aka
¶ Accessor for also-known-as.
-
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, goal_code: Optional[str] = None, goal: 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.
-
class
-
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.
-
goal
¶ Used by autodoc_mock_imports.
-
goal_code
¶ 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.
-
requests_attach
¶ Used by autodoc_mock_imports.
-
services
¶ Used by autodoc_mock_imports.
-
class
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
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.
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
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.
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
-
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.
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]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Record used to represent a service block of an out of band invitation.
-
class
aries_cloudagent.protocols.out_of_band.v1_0.messages.service.
ServiceSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Service schema.
-
did
¶ Used by autodoc_mock_imports.
-
recipient_keys
¶ Used by autodoc_mock_imports.
-
routing_keys
¶ Used by autodoc_mock_imports.
-
service_endpoint
¶ Used by autodoc_mock_imports.
-