Module

x/grammy/types.ts>Giveaway

The Telegram Bot Framework.
grammyjs/grammY
Very Popular
Latest
interface Giveaway
import { type Giveaway } from "https://dotland.deno.dev/x/grammy@v1.31.0/types.ts";

This object represents a message about a scheduled giveaway.

Properties

chats: Chat[]

The list of chats which the user must join to participate in the giveaway

winners_selection_date: number

Point in time (Unix timestamp) when winners of the giveaway will be selected

winner_count: number

The number of users which are supposed to be selected as winners of the giveaway

optional
only_new_members: true

True, if only users who join the chats after the giveaway started should be eligible to win

optional
has_public_winners: true

True, if the list of giveaway winners will be visible to everyone

optional
prize_description: string

Description of additional giveaway prize

optional
country_codes: string[]

A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.

optional
prize_star_count: number

The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only

optional
premium_subscription_month_count: number

The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only