Class SystemDeleteFileExtensions

Extension methods for administratively deleting a file from the network.

Inheritance

object

SystemDeleteFileExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero

Assembly: Hiero.dll

Syntax

public static class SystemDeleteFileExtensions

Methods

SystemDeleteFileAsync(ConsensusClient, SystemDeleteFileParams, Action<IConsensusContext>?)

Removes a file from the network via Administrative Delete

Declaration

public static Task<TransactionReceipt> SystemDeleteFileAsync(this ConsensusClient client, SystemDeleteFileParams deleteParams, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the administrative command.
SystemDeleteFileParams	deleteParams	The parameters for the system delete operation, including the file address to delete.
Action<IConsensusContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the file deletion.

Examples

// 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}");

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the delete request as invalid or had missing data.