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: Any, **kwargs: Any)[source]

Bases: marshmallow.

DID exchange complete schema class.

class Meta[source]

Bases: object

DID exchange complete schema metadata.

model_class

alias of aries_cloudagent.protocols.didexchange.v1_0.messages.complete.DIDXComplete

check_thread_deco(obj, **kwargs)

Thread decorator, and its thid and pthid, are mandatory.

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

DID Exchange problem report and reasons.

class aries_cloudagent.protocols.didexchange.v1_0.messages.problem_report.DIDXProblemReport(*, description: Optional[Mapping[str, str]] = None, problem_items: Optional[Sequence[Mapping[str, str]]] = None, who_retries: Optional[str] = None, fix_hint: Optional[Mapping[str, str]] = None, impact: Optional[str] = None, where: Optional[str] = None, noticed_time: Optional[str] = None, tracking_uri: Optional[str] = None, escalation_uri: Optional[str] = None, **kwargs)[source]

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

Base class representing a connection problem report message.

class Meta[source]

Bases: object

DID Exchange problem report metadata.

handler_class = 'aries_cloudagent.protocols.didexchange.v1_0.handlers.problem_report_handler.ProblemReportHandler'
message_type = 'didexchange/1.0/problem_report'
schema_class = 'DIDXProblemReportSchema'
class aries_cloudagent.protocols.didexchange.v1_0.messages.problem_report.DIDXProblemReportSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Schema for DIDXProblemReport model class.

class Meta[source]

Bases: object

Metadata for connection problem report schema.

model_class

alias of aries_cloudagent.protocols.didexchange.v1_0.messages.problem_report.DIDXProblemReport

validate_fields(data, **kwargs)

Validate schema fields.

class aries_cloudagent.protocols.didexchange.v1_0.messages.problem_report.ProblemReportReason(value)[source]

Bases: 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'

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: Optional[str] = None, did: Optional[str] = None, did_doc_attach: Optional[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator] = None, goal_code: Optional[str] = None, goal: Optional[str] = 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: Any, **kwargs: Any)[source]

Bases: marshmallow.

Schema class for DID exchange request under RFC 23.

class Meta[source]

Bases: object

DID exchange request schema class metadata.

model_class

alias of aries_cloudagent.protocols.didexchange.v1_0.messages.request.DIDXRequest

did
did_doc_attach
goal
goal_code
label

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: Optional[str] = None, did_doc_attach: Optional[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: Any, **kwargs: Any)[source]

Bases: marshmallow.

Schema class for DID exchange response under RFC 23.

class Meta[source]

Bases: object

DID exchange response schema class metadata.

model_class

alias of aries_cloudagent.protocols.didexchange.v1_0.messages.response.DIDXResponse

did
did_doc_attach