Documentation - v0.27.1
    Preparing search index...

    Function getSavedStarGifts

    • Get a list of saved star gifts of a user/channel

      Note that filters currently only work for channels

      Parameters

      • client: ITelegramClient
      • params: {
            collectionId?: number;
            excludeHidden?: boolean;
            excludeHosted?: boolean;
            excludePublic?: boolean;
            excludeUnique?: boolean;
            excludeUnlimited?: boolean;
            excludeUnupgradable?: boolean;
            excludeUpgradable?: boolean;
            limit?: number;
            offset?: string;
            owner: InputPeerLike;
            peerColorAvailable?: boolean;
            sortByValue?: boolean;
        }
        • OptionalcollectionId?: number

          ID of the collection to get gifts from

        • OptionalexcludeHidden?: boolean

          Whether to exclude hidden gifts

        • OptionalexcludeHosted?: boolean

          Whether to exclude "hosted" gifts (i.e. those that are actually stored on the TON blockchain)

        • OptionalexcludePublic?: boolean

          Whether to exclude publicly visible gifts

        • OptionalexcludeUnique?: boolean

          Whether to exclude unique gifts

        • OptionalexcludeUnlimited?: boolean

          Whether to exclude gifts with unlimited availability

        • OptionalexcludeUnupgradable?: boolean

          Whether to exclude gifts that cannot be upgraded (either not limited or already upgraded)

        • OptionalexcludeUpgradable?: boolean

          Whether to exclude gifts that can be upgraded

        • Optionallimit?: number

          Limit for pagination

        • Optionaloffset?: string

          Offset for pagination

        • owner: InputPeerLike

          Peer to get saved gifts from

        • OptionalpeerColorAvailable?: boolean

          Whether to only return gifts with peer color available

        • OptionalsortByValue?: boolean

          Whether to sort by value

      Returns Promise<ArrayPaginated<SavedStarGift, string>>