Safe Haskell	Safe-Inferred
Language	GHC2021

TD.Query.SendGift

Synopsis

Documentation

Sends a gift to another user. May return an error with a message STARGIFT_USAGE_LIMITED if the gift was sold out. Returns Ok

Constructors

Fields

gift_id :: Maybe Int
Identifier of the gift to send
user_id :: Maybe Int
Identifier of the user that will receive the gift
text :: Maybe FormattedText
Text to show along with the gift; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities are allowed
is_private :: Maybe Bool
Pass true to show the current user as sender and gift text only to the gift receiver; otherwise, everyone will be able to see them
pay_for_upgrade :: Maybe Bool
Pass true to additionally pay for the gift upgrade and allow the receiver to upgrade it for free

Instances details

ToJSON SendGift Source #
Instance details Defined in TD.Query.SendGift Methods toJSON :: SendGift -> Value # toEncoding :: SendGift -> Encoding # toJSONList :: [SendGift] -> Value # toEncodingList :: [SendGift] -> Encoding #
Show SendGift Source #
Instance details Defined in TD.Query.SendGift Methods showsPrec :: Int -> SendGift -> ShowS # show :: SendGift -> String # showList :: [SendGift] -> ShowS #
Eq SendGift Source #
Instance details Defined in TD.Query.SendGift Methods (==) :: SendGift -> SendGift -> Bool # (/=) :: SendGift -> SendGift -> Bool #
ShortShow SendGift Source #
Instance details Defined in TD.Query.SendGift Methods shortShow :: SendGift -> String Source #