Class DeleteScheduleParams

Transaction Parameters for deleting an existing scheduled transaction from the network.

Inheritance

object

TransactionParams

TransactionParams<TransactionReceipt>

DeleteScheduleParams

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

Examples

Cancel a pending schedule. Only schedules that were created with an Administrator key can be deleted, and only by that admin:

// Cancel a pending schedule before it executes. Only schedules
// created with an Administrator key can be deleted — and only by
// that admin. Once the schedule's inner transaction has executed
// or expired, deletion is not meaningful.
var receipt = await client.DeleteScheduleAsync(scheduleId);
Console.WriteLine($"Delete status: {receipt.Status}");

Properties

CancellationToken

Optional cancellation token to interrupt the transaction submission process.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

Schedule

The address of the schedule entity to delete.

Declaration

public EntityId Schedule { get; set; }

Property Value

Type	Description
EntityId

Signatory

Additional private key, keys or signing callback method required to authorize the deletion of the schedule. Typically matches the administrator endorsement assigned to the schedule when it was created.

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.