Telegram.Bot.API.Methods.SendDice

sendDice

data SendDiceRequest

Request parameters for sendDice.

Constructors

SendDiceRequest

Fields

• sendDiceChatId :: SomeChatId

  Unique identifier for the target chat or username of the target channel (in the format @channelusername).

• sendDiceMessageThreadId :: Maybe MessageThreadId

  Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

• sendDiceEmoji :: Maybe Text

  Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. Dice can have values 1-6 for “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲”

• sendDiceDisableNotification :: Maybe Bool

  Sends the message silently. Users will receive a notification with no sound.

• sendDiceProtectContent :: Maybe Bool

  Protects the contents of the sent message from forwarding

• sendDiceReplyToMessageId :: Maybe MessageId

  If the message is a reply, ID of the original message

• sendDiceAllowSendingWithoutReply :: Maybe Bool

  Pass True, if the message should be sent even if the specified replied-to message is not found

• sendDiceReplyMarkup :: Maybe InlineKeyboardMarkup

  Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Instances

FromJSON SendDiceRequest

Defined in Telegram.Bot.API.Methods.SendDice

Methods

parseJSON :: Value -> Parser SendDiceRequest

parseJSONList :: Value -> Parser [SendDiceRequest]

ToJSON SendDiceRequest

Defined in Telegram.Bot.API.Methods.SendDice

Methods

toJSON :: SendDiceRequest -> Value

toEncoding :: SendDiceRequest -> Encoding

toJSONList :: [SendDiceRequest] -> Value

toEncodingList :: [SendDiceRequest] -> Encoding

Generic SendDiceRequest

Defined in Telegram.Bot.API.Methods.SendDice

Associated Types

type Rep SendDiceRequest :: Type -> Type

Methods

from :: SendDiceRequest -> Rep SendDiceRequest x

to :: Rep SendDiceRequest x -> SendDiceRequest

type Rep SendDiceRequest

Defined in Telegram.Bot.API.Methods.SendDice

type Rep SendDiceRequest = D1 ('MetaData "SendDiceRequest" "Telegram.Bot.API.Methods.SendDice" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "SendDiceRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendDiceChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "sendDiceMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageThreadId))) :*: (S1 ('MetaSel ('Just "sendDiceEmoji") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sendDiceDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "sendDiceProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendDiceReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :*: (S1 ('MetaSel ('Just "sendDiceAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendDiceReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup))))))

type SendDice = "sendDice" :> (ReqBody '[JSON] SendDiceRequest :> Post '[JSON] (Response Message))

sendDice :: SendDiceRequest -> ClientM (Response Message)

Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.