Class SuspendTokenParams

Token parameters for suspending an account's ability to send or receive the specified token.

Inheritance

object

TransactionParams

TransactionParams<TransactionReceipt>

SuspendTokenParams

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

Examples

Freeze a single holder's ability to move this token. Contrast with PauseTokenParams which halts all holders at once:

// Freeze one holder's ability to move this token. Different from
// PauseTokenAsync (which affects all holders). Requires the token's
// SuspendEndorsement key to sign.
var receipt = await client.SuspendTokenAsync(token, holder);
Console.WriteLine($"Suspend status: {receipt.Status}");

Properties

CancellationToken

Optional cancellation token to interrupt the token suspension submission process.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

Holder

The identifier of the account holding the token that will be suspended/frozen.

Declaration

public EntityId Holder { get; set; }

Property Value

Type	Description
EntityId

Signatory

Additional private key, keys or signing callback method required to authorize the suspension. Typically matches the Endorsement assigned to the Suspend/Freeze 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 suspend.

Declaration

public EntityId Token { get; set; }

Property Value

Type	Description
EntityId