Type alias RecordDeleteParamsBeta

RecordDeleteParams: {
    dateModified?: DwnMessageDescriptor[DwnInterface.RecordsDelete]["messageTimestamp"];
    protocolRole?: string;
    prune?: DwnMessageDescriptor[DwnInterface.RecordsDelete]["prune"];
    signAsOwner?: boolean;
    store?: boolean;
}

Parameters for deleting a DWN record.

This type specifies the set of properties that are used when deleting an existing record. It is used to convey the new state or changes to be applied to the record.

Type declaration

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

    The timestamp indicating when the record was deleted.

  • Optional protocolRole?: string

    The protocol role under which this record will be deleted.

  • Optional prune?: DwnMessageDescriptor[DwnInterface.RecordsDelete]["prune"]

    Whether or not to prune any children this record may have.

  • Optional signAsOwner?: boolean

    Whether or not to sign the delete as an owner in order to import it.

  • Optional store?: boolean

    Whether or not to store the message.

Settings

Member Visibility

Theme