Class PauseTokenExtensions

Extension methods for pausing a token on the network.

Inheritance

object

PauseTokenExtensions

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 PauseTokenExtensions

Methods

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

Pauses all accounts' ability to send or receive the specified token.

Declaration

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

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the pause.
EntityId	token	The identifier of the token to pause.
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

// Pause *all* transfers of the token across every holder. Token must
// have been created with a PauseEndorsement and its key must sign.
// Reverse with ContinueTokenAsync. Not to be confused with
// SuspendTokenAsync, which freezes a single holder.
var receipt = await client.PauseTokenAsync(token);
Console.WriteLine($"Pause 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.

PauseTokenAsync(ConsensusClient, PauseTokenParams, Action<IConsensusContext>?)

Pauses all accounts' ability to send or receive the specified token.

Declaration

public static Task<TransactionReceipt> PauseTokenAsync(this ConsensusClient client, PauseTokenParams pauseParams, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the pause.
PauseTokenParams	pauseParams	The details identifying the token to pause.
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

// Pause *all* transfers of the token across every holder. Token must
// have been created with a PauseEndorsement and its key must sign.
// Reverse with ContinueTokenAsync. Not to be confused with
// SuspendTokenAsync, which freezes a single holder.
var receipt = await client.PauseTokenAsync(token);
Console.WriteLine($"Pause 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.