Class PauseTokenParams

Transaction Parameters for Pausing a token preventing all accounts from sending or receiving the specified token.

Inheritance

object

TransactionParams

TransactionParams<TransactionReceipt>

PauseTokenParams

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

Examples

Halt all transfers of a token across every holder. Contrast with SuspendTokenParams which freezes a single holder:

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

Properties

CancellationToken

Optional cancellation token to interrupt the token pausing 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 pause. Typically matches the Endorsement assigned to the pause key for the token 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 change the state of this account.

Token

The identifier of the token or NFT class to pause.

Declaration

public EntityId Token { get; set; }

Property Value

Type	Description
EntityId