Module `mydata_did.v1_0.messages.json_ld_processed`

Expand source code

from aries_cloudagent.messaging.agent_message import AgentMessage, AgentMessageSchema
from marshmallow import EXCLUDE, fields

from ..message_types import JSON_LD_PROCESSED_DATA, PROTOCOL_PACKAGE
from ..models.json_ld_processed_model import JSONLDProcessedBody, JSONLDProcessedBodySchema
from ..utils.regex import MYDATA_DID

# Handler class for json-ld/1.0/processed-data message
HANDLER_CLASS = (
    f"{PROTOCOL_PACKAGE}.handlers"
    ".json_ld_processed_handler.JSONLDProcessedHandler"
)


class JSONLDProcessedMessage(AgentMessage):
    """
    Message class for json-ld/1.0/processed-data message.
    """

    class Meta:

        # Handler class that can handle this message
        handler_class = HANDLER_CLASS

        # Message type
        message_type = JSON_LD_PROCESSED_DATA

        # Message schema class
        schema_class = "JSONLDProcessedMessageSchema"

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

        # Sender DID
        self.from_did = from_did

        # Recipient DID
        self.to_did = to_did

        # The time the message was created
        self.created_time = created_time

        # Message body
        self.body = body


class JSONLDProcessedMessageSchema(AgentMessageSchema):
    """
    Schema class for json-ld/1.0/processed-data message
    """

    class Meta:
        # The message class that this schema is for
        model_class = JSONLDProcessedMessage

        # 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(
        JSONLDProcessedBodySchema,
        required=True
    )

Classes

class JSONLDProcessedMessage (*, from_did, to_did, created_time, body: JSONLDProcessedBody, **kwargs)

Message class for json-ld/1.0/processed-data message.

Initialize a JSONLDProcessedMessage message instance.

Expand source code

class JSONLDProcessedMessage(AgentMessage):
    """
    Message class for json-ld/1.0/processed-data message.
    """

    class Meta:

        # Handler class that can handle this message
        handler_class = HANDLER_CLASS

        # Message type
        message_type = JSON_LD_PROCESSED_DATA

        # Message schema class
        schema_class = "JSONLDProcessedMessageSchema"

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

        # Sender DID
        self.from_did = from_did

        # Recipient DID
        self.to_did = to_did

        # The time the message was created
        self.created_time = created_time

        # Message body
        self.body = body

Ancestors

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

Class variables

var Meta

class JSONLDProcessedMessageSchema (*args, **kwargs)

Schema class for json-ld/1.0/processed-data message

Initialize an instance of AgentMessageSchema.

Raises

TypeError: If Meta.model_class has not been set

Expand source code

class JSONLDProcessedMessageSchema(AgentMessageSchema):
    """
    Schema class for json-ld/1.0/processed-data message
    """

    class Meta:
        # The message class that this schema is for
        model_class = JSONLDProcessedMessage

        # 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(
        JSONLDProcessedBodySchema,
        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