Class DissociateTokenExtensions

Extension methods for dissociating tokens from accounts on the network.

Inheritance

object

DissociateTokenExtensions

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 DissociateTokenExtensions

Methods

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

Removes Storage associated with the account for maintaining token balances for this account.

Declaration

public static Task<TransactionReceipt> DissociateTokenAsync(this ConsensusClient client, EntityId token, EntityId account, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the dissociation.
EntityId	token	The identifier of the token that will be dissociated.
EntityId	account	The identifier of the account that will be dissociated.
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.

Remarks

Since this action modifies the account's records, it must be signed by the account's key.

Examples

// Remove an account's token-balance storage slot. The account must
// hold zero balance of the token before dissociating.
var receipt = await client.DissociateTokenAsync(token, account);
Console.WriteLine($"Dissociate 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.

DissociateTokensAsync(ConsensusClient, DissociateTokenParams, Action<IConsensusContext>?)

Removes Storage associated with the account for maintaining token balances for this account.

Declaration

public static Task<TransactionReceipt> DissociateTokensAsync(this ConsensusClient client, DissociateTokenParams dissociateParams, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the dissociation.
DissociateTokenParams	dissociateParams	The parameters containing the account and tokens to dissociate.
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.

Remarks

Since this action modifies the account's records, it must be signed by the account's key.

Examples

// Remove an account's token-balance storage slot. The account must
// hold zero balance of the token before dissociating.
var receipt = await client.DissociateTokenAsync(token, account);
Console.WriteLine($"Dissociate 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.