aries_cloudagent.protocols.connections.v1_0.messages package

Submodules

aries_cloudagent.protocols.connections.v1_0.messages.connection_invitation module

Represents an invitation message for establishing connection.

class aries_cloudagent.protocols.connections.v1_0.messages.connection_invitation.ConnectionInvitation(*, label: Optional[str] = None, did: Optional[str] = None, recipient_keys: Optional[Sequence[str]] = None, endpoint: Optional[str] = None, routing_keys: Optional[Sequence[str]] = None, image_url: Optional[str] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a connection invitation.

class Meta[source]

Bases: object

Metadata for a connection invitation.

handler_class = 'aries_cloudagent.protocols.connections.v1_0.handlers.connection_invitation_handler.ConnectionInvitationHandler'

message_type = 'connections/1.0/invitation'

schema_class = 'ConnectionInvitationSchema'

classmethod from_url(url: str) → aries_cloudagent.protocols.connections.v1_0.messages.connection_invitation.ConnectionInvitation[source]

Parse a URL-encoded invitation into a ConnectionInvitation message.

Parameters: url – Url to decode
Returns: A ConnectionInvitation object.

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

Convert an invitation to URL format for sharing.

Returns: An invite url

class aries_cloudagent.protocols.connections.v1_0.messages.connection_invitation.ConnectionInvitationSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Connection invitation schema class.

class Meta[source]

Bases: object

Connection invitation schema metadata.

model_class: alias of aries_cloudagent.protocols.connections.v1_0.messages.connection_invitation.ConnectionInvitation

did

endpoint

image_url

label

recipient_keys

routing_keys

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.connections.v1_0.messages.connection_request module

Represents a connection request message.

class aries_cloudagent.protocols.connections.v1_0.messages.connection_request.ConnectionRequest(*, connection: Optional[aries_cloudagent.protocols.connections.v1_0.models.connection_detail.ConnectionDetail] = None, label: Optional[str] = None, image_url: Optional[str] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a connection request.

class Meta[source]

Bases: object

Metadata for a connection request.

handler_class = 'aries_cloudagent.protocols.connections.v1_0.handlers.connection_request_handler.ConnectionRequestHandler'

message_type = 'connections/1.0/request'

schema_class = 'ConnectionRequestSchema'

class aries_cloudagent.protocols.connections.v1_0.messages.connection_request.ConnectionRequestSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Connection request schema class.

class Meta[source]

Bases: object

Connection request schema metadata.

model_class: alias of aries_cloudagent.protocols.connections.v1_0.messages.connection_request.ConnectionRequest

connection: alias of aries_cloudagent.protocols.connections.v1_0.models.connection_detail.ConnectionDetailSchema

aries_cloudagent.protocols.connections.v1_0.messages.connection_response module

Represents a connection response message.

class aries_cloudagent.protocols.connections.v1_0.messages.connection_response.ConnectionResponse(*, connection: Optional[aries_cloudagent.protocols.connections.v1_0.models.connection_detail.ConnectionDetail] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a connection response.

class Meta[source]

Bases: object

Metadata for a connection response.

handler_class = 'aries_cloudagent.protocols.connections.v1_0.handlers.connection_response_handler.ConnectionResponseHandler'

message_type = 'connections/1.0/response'

schema_class = 'ConnectionResponseSchema'

class aries_cloudagent.protocols.connections.v1_0.messages.connection_response.ConnectionResponseSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Connection response schema class.

class Meta[source]

Bases: object

Connection response schema metadata.

model_class: alias of aries_cloudagent.protocols.connections.v1_0.messages.connection_response.ConnectionResponse

signed_fields = ('connection',)

connection

aries_cloudagent.protocols.connections.v1_0.messages.problem_report module

Represents a connection problem report message.

class aries_cloudagent.protocols.connections.v1_0.messages.problem_report.ConnectionProblemReport(*, problem_code: Optional[str] = None, explain: Optional[str] = None, **kwargs)[source]