Class RevokeTokenKycExtensions
Extension methods for revoking KYC status from token-holding accounts.
Inherited Members
Namespace: Hiero
Assembly: Hiero.dll
Syntax
public static class RevokeTokenKycExtensions
Methods
| Edit this page View SourceRevokeTokenKycAsync(ConsensusClient, EntityId, EntityId, Action<IConsensusContext>?)
Revokes KYC status from the holding account relating to the specified token.
Declaration
public static Task<TransactionReceipt> RevokeTokenKycAsync(this ConsensusClient client, EntityId token, EntityId holder, Action<IConsensusContext>? configure = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ConsensusClient | client | The Consensus Node Client orchestrating the revoke. |
| EntityId | token | The identifier of the token to revoke KYC status. |
| EntityId | holder | The holding account to revoke KYC status from. |
| 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
// Clear the KYC-approved flag for a holder. Future transfers by or
// to this holder will be rejected until KYC is re-granted.
var receipt = await client.RevokeTokenKycAsync(token, holder);
Console.WriteLine($"KYC revoke status: {receipt.Status}");
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | If required arguments are missing. |
| InvalidOperationException | If required context configuration is missing. |
| PrecheckException | If the gateway node rejected the request upon submission, for example, if the token is already deleted. |
| ConsensusException | If the network was unable to come to consensus before the duration of the transaction expired. |
| TransactionException | If the network rejected the request as invalid or had missing data. |
RevokeTokenKycAsync(ConsensusClient, RevokeTokenKycParams, Action<IConsensusContext>?)
Revokes KYC status from the holding account relating to the specified token.
Declaration
public static Task<TransactionReceipt> RevokeTokenKycAsync(this ConsensusClient client, RevokeTokenKycParams revokeKycParams, Action<IConsensusContext>? configure = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ConsensusClient | client | The Consensus Node Client orchestrating the revoke. |
| RevokeTokenKycParams | revokeKycParams | The details identifying the token and account to revoke KYC status from. |
| 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
// Clear the KYC-approved flag for a holder. Future transfers by or
// to this holder will be rejected until KYC is re-granted.
var receipt = await client.RevokeTokenKycAsync(token, holder);
Console.WriteLine($"KYC revoke status: {receipt.Status}");
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | If required arguments are missing. |
| InvalidOperationException | If required context configuration is missing. |
| PrecheckException | If the gateway node rejected the request upon submission, for example, if the token is already deleted. |
| ConsensusException | If the network was unable to come to consensus before the duration of the transaction expired. |
| TransactionException | If the network rejected the request as invalid or had missing data. |