getClaimedGifts
Get gifts claimed by a user or a channel. USER-ONLY
Parameters
The identifier of a user or a channel to get gifts for.
collectionId?: number
The identifier of a gift collection. If provided, only gifts inside it will be fetched.
isHostedExcluded?: boolean
Whether to exclude hosted gifts.
isUnupgradableExcluded?: boolean
Whether to exclude unupgradable gifts.
isUpgradableExcluded?: boolean
Whether to exclude upgradable gifts.
isSortedByValue?: number
Whether to sort gifts by value.
isUniqueExcluded?: boolean
Whether to exclude unique gifts.
isUnlimitedExcluded?: boolean
Whether to exclude unlimited gifts.
isSavedExcluded?: boolean
Whether to exclude saved gifts.
isUnsavedExcluded?: boolean
Whether to exclude unsaved gifts.
isWithColors?: boolean
Whether to get gifts with colors.
offset?: string
An offset key returned by a previous result.
limit?: number
The maximum number of results to return.
Result
Syntax
// Required parameters only.
await client.getClaimedGifts(chatId);
// Required parameters + optional parameters.
// Any of the optional parameters can be omitted.
await client.getClaimedGifts(chatId, {
collectionId,
isHostedExcluded,
isUnupgradableExcluded,
isUpgradableExcluded,
isSortedByValue,
isUniqueExcluded,
isUnlimitedExcluded,
isSavedExcluded,
isUnsavedExcluded,
isWithColors,
offset,
limit,
});