Record Class GetUserGifts

java.lang.Object
java.lang.Record
org.teleight.teleightbots.api.methods.GetUserGifts
All Implemented Interfaces:
ApiMethod<OwnedGifts>
public record GetUserGifts(long userId, boolean excludeUnlimited, boolean excludeLimitedUpgradable, boolean excludeLimitedNonUpgradable, boolean excludeFromBlockchain, boolean excludeUnique, boolean sortByPrice, String offset, @IntRange(from=1L,to=100L) int limit) extends Record implements ApiMethod<OwnedGifts>

  • Constructor Details

    • GetUserGifts

      public GetUserGifts(long userId, boolean excludeUnlimited, boolean excludeLimitedUpgradable, boolean excludeLimitedNonUpgradable, boolean excludeFromBlockchain, boolean excludeUnique, boolean sortByPrice, String offset, @IntRange(from=1L,to=100L) int limit)
      Creates an instance of a GetUserGifts record class.
      Parameters:
      userId - the value for the userId record component
      excludeUnlimited - the value for the excludeUnlimited record component
      excludeLimitedUpgradable - the value for the excludeLimitedUpgradable record component
      excludeLimitedNonUpgradable - the value for the excludeLimitedNonUpgradable record component
      excludeFromBlockchain - the value for the excludeFromBlockchain record component
      excludeUnique - the value for the excludeUnique record component
      sortByPrice - the value for the sortByPrice record component
      offset - the value for the offset record component
      limit - the value for the limit record component

  • Method Details

    • ofBuilder

      @NotNull public static @NotNull GetUserGifts.Builder ofBuilder(long userId)

    • getEndpointURL

      @NotNull public @NotNull String getEndpointURL()
      Description copied from interface: ApiMethod
      Returns the endpoint URL for the Telegram Bot API method.
      Specified by:
      getEndpointURL in interface ApiMethod<OwnedGifts>
      Returns:
      the endpoint URL

    • deserializeResponse

      @NotNull public @NotNull OwnedGifts deserializeResponse(@NotNull @NotNull String answer) throws TelegramRequestException
      Description copied from interface: ApiMethod
      Deserializes the response from the Telegram Bot API.
      Specified by:
      deserializeResponse in interface ApiMethod<OwnedGifts>
      Parameters:
      answer - the response from the Telegram Bot API
      Returns:
      the deserialized response
      Throws:
      TelegramRequestException - if an error occurs while deserializing the response

    • toBuilder

      public GetUserGifts.Builder toBuilder()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • userId

      public long userId()
      Returns the value of the userId record component.
      Returns:
      the value of the userId record component

    • excludeUnlimited

      public boolean excludeUnlimited()
      Returns the value of the excludeUnlimited record component.
      Returns:
      the value of the excludeUnlimited record component

    • excludeLimitedUpgradable

      public boolean excludeLimitedUpgradable()
      Returns the value of the excludeLimitedUpgradable record component.
      Returns:
      the value of the excludeLimitedUpgradable record component

    • excludeLimitedNonUpgradable

      public boolean excludeLimitedNonUpgradable()
      Returns the value of the excludeLimitedNonUpgradable record component.
      Returns:
      the value of the excludeLimitedNonUpgradable record component

    • excludeFromBlockchain

      public boolean excludeFromBlockchain()
      Returns the value of the excludeFromBlockchain record component.
      Returns:
      the value of the excludeFromBlockchain record component

    • excludeUnique

      public boolean excludeUnique()
      Returns the value of the excludeUnique record component.
      Returns:
      the value of the excludeUnique record component

    • sortByPrice

      public boolean sortByPrice()
      Returns the value of the sortByPrice record component.
      Returns:
      the value of the sortByPrice record component

    • offset

      public String offset()
      Returns the value of the offset record component.
      Returns:
      the value of the offset record component

    • limit

      public @IntRange(from=1L,to=100L) int limit()
      Returns the value of the limit record component.
      Returns:
      the value of the limit record component