Package io.github.natanimn.telebof.requests.get

Class GetUserGifts

java.lang.Object
io.github.natanimn.telebof.requests.AbstractBaseRequest<GetUserGifts,OwnedGifts>
io.github.natanimn.telebof.requests.get.GetUserGifts
public class GetUserGifts extends AbstractBaseRequest<GetUserGifts,OwnedGifts>
GetUserGifts class. Returns OwnedGifts on success.
Since:
1.3.0

  • Constructor Details

    • GetUserGifts

      public GetUserGifts(long userId, Api api)
      Required
      Parameters:
      userId - user id
      api - api

  • Method Details

    • excludeUnlimited

      public GetUserGifts excludeUnlimited(Boolean excludeUnlimited)
      Optional
      Parameters:
      excludeUnlimited - Pass True to exclude gifts that can be purchased an unlimited number of times
      Returns:
      GetUserGifts

    • excludeLimitedUpgradable

      public GetUserGifts excludeLimitedUpgradable(Boolean excludeLimitedUpgradable)
      Optional
      Parameters:
      excludeLimitedUpgradable - Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
      Returns:
      GetUserGifts

    • excludeLimitedNonUpgradable

      public GetUserGifts excludeLimitedNonUpgradable(Boolean excludeLimitedNonUpgradable)
      Optional
      Parameters:
      excludeLimitedNonUpgradable - Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
      Returns:
      GetUserGifts

    • excludeFromBlockchain

      public GetUserGifts excludeFromBlockchain(Boolean excludeFromBlockchain)
      Optional
      Parameters:
      excludeFromBlockchain - Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
      Returns:
      GetUserGifts

    • excludeUnique

      public GetUserGifts excludeUnique(Boolean excludeUnique)
      Optional
      Parameters:
      excludeUnique - Pass True to exclude unique gifts
      Returns:
      GetUserGifts

    • sortByPrice

      public GetUserGifts sortByPrice(Boolean sortByPrice)
      Optional
      Parameters:
      sortByPrice - Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.
      Returns:
      GetUserGifts

    • offset

      public GetUserGifts offset(String offset)
      Optional
      Parameters:
      offset - Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
      Returns:
      GetUserGifts

    • limit

      public GetUserGifts limit(int limit)
      Optional
      Parameters:
      limit - The maximum number of gifts to be returned; 1-100. Defaults to 100
      Returns:
      GetUserGifts