telegram-bot-api-7.0: Easy to use library for building Telegram bots. Exports Telegram Bot API.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Telegram.Bot.API.Types.LoginUrl

Contents

Synopsis

LoginUrl

data LoginUrl Source #

This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:

https://core.telegram.org/file/811140015/1734/8VZFkwWXalM.97872/6127fa62d8a0bf2b3c

Telegram apps support these buttons as of version 5.7.

Constructors

LoginUrl 

Fields

  • loginUrlUrl :: Text

    An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.

    • *NOTE**: You **must** always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization.
  • loginUrlForwardText :: Maybe Text

    New text of the button in forwarded messages.

  • loginUrlBotUsername :: Maybe Text

    Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.

  • loginUrlRequestWriteAccess :: Maybe Bool

    Pass True to request the permission for your bot to send messages to the user.

Instances

Instances details
FromJSON LoginUrl Source # 
Instance details

Defined in Telegram.Bot.API.Types.LoginUrl

Methods

parseJSON :: Value -> Parser LoginUrl #

parseJSONList :: Value -> Parser [LoginUrl] #

omittedField :: Maybe LoginUrl #

ToJSON LoginUrl Source # 
Instance details

Defined in Telegram.Bot.API.Types.LoginUrl

Methods

toJSON :: LoginUrl -> Value #

toEncoding :: LoginUrl -> Encoding #

toJSONList :: [LoginUrl] -> Value #

toEncodingList :: [LoginUrl] -> Encoding #

omitField :: LoginUrl -> Bool #

Generic LoginUrl Source # 
Instance details

Defined in Telegram.Bot.API.Types.LoginUrl

Associated Types

type Rep LoginUrl :: Type -> Type #

Methods

from :: LoginUrl -> Rep LoginUrl x #

to :: Rep LoginUrl x -> LoginUrl #

Show LoginUrl Source # 
Instance details

Defined in Telegram.Bot.API.Types.LoginUrl

Methods

showsPrec :: Int -> LoginUrl -> ShowS #

show :: LoginUrl -> String #

showList :: [LoginUrl] -> ShowS #

type Rep LoginUrl Source # 
Instance details

Defined in Telegram.Bot.API.Types.LoginUrl

type Rep LoginUrl = D1 ('MetaData "LoginUrl" "Telegram.Bot.API.Types.LoginUrl" "telegram-bot-api-7.0-2XShkJeCLX71W7OKNKemWZ" 'False) (C1 ('MetaCons "LoginUrl" 'PrefixI 'True) ((S1 ('MetaSel ('Just "loginUrlUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "loginUrlForwardText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "loginUrlBotUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "loginUrlRequestWriteAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))