Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto

Interface TokenRelationshipOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
TokenRelationship, TokenRelationship.Builder
@Generated public interface TokenRelationshipOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Details

    • hasTokenId

      boolean hasTokenId()
       *
 A token identifier.
 <p>
 This MUST match an existing token that is not deleted.
      .proto.TokenID tokenId = 1;
      Returns:
      Whether the tokenId field is set.

    • getTokenId

      TokenID getTokenId()
       *
 A token identifier.
 <p>
 This MUST match an existing token that is not deleted.
      .proto.TokenID tokenId = 1;
      Returns:
      The tokenId.

    • getSymbol

      String getSymbol()
       *
 A token symbol.
 <p>
 This MUST match an existing token that is not deleted.<br/>
 This MUST match the value for the token identified in `tokenId`.
      string symbol = 2;
      Returns:
      The symbol.

    • getSymbolBytes

      com.google.protobuf.ByteString getSymbolBytes()
       *
 A token symbol.
 <p>
 This MUST match an existing token that is not deleted.<br/>
 This MUST match the value for the token identified in `tokenId`.
      string symbol = 2;
      Returns:
      The bytes for symbol.

    • getBalance

      long getBalance()
       *
 An account balance for this token.
 <p>
 For fungible/common tokens this SHALL be the balance that the
 account holds of that token. The value is provided as an integer amount
 of the smallest unit of the token (i.e. 10<sup>`-decimals`</sup> whole
 tokens).<br/>
 For non-fungible/unique tokens this SHALL be the whole number of
 unique tokens held by the account for this token type.
      uint64 balance = 3;
      Returns:
      The balance.

    • getKycStatusValue

      int getKycStatusValue()
       *
 A KYC status for the account with respect to this token.
 <p>
 This may be `KycNotApplicable`, `Granted` or `Revoked` and, if KYC is
 not supported for this token (e.g. the `kyc_key` of the token is not
 set), this SHALL be `KycNotApplicable`.
      .proto.TokenKycStatus kycStatus = 4;
      Returns:
      The enum numeric value on the wire for kycStatus.

    • getKycStatus

      TokenKycStatus getKycStatus()
       *
 A KYC status for the account with respect to this token.
 <p>
 This may be `KycNotApplicable`, `Granted` or `Revoked` and, if KYC is
 not supported for this token (e.g. the `kyc_key` of the token is not
 set), this SHALL be `KycNotApplicable`.
      .proto.TokenKycStatus kycStatus = 4;
      Returns:
      The kycStatus.

    • getFreezeStatusValue

      int getFreezeStatusValue()
       *
 A Freeze status for the account with respect to this token.
 <p>
 This value SHALL be one of `FreezeNotApplicable`, `Frozen`
 or `Unfrozen`.<br/>
 If the token cannot freeze account assets (e.g. the `freeze_key` of the
 token is not set), this SHALL be `FreezeNotApplicable`.
      .proto.TokenFreezeStatus freezeStatus = 5;
      Returns:
      The enum numeric value on the wire for freezeStatus.

    • getFreezeStatus

      TokenFreezeStatus getFreezeStatus()
       *
 A Freeze status for the account with respect to this token.
 <p>
 This value SHALL be one of `FreezeNotApplicable`, `Frozen`
 or `Unfrozen`.<br/>
 If the token cannot freeze account assets (e.g. the `freeze_key` of the
 token is not set), this SHALL be `FreezeNotApplicable`.
      .proto.TokenFreezeStatus freezeStatus = 5;
      Returns:
      The freezeStatus.

    • getDecimals

      int getDecimals()
       *
 A maximum "precision" for this token.
 <p>
 This value MUST match the `decimals` field of the token identified in
 the `tokenId` field.<br/>
 A single whole token SHALL be divided into at most
 10<sup>`decimals`</sup> sub-units.
      uint32 decimals = 6;
      Returns:
      The decimals.

    • getAutomaticAssociation

      boolean getAutomaticAssociation()
       *
 An automatic association flag.
 <p>
 This SHALL be set if the relationship was created implicitly
 (automatically).<br/>
 This SHALL be unset if the relationship was created explicitly
 (manually) via a `TokenAssociate` transaction.
      bool automatic_association = 7;
      Returns:
      The automaticAssociation.