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: str = None, did: str = None, recipient_keys: Sequence[str] = None, endpoint: str = None, routing_keys: Sequence[str] = None, image_url: 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: 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, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Connection invitation schema class.

class Meta[source]¶

Bases: object

Connection invitation schema metadata.

model_class¶: alias of ConnectionInvitation

unknown¶: Used by autodoc_mock_imports.

did¶: Used by autodoc_mock_imports.

endpoint¶: Used by autodoc_mock_imports.

image_url¶: Used by autodoc_mock_imports.

label¶: Used by autodoc_mock_imports.

recipient_keys¶: Used by autodoc_mock_imports.

routing_keys¶: Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]¶

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: aries_cloudagent.protocols.connections.v1_0.models.connection_detail.ConnectionDetail = None, label: str = None, image_url: 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, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Connection request schema class.

class Meta[source]¶

Bases: object

Connection request schema metadata.

model_class¶: alias of ConnectionRequest

unknown¶: Used by autodoc_mock_imports.

connection¶: Used by autodoc_mock_imports.

image_url¶: Used by autodoc_mock_imports.

label¶: Used by autodoc_mock_imports.

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

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Connection response schema class.

class Meta[source]¶

Bases: object

Connection response schema metadata.

model_class¶: alias of ConnectionResponse

signed_fields = ('connection',)¶

unknown¶: Used by autodoc_mock_imports.

connection¶: Used by autodoc_mock_imports.

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: 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.