Class DeleteTopicExtensions

Extension methods for deleting consensus topics.

Inheritance

object

DeleteTopicExtensions

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 DeleteTopicExtensions

Methods

DeleteTopicAsync(ConsensusClient, DeleteTopicParams, Action<IConsensusContext>?)

Deletes a topic instance from the network. Must be signed by the admin key.

Declaration

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

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the delete.
DeleteTopicParams	deleteParams	The parameters for deleting the topic.
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 a successful operation.

Examples

// Permanently delete a topic. Requires the Administrator key.
// After deletion, historical messages remain on mirror nodes but
// no new messages can be submitted.
var receipt = await client.DeleteTopicAsync(topic);
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.

DeleteTopicAsync(ConsensusClient, EntityId, Action<IConsensusContext>?)

Deletes a topic instance from the network. Must be signed by the admin key.

Declaration

public static Task<TransactionReceipt> DeleteTopicAsync(this ConsensusClient client, EntityId topic, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the delete.
EntityId	topic	The Topic instance that will be deleted.
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 a successful operation.

Examples

// Permanently delete a topic. Requires the Administrator key.
// After deletion, historical messages remain on mirror nodes but
// no new messages can be submitted.
var receipt = await client.DeleteTopicAsync(topic);
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.