Class DeleteFileExtensions

Extension methods for deleting network files.

Inheritance

object

DeleteFileExtensions

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 DeleteFileExtensions

Methods

DeleteFileAsync(ConsensusClient, DeleteFileParams, Action<IConsensusContext>?)

Removes a file from the network.

Declaration

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

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client executing the file deletion.
DeleteFileParams	deleteParams	The parameters indicating the file to delete and any additional signatories necessary to authorize the transaction.
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

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

Exceptions

Type	Condition
ArgumentException	If required arguments are missing or invalid.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node refused the transaction. Only a code about the transaction itself proves it did not execute; any other code leaves the outcome unknown, so settle it by its transaction id on a mirror node rather than resubmitting it (see PrecheckException).
ConsensusException	If the outcome could not be confirmed: the transaction may have executed, so settle it by its transaction id on a mirror node rather than resubmitting it.
TransactionException	If the network rejected the delete request as invalid or had missing data.