Class DeleteFileParams

File deletion parameters.

Inheritance

object

TransactionParams

TransactionParams<TransactionReceipt>

DeleteFileParams

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 DeleteFileParams : TransactionParams<TransactionReceipt>

Examples

Permanently delete a network file. At least one of the file's key-list endorsements must sign:

// Permanently delete a file. At least one of the file's key-list
// endorsements must sign. Deleted files cannot be recovered.
var receipt = await client.DeleteFileAsync(new DeleteFileParams
{
    File = file
});
Console.WriteLine($"Delete status: {receipt.Status}");

Properties

CancellationToken

Optional cancellation token to interrupt the delete attempt.

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

Additional private key, keys or signing callback method required to delete this file.

Declaration

public Signatory? Signatory { get; set; }

Property Value

Type	Description
Signatory

Remarks

Keys or callbacks added here will be combined with those already identified in the client object's context when signing this transaction.