Type alias RecordUpdateParamsBeta

RecordUpdateParams: {
    data?: unknown;
    dataCid?: DwnMessageDescriptor[DwnInterface.RecordsWrite]["dataCid"];
    dataFormat?: string;
    dataSize?: DwnMessageDescriptor[DwnInterface.RecordsWrite]["dataSize"];
    dateModified?: DwnMessageDescriptor[DwnInterface.RecordsWrite]["messageTimestamp"];
    datePublished?: DwnMessageDescriptor[DwnInterface.RecordsWrite]["datePublished"];
    protocolRole?: RecordOptions["protocolRole"];
    published?: DwnMessageDescriptor[DwnInterface.RecordsWrite]["published"];
    store?: boolean;
    tags?: DwnMessageDescriptor[DwnInterface.RecordsWrite]["tags"];
}

Parameters for updating a DWN record.

This type specifies the set of properties that can be updated on an existing record. It is used to convey the new state or changes to be applied to the record.

Type declaration

  • Optional data?: unknown

    The new data for the record, which can be of any type. This data will replace the existing data of the record. It's essential to ensure that this data is compatible with the record's schema or data format expectations.

  • Optional dataCid?: DwnMessageDescriptor[DwnInterface.RecordsWrite]["dataCid"]

    The Content Identifier (CID) of the data. Updating this value changes the reference to the data associated with the record.

  • Optional dataFormat?: string

    The data format/MIME type of the supplied data

  • Optional dataSize?: DwnMessageDescriptor[DwnInterface.RecordsWrite]["dataSize"]

    The size of the data in bytes.

  • Optional dateModified?: DwnMessageDescriptor[DwnInterface.RecordsWrite]["messageTimestamp"]

    The timestamp indicating when the record was last modified.

  • Optional datePublished?: DwnMessageDescriptor[DwnInterface.RecordsWrite]["datePublished"]

    The timestamp indicating when the record was published.

  • Optional protocolRole?: RecordOptions["protocolRole"]

    The protocol role under which this record is written.

  • Optional published?: DwnMessageDescriptor[DwnInterface.RecordsWrite]["published"]

    The published status of the record.

  • Optional store?: boolean

    Whether or not to store the updated message.

  • Optional tags?: DwnMessageDescriptor[DwnInterface.RecordsWrite]["tags"]

    The tags associated with the updated record

Settings

Member Visibility

Theme