Module `mydata_did.v1_0.messages.read_did_response`

Expand source code

from aries_cloudagent.messaging.agent_message import AgentMessage, AgentMessageSchema

from marshmallow import EXCLUDE, fields

from ..message_types import PROTOCOL_PACKAGE, READ_DID_RESPONSE
from ..models.diddoc_model import MyDataDIDResponseBody, MyDataDIDResponseBodySchema
from ..utils.regex import MYDATA_DID


# Handler class for /mydata/v1.0/read-did-response
HANDLER_CLASS = (
    f"{PROTOCOL_PACKAGE}.handlers"
    ".read_did_response_handler.ReadDIDResponseHandler"
)

class ReadDIDResponseMessage(AgentMessage):
    """
    Message class for response to reading a DID.
    """
    class Meta:

        # Handler class that can handle this message
        handler_class = HANDLER_CLASS

        # Message type
        message_type = READ_DID_RESPONSE

        # Message schema class
        schema_class = "ReadDIDResponseMessageSchema"

    def __init__(self, *, from_did, to_did, created_time, body: MyDataDIDResponseBody, **kwargs):
        """
        Initialize a ReadDIDResponseMessage message instance.
        """
        super().__init__(**kwargs)

        # Set attributes
        self.from_did = from_did
        self.to_did = to_did
        self.created_time = created_time
        self.body = body

class ReadDIDResponseMessageSchema(AgentMessageSchema):
    """
    Schema class for response to reading a DID.
    """
    class Meta:
        # Model class
        model_class = ReadDIDResponseMessage

        # Unknown fields to exclude from the schema (handled by marshmallow)
        unknown = EXCLUDE
    
    # From DID
    from_did = fields.Str(data_key="from", **MYDATA_DID)

    # To DID
    to_did = fields.Str(data_key="to", **MYDATA_DID)

    # Created Time
    created_time = fields.Str(data_key="created_time")

    # Message body
    body = fields.Nested(MyDataDIDResponseBodySchema, required=True)

Classes

class ReadDIDResponseMessage (*, from_did, to_did, created_time, body: MyDataDIDResponseBody, **kwargs)

Message class for response to reading a DID.

Initialize a ReadDIDResponseMessage message instance.

Expand source code

class ReadDIDResponseMessage(AgentMessage):
    """
    Message class for response to reading a DID.
    """
    class Meta:

        # Handler class that can handle this message
        handler_class = HANDLER_CLASS

        # Message type
        message_type = READ_DID_RESPONSE

        # Message schema class
        schema_class = "ReadDIDResponseMessageSchema"

    def __init__(self, *, from_did, to_did, created_time, body: MyDataDIDResponseBody, **kwargs):
        """
        Initialize a ReadDIDResponseMessage message instance.
        """
        super().__init__(**kwargs)

        # Set attributes
        self.from_did = from_did
        self.to_did = to_did
        self.created_time = created_time
        self.body = body

Ancestors

aries_cloudagent.messaging.agent_message.AgentMessage
aries_cloudagent.messaging.models.base.BaseModel
abc.ABC

Class variables

var Meta

class ReadDIDResponseMessageSchema (*args, **kwargs)

Schema class for response to reading a DID.

Initialize an instance of AgentMessageSchema.

Raises

TypeError: If Meta.model_class has not been set

Expand source code

class ReadDIDResponseMessageSchema(AgentMessageSchema):
    """
    Schema class for response to reading a DID.
    """
    class Meta:
        # Model class
        model_class = ReadDIDResponseMessage

        # Unknown fields to exclude from the schema (handled by marshmallow)
        unknown = EXCLUDE
    
    # From DID
    from_did = fields.Str(data_key="from", **MYDATA_DID)

    # To DID
    to_did = fields.Str(data_key="to", **MYDATA_DID)

    # Created Time
    created_time = fields.Str(data_key="created_time")

    # Message body
    body = fields.Nested(MyDataDIDResponseBodySchema, required=True)

Ancestors

aries_cloudagent.messaging.agent_message.AgentMessageSchema
aries_cloudagent.messaging.models.base.BaseModelSchema
marshmallow.schema.Schema
marshmallow.base.SchemaABC

Class variables

var Meta
var opts