Telegram.Bot.API.Types.KeyboardButton

KeyboardButton

data KeyboardButton

This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields are mutually exclusive.

Constructors

KeyboardButton

Fields

• keyboardButtonText :: Text

  Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed.

• keyboardButtonRequestUser :: Maybe KeyboardButtonRequestUser

  If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a “user_shared” service message. Available in private chats only.

• keyboardButtonRequestChat :: Maybe KeyboardButtonRequestChat

  If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only.

• keyboardButtonRequestContact :: Maybe Bool

  If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.

• keyboardButtonRequestLocation :: Maybe Bool

  If True, the user's current location will be sent when the button is pressed. Available in private chats only.

• keyboardButtonRequestPoll :: Maybe PollType

  If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

• keyboardButtonWebApp :: Maybe WebAppInfo

  If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.

Instances

Show KeyboardButton

Defined in Telegram.Bot.API.Types.KeyboardButton

Methods

showsPrec :: Int -> KeyboardButton -> ShowS

show :: KeyboardButton -> String

showList :: [KeyboardButton] -> ShowS

IsString KeyboardButton

Defined in Telegram.Bot.API.Types.KeyboardButton

Methods

fromString :: String -> KeyboardButton

Generic KeyboardButton

Defined in Telegram.Bot.API.Types.KeyboardButton

Associated Types

type Rep KeyboardButton :: Type -> Type

Methods

from :: KeyboardButton -> Rep KeyboardButton x

to :: Rep KeyboardButton x -> KeyboardButton

FromJSON KeyboardButton

Defined in Telegram.Bot.API.Types.KeyboardButton

Methods

parseJSON :: Value -> Parser KeyboardButton

parseJSONList :: Value -> Parser [KeyboardButton]

ToJSON KeyboardButton

Defined in Telegram.Bot.API.Types.KeyboardButton

Methods

toJSON :: KeyboardButton -> Value

toEncoding :: KeyboardButton -> Encoding

toJSONList :: [KeyboardButton] -> Value

toEncodingList :: [KeyboardButton] -> Encoding

type Rep KeyboardButton

Defined in Telegram.Bot.API.Types.KeyboardButton

type Rep KeyboardButton = D1 ('MetaData "KeyboardButton" "Telegram.Bot.API.Types.KeyboardButton" "telegram-bot-api-6.5-inplace" 'False) (C1 ('MetaCons "KeyboardButton" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyboardButtonText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "keyboardButtonRequestUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe KeyboardButtonRequestUser)) :*: S1 ('MetaSel ('Just "keyboardButtonRequestChat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe KeyboardButtonRequestChat)))) :*: ((S1 ('MetaSel ('Just "keyboardButtonRequestContact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "keyboardButtonRequestLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "keyboardButtonRequestPoll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PollType)) :*: S1 ('MetaSel ('Just "keyboardButtonWebApp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe WebAppInfo))))))