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(value)[source]
Bases:
Enum
Handshake protocol enum for invitation message.
- RFC160 = HSProtoSpec(rfc=160, name='connections/1.0', aka={'160', 'old', 'connection', 'conn', 'conns', 'rfc160', 'connections'})
- RFC23 = HSProtoSpec(rfc=23, name='didexchange/1.0', aka={'didex', 'didexchange', 'didx', '23', 'new', 'rfc23'})
- 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: Optional[str] = None, label: Optional[str] = None, image_url: Optional[str] = None, handshake_protocols: Optional[Sequence[str]] = None, requests_attach: Optional[Sequence[AttachDecorator]] = None, services: Optional[Sequence[Union[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:
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) InvitationMessage [source]
Parse a URL-encoded invitation into an InvitationMessage instance.
- Parameters
url – Url to decode
- Returns
An InvitationMessage object.
- to_url(base_url: Optional[str] = None) str [source]
Convert an invitation message to URL format for sharing.
- Returns
An invite url
- classmethod wrap_message(message: dict) AttachDecorator [source]
Convert an aries message to an attachment decorator.
- class aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessageSchema(*args: Any, **kwargs: Any)[source]
Bases:
AgentMessageSchema
InvitationMessage schema.
- class Meta[source]
Bases:
object
InvitationMessage schema metadata.
- model_class
alias of
InvitationMessage
- post_dump(data, **kwargs)
Post dump hook.
- requests_attach
alias of
AttachDecoratorSchema
- validate_fields(data, **kwargs)
Validate schema fields.
- Parameters
data – The data to validate
- Raises
ValidationError – If any of the fields do not validate
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:
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: Any, **kwargs: Any)[source]
Bases:
ProblemReportSchema
Schema for ProblemReport base class.
- class Meta[source]
Bases:
object
Metadata for problem report schema.
- model_class
alias of
OOBProblemReport
- check_thread_deco(obj, **kwargs)
Thread decorator, and its thid and pthid, are mandatory.
- validate_fields(data, **kwargs)
Validate schema fields.
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:
AgentMessage
Class representing a Handshake Reuse message.
- class aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse.HandshakeReuseSchema(*args: Any, **kwargs: Any)[source]
Bases:
AgentMessageSchema
Handshake Reuse schema class.
- class Meta[source]
Bases:
object
Handshake Reuse schema metadata.
- model_class
alias of
HandshakeReuse
- check_thread_deco(obj, **kwargs)
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:
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: Any, **kwargs: Any)[source]
Bases:
AgentMessageSchema
Handshake Reuse Accept schema class.
- class Meta[source]
Bases:
object
Handshake Reuse Accept schema metadata.
- model_class
alias of
HandshakeReuseAccept
- check_thread_deco(obj, **kwargs)
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: Optional[str] = None, _type: Optional[str] = None, did: Optional[str] = None, recipient_keys: Optional[Sequence[str]] = None, routing_keys: Optional[Sequence[str]] = None, service_endpoint: Optional[str] = None)[source]
Bases:
BaseModel
Record used to represent a service block of an out of band invitation.