Class UserStarGift

constructor

• new UserStarGift(raw: RawUserStarGift, peers: PeersIndex): UserStarGift

• Parameters

  • raw: RawUserStarGift
  • peers: PeersIndex

  Returns UserStarGift

Readonlypeers

Readonlyraw

canExportAt

• get canExportAt(): null | Date

• Returns null | Date

canUpgrade

• get canUpgrade(): boolean

• Whether the gift can be upgraded to a unique gift

  Returns boolean

convertStars

• get convertStars(): null | Long

• If the gift was converted to stars, the amount of stars it was converted to

  Returns null | Long

date

• get date(): Date

• Date the gift was sent or minted

  Returns Date

gift

• get gift(): StarGiftUnique | StarGift

• The gift itself

  Returns StarGiftUnique | StarGift

hidden

• get hidden(): boolean

• Whether this gift is not visible on the recipient's profile

  Returns boolean

isRefunded

• get isRefunded(): boolean

• Returns boolean

messageId

• get messageId(): null | number

• Message ID where the gift was sent, if available

  Returns null | number

nameHidden

• get nameHidden(): boolean

• Whether the sender chose to appear anonymously

  Returns boolean

sender

• get sender(): null | User

• Sender of the gift, if available

  Returns null | User

text

• get text(): null | TextWithEntities

• Text attached to the gift

  Returns null | TextWithEntities

transferStars

• get transferStars(): null | Long

• Number of stars this gift can be transferred for

  Returns null | Long

upgradeStars

• get upgradeStars(): null | Long

• Number of stars to upgrade the gift to a unique gift (may be 0)

  Returns null | Long