Safe Haskell	Safe-Inferred
Language	GHC2021

TD.Data.KeyboardButtonType

Synopsis

data KeyboardButtonType
- = KeyboardButtonTypeText
- | KeyboardButtonTypeRequestPhoneNumber
- | KeyboardButtonTypeRequestLocation
- | KeyboardButtonTypeRequestPoll {
  - force_regular :: Maybe Bool
  - force_quiz :: Maybe Bool
  }
- | KeyboardButtonTypeRequestUsers {
  - _id :: Maybe Int
  - restrict_user_is_bot :: Maybe Bool
  - user_is_bot :: Maybe Bool
  - restrict_user_is_premium :: Maybe Bool
  - user_is_premium :: Maybe Bool
  - max_quantity :: Maybe Int
  - request_name :: Maybe Bool
  - request_username :: Maybe Bool
  - request_photo :: Maybe Bool
  }
- | KeyboardButtonTypeRequestChat {
  - _id :: Maybe Int
  - chat_is_channel :: Maybe Bool
  - restrict_chat_is_forum :: Maybe Bool
  - chat_is_forum :: Maybe Bool
  - restrict_chat_has_username :: Maybe Bool
  - chat_has_username :: Maybe Bool
  - chat_is_created :: Maybe Bool
  - user_administrator_rights :: Maybe ChatAdministratorRights
  - bot_administrator_rights :: Maybe ChatAdministratorRights
  - bot_is_member :: Maybe Bool
  - request_title :: Maybe Bool
  - request_username :: Maybe Bool
  - request_photo :: Maybe Bool
  }
- | KeyboardButtonTypeWebApp {
  - url :: Maybe Text
  }

Documentation

data KeyboardButtonType Source #

Describes a keyboard button type

Constructors

KeyboardButtonTypeText	A simple button, with text that must be sent when the button is pressed
KeyboardButtonTypeRequestPhoneNumber	A button that sends the user's phone number when pressed; available only in private chats
KeyboardButtonTypeRequestLocation	A button that sends the user's location when pressed; available only in private chats
KeyboardButtonTypeRequestPoll	A button that allows the user to create and send a poll when pressed; available only in private chats
Fields force_regular :: Maybe Bool If true, only regular polls must be allowed to create force_quiz :: Maybe Bool If true, only polls in quiz mode must be allowed to create
KeyboardButtonTypeRequestUsers	A button that requests users to be shared by the current user; available only in private chats. Use the method shareUsersWithBot to complete the request
Fields _id :: Maybe Int Unique button identifier restrict_user_is_bot :: Maybe Bool True, if the shared users must or must not be bots user_is_bot :: Maybe Bool True, if the shared users must be bots; otherwise, the shared users must not be bots. Ignored if restrict_user_is_bot is false restrict_user_is_premium :: Maybe Bool True, if the shared users must or must not be Telegram Premium users user_is_premium :: Maybe Bool True, if the shared users must be Telegram Premium users; otherwise, the shared users must not be Telegram Premium users. Ignored if restrict_user_is_premium is false max_quantity :: Maybe Int The maximum number of users to share request_name :: Maybe Bool Pass true to request name of the users; bots only request_username :: Maybe Bool Pass true to request username of the users; bots only request_photo :: Maybe Bool Pass true to request photo of the users; bots only
KeyboardButtonTypeRequestChat	A button that requests a chat to be shared by the current user; available only in private chats. Use the method shareChatWithBot to complete the request
Fields _id :: Maybe Int Unique button identifier chat_is_channel :: Maybe Bool True, if the chat must be a channel; otherwise, a basic group or a supergroup chat is shared restrict_chat_is_forum :: Maybe Bool True, if the chat must or must not be a forum supergroup chat_is_forum :: Maybe Bool True, if the chat must be a forum supergroup; otherwise, the chat must not be a forum supergroup. Ignored if restrict_chat_is_forum is false restrict_chat_has_username :: Maybe Bool True, if the chat must or must not have a username chat_has_username :: Maybe Bool True, if the chat must have a username; otherwise, the chat must not have a username. Ignored if restrict_chat_has_username is false chat_is_created :: Maybe Bool True, if the chat must be created by the current user user_administrator_rights :: Maybe ChatAdministratorRights Expected user administrator rights in the chat; may be null if they aren't restricted bot_administrator_rights :: Maybe ChatAdministratorRights Expected bot administrator rights in the chat; may be null if they aren't restricted bot_is_member :: Maybe Bool True, if the bot must be a member of the chat; for basic group and supergroup chats only request_title :: Maybe Bool Pass true to request title of the chat; bots only request_username :: Maybe Bool Pass true to request username of the users; bots only request_photo :: Maybe Bool Pass true to request photo of the users; bots only
KeyboardButtonTypeWebApp	A button that opens a Web App by calling getWebAppUrl
Fields url :: Maybe Text An HTTP URL to pass to getWebAppUrl

Instances

Instances details

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