Class GiveawayWinners

Hierarchy (view full)

Constructors

constructor

Properties

addChatCount? chat count description? messageId onlyNewMembers? refunded? selectionUnixTime starCount? subscriptionMonthCount? unclaimedPrizeCount? winners

Accessors

client selectionAt selectionTimestamp

Methods

[iterator] _clone _patch _update equals toJSON valueOf

Constructors

constructor

Properties

OptionaladdChatCount

addChatCount?: number

The number of other chats the user had to join in order to be eligible for the giveaway

chat

chat: Chat

The chat that created the giveaway

count

count: number

Total number of winners in the giveaway

Optionaldescription

description?: string

Description of additional giveaway prize

messageId

messageId: string

Identifier of the messsage with the giveaway in the chat

OptionalonlyNewMembers

onlyNewMembers?: boolean

True, if only users who had joined the chats after the giveaway started were eligible to win

Optionalrefunded

refunded?: true

True, if the giveaway was canceled because the payment for it was refunded

selectionUnixTime

selectionUnixTime: number

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

OptionalstarCount

starCount?: number

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

OptionalsubscriptionMonthCount

subscriptionMonthCount?: number

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

OptionalunclaimedPrizeCount

unclaimedPrizeCount?: number

Number of undistributed prizes

winners

winners: Collection<string, User>

List of up to 100 winners of the giveaway

Accessors

client

selectionAt

  • get selectionAt(): Date

  • Point in time when winners of the giveaway were selected

    Returns Date

selectionTimestamp

  • get selectionTimestamp(): number

  • Return the timestamp winners of the giveaway were selected, in milliseconds

    Returns number

Methods

[iterator]

  • [iterator](): IterableIterator<User>

  • Makes the class iterable, returning each User object.

    Returns IterableIterator<User>

Protected_clone

  • _clone(): Base
  • Protected

    Creates a clone of the current instance

    Returns Base

    A clone of the current instance

_patch

  • _patch(data): GiveawayWinners

  • Parameters

    • data: GiveawayWinners

      Data about the represents a message about the completion of a giveaway with public winners

    Returns GiveawayWinners

Protected_update

  • _update(data): Base
  • Protected

    Updates the current instance with new data and returns a clone of the updated instance

    Parameters

    • data: Record<string, any>

      The data to update the instance with

    Returns Base

    A clone of the updated instance

equals

  • equals(other): boolean

  • Checks if this giveaway winners object is equal to another giveaway winners object.

    Parameters

    Returns boolean

    True if both objects are instances of GiveawayWinners and are equal based on key properties, otherwise false.

toJSON

  • toJSON(propsRecursive?, ...props): Record<string, any>

  • Flatten an object. Any properties that are collections will get converted to an array of keys.

    Parameters

    • OptionalpropsRecursive: boolean

      Optional. If true, calls toJSON method on nested objects.

    • Rest...props: Record<string, string | boolean>[]

      Optional. Specific properties to include/exclude, or rename.

    Returns Record<string, any>

    Flattened object.

valueOf

  • valueOf(): null | string

  • Returns the id instance Chat, User, ChatMember and other

    Returns null | string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods