Safe Haskell	Safe-Inferred
Language	Haskell2010

Telegram.Bot.API.Methods.SendPoll

Contents

sendPoll

Synopsis

data SendPollRequest = SendPollRequest {
- sendPollBusinessConnectionId :: Maybe BusinessConnectionId
- sendPollChatId :: SomeChatId
- sendPollMessageThreadId :: Maybe MessageThreadId
- sendPollQuestion :: Text
- sendPollQuestionParseMode :: Maybe ParseMode
- sendPollQuestionEntities :: Maybe [MessageEntity]
- sendPollOptions :: [InputPollOption]
- sendPollIsAnonymous :: Maybe Bool
- sendPollType :: Maybe Text
- sendPollAllowsMultipleAnswers :: Maybe Bool
- sendPollCorrectOptionId :: Maybe Int
- sendPollExplanation :: Maybe Text
- sendPollExplanationParseMode :: Maybe ParseMode
- sendPollExplanationEntities :: Maybe [MessageEntity]
- sendPollOpenPeriod :: Maybe Int
- sendPollCloseDate :: Maybe Int
- sendPollIsClosed :: Maybe Bool
- sendPollDisableNotification :: Maybe Bool
- sendPollProtectContent :: Maybe Bool
- sendPollMessageEffectId :: Maybe Text
- sendPollReplyToMessageId :: Maybe MessageId
- sendPollReplyParameters :: Maybe ReplyParameters
- sendPollReplyMarkup :: Maybe InlineKeyboardMarkup
}
type SendPoll = "sendPoll" :> (ReqBody '[JSON] SendPollRequest :> Post '[JSON] (Response Message))
sendPoll :: SendPollRequest -> ClientM (Response Message)
defSendPoll :: SomeChatId -> Text -> [InputPollOption] -> SendPollRequest

`sendPoll`

data SendPollRequest Source #

Request parameters for sendPoll.

Constructors

SendPollRequest

Fields

sendPollBusinessConnectionId :: Maybe BusinessConnectionId
Unique identifier of the business connection on behalf of which the message will be sent.
sendPollChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername).
sendPollMessageThreadId :: Maybe MessageThreadId
Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.
sendPollQuestion :: Text
Poll question, 1-300 characters.
sendPollQuestionParseMode :: Maybe ParseMode
Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed.
sendPollQuestionEntities :: Maybe [MessageEntity]
A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode.
sendPollOptions :: [InputPollOption]
A JSON-serialized list of answer options, 2-10 strings 1-100 characters each.
sendPollIsAnonymous :: Maybe Bool
True, if the poll needs to be anonymous, defaults to True.
sendPollType :: Maybe Text
Poll type, “quiz” or “regular”, defaults to “regular”.
sendPollAllowsMultipleAnswers :: Maybe Bool
True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False.
sendPollCorrectOptionId :: Maybe Int
0-based identifier of the correct answer option, required for polls in quiz mode.
sendPollExplanation :: Maybe Text
Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing.
sendPollExplanationParseMode :: Maybe ParseMode
Send MarkdownV2, HTML or Markdown (legacy), if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
sendPollExplanationEntities :: Maybe [MessageEntity]
A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode.
sendPollOpenPeriod :: Maybe Int
Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.
sendPollCloseDate :: Maybe Int
Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period.
sendPollIsClosed :: Maybe Bool
Pass True, if the poll needs to be immediately closed. This can be useful for poll preview.
sendPollDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendPollProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving.
sendPollMessageEffectId :: Maybe Text
Unique identifier of the message effect to be added to the message; for private chats only.
sendPollReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message.
sendPollReplyParameters :: Maybe ReplyParameters
Description of the message to reply to.
sendPollReplyMarkup :: 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

Instances details

FromJSON SendPollRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.SendPoll Methods parseJSON :: Value -> Parser SendPollRequest # parseJSONList :: Value -> Parser [SendPollRequest] # omittedField :: Maybe SendPollRequest #
ToJSON SendPollRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.SendPoll Methods toJSON :: SendPollRequest -> Value # toEncoding :: SendPollRequest -> Encoding # toJSONList :: [SendPollRequest] -> Value # toEncodingList :: [SendPollRequest] -> Encoding # omitField :: SendPollRequest -> Bool #
Generic SendPollRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.SendPoll Associated Types type Rep SendPollRequest :: Type -> Type # Methods from :: SendPollRequest -> Rep SendPollRequest x # to :: Rep SendPollRequest x -> SendPollRequest #
type Rep SendPollRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.SendPoll type Rep SendPollRequest = D1 ('MetaData "SendPollRequest" "Telegram.Bot.API.Methods.SendPoll" "telegram-bot-api-7.4.4-fdOK3VCUfTCfzXncfzYz7" 'False) (C1 ('MetaCons "SendPollRequest" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "sendPollBusinessConnectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BusinessConnectionId)) :: S1 ('MetaSel ('Just "sendPollChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId)) :: (S1 ('MetaSel ('Just "sendPollMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageThreadId)) :: (S1 ('MetaSel ('Just "sendPollQuestion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "sendPollQuestionParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode))))) :: ((S1 ('MetaSel ('Just "sendPollQuestionEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity])) :: (S1 ('MetaSel ('Just "sendPollOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [InputPollOption]) :: S1 ('MetaSel ('Just "sendPollIsAnonymous") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "sendPollType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sendPollAllowsMultipleAnswers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendPollCorrectOptionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))))) :: (((S1 ('MetaSel ('Just "sendPollExplanation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sendPollExplanationParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode)) :: S1 ('MetaSel ('Just "sendPollExplanationEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity])))) :: (S1 ('MetaSel ('Just "sendPollOpenPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "sendPollCloseDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "sendPollIsClosed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "sendPollDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "sendPollProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendPollMessageEffectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "sendPollReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :: (S1 ('MetaSel ('Just "sendPollReplyParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ReplyParameters)) :: S1 ('MetaSel ('Just "sendPollReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup))))))))

type SendPoll = "sendPoll" :> (ReqBody '[JSON] SendPollRequest :> Post '[JSON] (Response Message)) Source #

sendPoll :: SendPollRequest -> ClientM (Response Message) Source #

Use this method to send a native poll. On success, the sent Message is returned.

defSendPoll :: SomeChatId -> Text -> [InputPollOption] -> SendPollRequest Source #