aries_cloudagent.protocols.didexchange.v1_0.messages package¶

Submodules¶

aries_cloudagent.protocols.didexchange.v1_0.messages.complete module¶

Represents a DID exchange complete message under RFC 23.

class aries_cloudagent.protocols.didexchange.v1_0.messages.complete.DIDXComplete(**kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a DID exchange completion.

class Meta[source]¶

Bases: object

Metadata for DID exchange completion.

handler_class = 'aries_cloudagent.protocols.didexchange.v1_0.handlers.complete_handler.DIDXCompleteHandler'¶

message_type = 'didexchange/1.0/complete'¶

schema_class = 'DIDXCompleteSchema'¶

class aries_cloudagent.protocols.didexchange.v1_0.messages.complete.DIDXCompleteSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

DID exchange complete schema class.

class Meta[source]¶

Bases: object

DID exchange complete schema metadata.

model_class¶: alias of DIDXComplete

unknown = 'exclude'¶

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

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

Represents a connection problem report message.

class aries_cloudagent.protocols.didexchange.v1_0.messages.problem_report.ProblemReport(*, problem_code: str = None, explain: str = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Base class representing a connection problem report message.

class Meta[source]¶

Bases: object

Connection problem report metadata.

handler_class = 'aries_cloudagent.messaging.problem_report.handler.ProblemReportHandler'¶

message_type = 'didexchange/1.0/problem_report'¶

schema_class = 'ProblemReportSchema'¶

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

Bases: str, enum.Enum

Supported reason codes.

COMPLETE_NOT_ACCEPTED = 'complete_not_accepted'¶

INVITATION_NOT_ACCEPTED = 'invitation_not_accepted'¶

REQUEST_NOT_ACCEPTED = 'request_not_accepted'¶

REQUEST_PROCESSING_ERROR = 'request_processing_error'¶

RESPONSE_NOT_ACCEPTED = 'response_not_accepted'¶

RESPONSE_PROCESSING_ERROR = 'response_processing_error'¶

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

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Schema for ProblemReport base class.

class Meta[source]¶

Bases: object

Metadata for problem report schema.

model_class¶: alias of ProblemReport

unknown = 'exclude'¶

explain = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

problem_code = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<OneOf(choices=['request_not_accepted', 'request_processing_error', 'invitation_not_accepted', 'response_not_accepted', 'response_processing_error', 'complete_not_accepted'], labels=[], error='Value {input} must be one of {choices}.')>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

aries_cloudagent.protocols.didexchange.v1_0.messages.request module¶

Represents a DID exchange request message under RFC 23.

class aries_cloudagent.protocols.didexchange.v1_0.messages.request.DIDXRequest(*, label: str = None, did: str = None, did_doc_attach: aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a DID exchange request under RFC 23.

class Meta[source]¶

Bases: object

Metadata for DID exchange request under RFC 23.

handler_class = 'aries_cloudagent.protocols.didexchange.v1_0.handlers.request_handler.DIDXRequestHandler'¶

message_type = 'didexchange/1.0/request'¶

schema_class = 'DIDXRequestSchema'¶

class aries_cloudagent.protocols.didexchange.v1_0.messages.request.DIDXRequestSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Schema class for DID exchange request under RFC 23.

class Meta[source]¶

Bases: object

DID exchange request schema class metadata.

model_class¶: alias of DIDXRequest

unknown = 'exclude'¶

did = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.IndyDID object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

did_doc_attach = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶

label = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

aries_cloudagent.protocols.didexchange.v1_0.messages.response module¶

Represents a DID exchange response message under RFC 23.

class aries_cloudagent.protocols.didexchange.v1_0.messages.response.DIDXResponse(*, did: str = None, did_doc_attach: aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a DID exchange response under RFC 23.

class Meta[source]¶

Bases: object

Metadata for DID exchange response under RFC 23.

handler_class = 'aries_cloudagent.protocols.didexchange.v1_0.handlers.response_handler.DIDXResponseHandler'¶

message_type = 'didexchange/1.0/response'¶

schema_class = 'DIDXResponseSchema'¶

class aries_cloudagent.protocols.didexchange.v1_0.messages.response.DIDXResponseSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Schema class for DID exchange response under RFC 23.

class Meta[source]¶

Bases: object

DID exchange response schema class metadata.

model_class¶: alias of DIDXResponse

unknown = 'exclude'¶

did = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.IndyDID object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>¶

did_doc_attach = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>¶