Class CancelAirdropExtensions

Extension methods for cancelling pending airdrops on the network.

Inheritance

object

CancelAirdropExtensions

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 CancelAirdropExtensions

Methods

CancelAirdropAsync(ConsensusClient, Airdrop, Action<IConsensusContext>?)

Cancels a single pending airdrop.

Declaration

public static Task<TransactionReceipt> CancelAirdropAsync(this ConsensusClient client, Airdrop airdrop, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the cancellation.
Airdrop	airdrop	The pending airdrop to cancel.
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

// Cancel a pending airdrop that hasn't been claimed yet. The sender
// calls this — cancelling returns the tokens to the sender's balance.
var pending = new Airdrop(token, sender, receiver);
var receipt = await client.CancelAirdropAsync(pending);
Console.WriteLine($"Cancel 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 request as invalid or had missing data.

CancelAirdropsAsync(ConsensusClient, CancelAirdropParams, Action<IConsensusContext>?)

Cancels one or more pending airdrops.

Declaration

public static Task<TransactionReceipt> CancelAirdropsAsync(this ConsensusClient client, CancelAirdropParams cancelParams, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the cancellation.
CancelAirdropParams	cancelParams	The cancellation parameters containing the list of pending airdrops to cancel.
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

// Cancel several pending airdrops in one transaction.
var receipt = await client.CancelAirdropsAsync(new CancelAirdropParams
{
    Airdrops = new[]
    {
        new Airdrop(token, sender, receiver1),
        new Airdrop(token, sender, receiver2)
    }
});
Console.WriteLine($"Cancel 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 request as invalid or had missing data.