telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Interface GetChatGiftsOptions

    Options for Bot.getChatGifts.

    interface GetChatGiftsOptions {
        exclude_from_blockchain?: boolean;
        exclude_limited_non_upgradable?: boolean;
        exclude_limited_upgradable?: boolean;
        exclude_saved?: boolean;
        exclude_unique?: boolean;
        exclude_unlimited?: boolean;
        exclude_unsaved?: boolean;
        limit?: number;
        offset?: string;
        sort_by_price?: boolean;
    }

    Hierarchy (View Summary)

    Index
    exclude_from_blockchain? exclude_limited_non_upgradable? exclude_limited_upgradable? exclude_saved? exclude_unique? exclude_unlimited? exclude_unsaved? limit? offset? sort_by_price?
    exclude_from_blockchain?: boolean

    Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram.

    exclude_limited_non_upgradable?: boolean

    Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique.

    exclude_limited_upgradable?: boolean

    Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique.

    exclude_saved?: boolean

    Pass True to exclude gifts that are saved to the chat's profile page.

    exclude_unique?: boolean

    Pass True to exclude unique gifts.

    exclude_unlimited?: boolean

    Pass True to exclude gifts that can be purchased an unlimited number of times.

    exclude_unsaved?: boolean

    Pass True to exclude gifts that aren't saved to the chat's profile page.

    limit?: number

    The maximum number of gifts to be returned; 1-100.

    offset?: string

    Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results.

    sort_by_price?: boolean

    Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.

    Settings
    Member Visibility

    On This Page
    Properties