Class SystemDeleteFileParams

Transaction parameters for administratively deleting a file from the network.

Inheritance

object

TransactionParams

TransactionParams<TransactionReceipt>

SystemDeleteFileParams

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero

Assembly: Hiero.dll

Syntax

public sealed class SystemDeleteFileParams : TransactionParams<TransactionReceipt>

Examples

Superuser-only: remove a file that would otherwise be undeletable. Restorable via SystemRestoreFileParams:

// Superuser-only: delete a file that is otherwise undeletable
// (e.g. an immutable file). The file becomes inaccessible but can
// be restored via SystemRestoreFileAsync within a grace window.
var receipt = await client.SystemDeleteFileAsync(new SystemDeleteFileParams
{
    File = file
});
Console.WriteLine($"System delete status: {receipt.Status}");

Properties

CancellationToken

An optional cancellation token that can be used to interrupt the transaction.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

File

The address of the file to delete.

Declaration

public EntityId File { get; set; }

Property Value

Type	Description
EntityId

Signatory

Optional additional signatories.

Declaration

public Signatory? Signatory { get; set; }

Property Value

Type	Description
Signatory