Class DeleteTopicParams

Transaction Parameters for Deleting a Consensus Topic.

Inheritance

object

TransactionParams

TransactionParams<TransactionReceipt>

DeleteTopicParams

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

Examples

Permanently delete a topic. Requires the Administrator key; immutable topics cannot be deleted:

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

Properties

CancellationToken

Optional cancellation token that can interrupt the submission process.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

Signatory

Additional private key, keys or signing callback method required to authorize the deletion. Typically matches the Endorsement assigned to the admin for the topic if it is not already set as the payer for the transaction.

Declaration

public Signatory? Signatory { get; set; }

Property Value

Type	Description
Signatory

Remarks

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

Topic

The Id of the topic.

Declaration

public EntityId Topic { get; set; }

Property Value

Type	Description
EntityId