Module dexa_sdk.agreements.da.v1_0.records.da_qrcode_record

Classes

class DataAgreementQRCodeRecord (id: str = None, template_id: str = None, multi_use_flag: str = None, scanned_flag: str = None, connection_id: str = None, state: str = None, dynamic_link: str = None, data_ex_id: str = None, **kwargs)

Data agreement QR code record

Initialize a new BaseRecord.

Expand source code

class DataAgreementQRCodeRecord(BaseRecord):
    """Data agreement QR code record"""
    class Meta:
        schema_class = "DataAgreementQRCodeRecordSchema"

    # Record type
    RECORD_TYPE = "da_qr"

    # Record identifier
    RECORD_ID_NAME = "id"

    # Webhook topic name for this record type
    WEBHOOK_TOPIC = None

    # Record tags
    TAG_NAMES = {
        "~template_id",
        "~multi_use_flag",
        "~scanned_flag",
        "~connection_id",
        "~data_ex_id"
    }

    def __init__(
        self,
        id: str = None,
        template_id: str = None,
        multi_use_flag: str = None,
        scanned_flag: str = None,
        connection_id: str = None,
        state: str = None,
        dynamic_link: str = None,
        data_ex_id: str = None,
        **kwargs
    ):
        # Pass the identifier and state to parent class
        super().__init__(id, state, **kwargs)

        self.connection_id = connection_id
        self.template_id = template_id
        self.multi_use_flag = multi_use_flag
        self.scanned_flag = scanned_flag
        self.dynamic_link = dynamic_link
        self.data_ex_id = data_ex_id

    @property
    def qr_id(self) -> str:
        return self._id

    @property
    def record_value(self) -> dict:
        """Accessor for JSON record value generated for this transaction record."""
        return {
            prop: getattr(self, prop)
            for prop in (
                "connection_id",
                "template_id",
                "multi_use_flag",
                "scanned_flag",
                "dynamic_link",
                "data_ex_id"
            )
        }

    @property
    def _multi_use_flag(self) -> bool:
        return self.multi_use_flag

    @_multi_use_flag.setter
    def _multi_use_flag(self, val: bool):
        self.mult_use_flag = bool_to_str(val)

    @property
    def _scanned_flag(self) -> bool:
        return self.scanned_flag

    @_scanned_flag.setter
    def _scanned_flag(self, val: bool) -> bool:
        self.scanned_flag = bool_to_str(val)

    async def connection_record(self, context: InjectionContext) -> ConnectionRecord:
        """Retreive connection record.

        Returns:
            ConnectionRecord: Connection record.
        """
        return await ConnectionRecord.retrieve_by_id(
            context,
            self.connection_id
        )

Ancestors

• aries_cloudagent.messaging.models.base_record.BaseRecord
• aries_cloudagent.messaging.models.base.BaseModel
• abc.ABC

Class variables

var Meta

var RECORD_ID_NAME

var RECORD_TYPE

var TAG_NAMES

var WEBHOOK_TOPIC

Instance variables

var qr_id : str

Expand source code

@property
def qr_id(self) -> str:
    return self._id

var record_value : dict

Accessor for JSON record value generated for this transaction record.

Expand source code

@property
def record_value(self) -> dict:
    """Accessor for JSON record value generated for this transaction record."""
    return {
        prop: getattr(self, prop)
        for prop in (
            "connection_id",
            "template_id",
            "multi_use_flag",
            "scanned_flag",
            "dynamic_link",
            "data_ex_id"
        )
    }

Methods

async def connection_record(self, context: aries_cloudagent.config.injection_context.InjectionContext) ‑> aries_cloudagent.connections.models.connection_record.ConnectionRecord

Retreive connection record.

Returns

ConnectionRecord

Connection record.

Expand source code

async def connection_record(self, context: InjectionContext) -> ConnectionRecord:
    """Retreive connection record.

    Returns:
        ConnectionRecord: Connection record.
    """
    return await ConnectionRecord.retrieve_by_id(
        context,
        self.connection_id
    )

class DataAgreementQRCodeRecordSchema (*args, **kwargs)

Data agreement QR code record schema

Initialize BaseModelSchema.

Raises

TypeError

If model_class is not set on Meta

Expand source code

class DataAgreementQRCodeRecordSchema(BaseRecordSchema):
    """Data agreement QR code record schema"""

    class Meta:
        model_class = DataAgreementQRCodeRecord

    qr_id = fields.Str()
    connection_id = fields.Str()
    template_id = fields.Str()
    multi_use_flag = fields.Str()
    scanned_flag = fields.Str()
    dynamic_link = fields.Str()
    data_ex_id = fields.Str()

Ancestors

• aries_cloudagent.messaging.models.base_record.BaseRecordSchema
• aries_cloudagent.messaging.models.base.BaseModelSchema
• marshmallow.schema.Schema
• marshmallow.base.SchemaABC

Class variables

var Meta

var opts