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

Class GrantedTokenAllowance

java.lang.Object
com.google.protobuf.AbstractMessageLite<GrantedTokenAllowance,GrantedTokenAllowance.Builder>
com.google.protobuf.GeneratedMessageLite<GrantedTokenAllowance,GrantedTokenAllowance.Builder>
com.hedera.hashgraph.sdk.proto.GrantedTokenAllowance
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, GrantedTokenAllowanceOrBuilder
@Generated public final class GrantedTokenAllowance extends com.google.protobuf.GeneratedMessageLite<GrantedTokenAllowance,GrantedTokenAllowance.Builder> implements GrantedTokenAllowanceOrBuilder
 *
 Permission granted by one account (the "funding" account) to another
 account (the "spender" account) that allows the spender to spend a
 specified amount of a specific non-HBAR fungible token from the
 balance owned by the funding account.

 An allowance SHALL NOT transfer any tokens directly, it only permits
 transactions signed only by the spender account to transfer tokens
 of the specified type, up to the amount specified, from the funding account.

 Once the specified amount is spent, the allowance SHALL be consumed
 and a new allowance SHALL be required before that spending account
 may spend additional tokens from the funding account.
Protobuf type proto.GrantedTokenAllowance

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    GrantedTokenAllowance.Builder
    * Permission granted by one account (the "funding" account) to another account (the "spender" account) that allows the spender to spend a specified amount of a specific non-HBAR fungible token from the balance owned by the funding account.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AMOUNT_FIELD_NUMBER
     
    static final int
    SPENDER_FIELD_NUMBER
     
    static final int
    TOKEN_ID_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    long
    getAmount()
    The maximum amount that the spender account may transfer within the scope of this allowance.
    static GrantedTokenAllowance
    getDefaultInstance()
     
    AccountID
    getSpender()
    * The identifier for the spending account associated with this allowance.
    TokenID
    getTokenId()
    * The identifier for the token associated with this allowance.
    boolean
    hasSpender()
    * The identifier for the spending account associated with this allowance.
    boolean
    hasTokenId()
    * The identifier for the token associated with this allowance.
    static GrantedTokenAllowance.Builder
    newBuilder()
     
    static GrantedTokenAllowance.Builder
    newBuilder(GrantedTokenAllowance prototype)
     
    static GrantedTokenAllowance
    parseDelimitedFrom(InputStream input)
     
    static GrantedTokenAllowance
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GrantedTokenAllowance
    parseFrom(byte[] data)
     
    static GrantedTokenAllowance
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GrantedTokenAllowance
    parseFrom(com.google.protobuf.ByteString data)
     
    static GrantedTokenAllowance
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GrantedTokenAllowance
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static GrantedTokenAllowance
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GrantedTokenAllowance
    parseFrom(InputStream input)
     
    static GrantedTokenAllowance
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GrantedTokenAllowance
    parseFrom(ByteBuffer data)
     
    static GrantedTokenAllowance
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<GrantedTokenAllowance>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

  • Method Details

    • hasTokenId

      public boolean hasTokenId()
       *
 The identifier for the token associated with this allowance.
 <p>
 This token MUST be a fungible/common token.
      .proto.TokenID token_id = 1;
      Specified by:
      hasTokenId in interface GrantedTokenAllowanceOrBuilder
      Returns:
      Whether the tokenId field is set.

    • getTokenId

      public TokenID getTokenId()
       *
 The identifier for the token associated with this allowance.
 <p>
 This token MUST be a fungible/common token.
      .proto.TokenID token_id = 1;
      Specified by:
      getTokenId in interface GrantedTokenAllowanceOrBuilder
      Returns:
      The tokenId.

    • hasSpender

      public boolean hasSpender()
       *
 The identifier for the spending account associated with this allowance.
 <p>
 This account SHALL be permitted to sign transactions to spend tokens
 of the associated token type from the funding/allowing account.<br/>
 This permission SHALL be limited to no more than the specified `amount`.
      .proto.AccountID spender = 2;
      Specified by:
      hasSpender in interface GrantedTokenAllowanceOrBuilder
      Returns:
      Whether the spender field is set.

    • getSpender

      public AccountID getSpender()
       *
 The identifier for the spending account associated with this allowance.
 <p>
 This account SHALL be permitted to sign transactions to spend tokens
 of the associated token type from the funding/allowing account.<br/>
 This permission SHALL be limited to no more than the specified `amount`.
      .proto.AccountID spender = 2;
      Specified by:
      getSpender in interface GrantedTokenAllowanceOrBuilder
      Returns:
      The spender.

    • getAmount

      public long getAmount()
      
 The maximum amount that the spender account may transfer within
 the scope of this allowance.
 <p>
 This allowance SHALL be consumed if any combination of transfers
 authorized via this allowance meet this value in total.<br/>
 This value MUST be specified in the smallest units of the relevant
 token (i.e. 10<sup>-decimals</sup> whole tokens).
      int64 amount = 3;
      Specified by:
      getAmount in interface GrantedTokenAllowanceOrBuilder
      Returns:
      The amount.

    • parseFrom

      public static GrantedTokenAllowance parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrantedTokenAllowance parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrantedTokenAllowance parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrantedTokenAllowance parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrantedTokenAllowance parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrantedTokenAllowance parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrantedTokenAllowance parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GrantedTokenAllowance parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GrantedTokenAllowance parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GrantedTokenAllowance parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GrantedTokenAllowance parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GrantedTokenAllowance parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static GrantedTokenAllowance.Builder newBuilder()

    • newBuilder

      public static GrantedTokenAllowance.Builder newBuilder(GrantedTokenAllowance prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<GrantedTokenAllowance,GrantedTokenAllowance.Builder>

    • getDefaultInstance

      public static GrantedTokenAllowance getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<GrantedTokenAllowance> parser()