Safe Haskell	None
Language	Haskell2010

Telegram.Bot.API.Methods

Contents

Available methods

Synopsis

type GetMe = "getMe" :> Get '[JSON] (Response User)
getMe :: ClientM (Response User)
type DeleteMessage = "deleteMessage" :> (RequiredQueryParam "chat_id" ChatId :> (RequiredQueryParam "message_id" MessageId :> Get '[JSON] (Response Bool)))
deleteMessage :: ChatId -> MessageId -> ClientM (Response Bool)
type SendMessage = "sendMessage" :> (ReqBody '[JSON] SendMessageRequest :> Post '[JSON] (Response Message))
sendMessage :: SendMessageRequest -> ClientM (Response Message)
type ForwardMessage = "forwardMessage" :> (ReqBody '[JSON] ForwardMessageRequest :> Post '[JSON] (Response Message))
forwardMessage :: ForwardMessageRequest -> ClientM (Response Message)
data SomeReplyMarkup
- = SomeInlineKeyboardMarkup InlineKeyboardMarkup
- | SomeReplyKeyboardMarkup ReplyKeyboardMarkup
- | SomeReplyKeyboardRemove ReplyKeyboardRemove
- | SomeForceReply ForceReply
data ParseMode
- = Markdown
- | HTML
- | MarkdownV2
data SendMessageRequest = SendMessageRequest {
- sendMessageChatId :: SomeChatId
- sendMessageText :: Text
- sendMessageParseMode :: Maybe ParseMode
- sendMessageEntities :: Maybe [MessageEntity]
- sendMessageDisableWebPagePreview :: Maybe Bool
- sendMessageDisableNotification :: Maybe Bool
- sendMessageProtectContent :: Maybe Bool
- sendMessageReplyToMessageId :: Maybe MessageId
- sendMessageAllowSendingWithoutReply :: Maybe Bool
- sendMessageReplyMarkup :: Maybe SomeReplyMarkup
}
data ForwardMessageRequest = ForwardMessageRequest {
- forwardMessageChatId :: SomeChatId
- forwardMessageFromChatId :: SomeChatId
- forwardMessageDisableNotification :: Maybe Bool
- forwardMessageProtectContent :: Maybe Bool
- forwardMessageMessageId :: MessageId
}
type SendDocumentContent = "sendDocument" :> (MultipartForm Tmp SendDocumentRequest :> Post '[JSON] (Response Message))
type SendDocumentLink = "sendDocument" :> (ReqBody '[JSON] SendDocumentRequest :> Post '[JSON] (Response Message))
sendDocument :: SendDocumentRequest -> ClientM (Response Message)
data SendDocumentRequest = SendDocumentRequest {
- sendDocumentChatId :: SomeChatId
- sendDocumentDocument :: DocumentFile
- sendDocumentThumb :: Maybe FilePath
- sendDocumentCaption :: Maybe Text
- sendDocumentParseMode :: Maybe ParseMode
- sendDocumentCaptionEntities :: Maybe [MessageEntity]
- sendDocumentDisableContentTypeDetection :: Maybe Bool
- sendDocumentDisableNotification :: Maybe Bool
- sendDocumentProtectContent :: Maybe Bool
- sendDocumentReplyToMessageId :: Maybe MessageId
- sendDocumentAllowSendingWithoutReply :: Maybe Bool
- sendDocumentReplyMarkup :: Maybe SomeReplyMarkup
}
newtype DocumentFile = MakeDocumentFile InputFile
pattern DocumentFileId :: FileId -> DocumentFile
pattern DocumentUrl :: Text -> DocumentFile
pattern DocumentFile :: FilePath -> ContentType -> DocumentFile
toSendDocument :: SomeChatId -> DocumentFile -> SendDocumentRequest
type GetFile = "getFile" :> (RequiredQueryParam "file_id" FileId :> Get '[JSON] (Response File))
getFile :: FileId -> ClientM (Response File)
type SendPhotoContent = "sendPhoto" :> (MultipartForm Tmp SendPhotoRequest :> Post '[JSON] (Response Message))
type SendPhotoLink = "sendPhoto" :> (ReqBody '[JSON] SendPhotoRequest :> Post '[JSON] (Response Message))
newtype PhotoFile = MakePhotoFile InputFile
pattern PhotoFileId :: FileId -> PhotoFile
pattern PhotoUrl :: Text -> PhotoFile
pattern PhotoFile :: FilePath -> ContentType -> PhotoFile
data SendPhotoRequest = SendPhotoRequest {
- sendPhotoChatId :: SomeChatId
- sendPhotoPhoto :: PhotoFile
- sendPhotoThumb :: Maybe FilePath
- sendPhotoCaption :: Maybe Text
- sendPhotoParseMode :: Maybe ParseMode
- sendPhotoCaptionEntities :: Maybe [MessageEntity]
- sendPhotoDisableNotification :: Maybe Bool
- sendPhotoProtectContent :: Maybe Bool
- sendPhotoReplyToMessageId :: Maybe MessageId
- sendPhotoAllowSendingWithoutReply :: Maybe Bool
- sendPhotoReplyMarkup :: Maybe SomeReplyMarkup
}
sendPhoto :: SendPhotoRequest -> ClientM (Response Message)
data CopyMessageRequest = CopyMessageRequest {
- copyMessageChatId :: SomeChatId
- copyMessageFromChatId :: SomeChatId
- copyMessageMessageId :: MessageId
- copyMessageCaption :: Maybe Text
- copyMessageParseMode :: Maybe ParseMode
- copyMessageCaptionEntities :: Maybe [MessageEntity]
- copyMessageDisableNotification :: Maybe Bool
- copyMessageProtectContent :: Maybe Bool
- copyMessageReplyToMessageId :: Maybe MessageId
- copyMessageAllowSendingWithoutReply :: Maybe Bool
- copyMessageReplyMarkup :: Maybe InlineKeyboardMarkup
}
data SendAudioRequest = SendAudioRequest {
- sendAudioChatId :: SomeChatId
- sendAudioAudio :: InputFile
- sendAudioDuration :: Maybe Int
- sendAudioPerformer :: Maybe Text
- sendAudioTitle :: Maybe Text
- sendAudioThumb :: Maybe InputFile
- sendAudioCaption :: Maybe Text
- sendAudioParseMode :: Maybe ParseMode
- sendAudioCaptionEntities :: Maybe [MessageEntity]
- sendAudioDisableNotification :: Maybe Bool
- sendAudioProtectContent :: Maybe Bool
- sendAudioReplyToMessageId :: Maybe MessageId
- sendAudioAllowSendingWithoutReply :: Maybe Bool
- sendAudioReplyMarkup :: Maybe InlineKeyboardMarkup
}
type SendAudioContent = "sendAudio" :> (MultipartForm Tmp SendAudioRequest :> Post '[JSON] (Response Message))
type SendAudioLink = "sendAudio" :> (ReqBody '[JSON] SendAudioRequest :> Post '[JSON] (Response Message))
sendAudio :: SendAudioRequest -> ClientM (Response Message)
data SendVideoRequest = SendVideoRequest {
- sendVideoChatId :: SomeChatId
- sendVideoVideo :: InputFile
- sendVideoDuration :: Maybe Int
- sendVideoWidth :: Maybe Int
- sendVideoHeight :: Maybe Int
- sendVideoThumb :: Maybe InputFile
- sendVideoCaption :: Maybe Text
- sendVideoParseMode :: Maybe ParseMode
- sendVideoCaptionEntities :: Maybe [MessageEntity]
- sendVideoSupportsStreaming :: Maybe Bool
- sendVideoDisableNotification :: Maybe Bool
- sendVideoProtectContent :: Maybe Bool
- sendVideoReplyToMessageId :: Maybe MessageId
- sendVideoAllowSendingWithoutReply :: Maybe Bool
- sendVideoReplyMarkup :: Maybe InlineKeyboardMarkup
}
type SendVideoContent = "sendVideo" :> (MultipartForm Tmp SendVideoRequest :> Post '[JSON] (Response Message))
type SendVideoLink = "sendVideo" :> (ReqBody '[JSON] SendVideoRequest :> Post '[JSON] (Response Message))
sendVideo :: SendVideoRequest -> ClientM (Response Message)
data SendAnimationRequest = SendAnimationRequest {
- sendAnimationChatId :: SomeChatId
- sendAnimationAnimation :: InputFile
- sendAnimationDuration :: Maybe Int
- sendAnimationWidth :: Maybe Int
- sendAnimationHeight :: Maybe Int
- sendAnimationThumb :: Maybe InputFile
- sendAnimationCaption :: Maybe Text
- sendAnimationParseMode :: Maybe ParseMode
- sendAnimationCaptionEntities :: Maybe [MessageEntity]
- sendAnimationDisableNotification :: Maybe Bool
- sendAnimationProtectContent :: Maybe Bool
- sendAnimationReplyToMessageId :: Maybe MessageId
- sendAnimationAllowSendingWithoutReply :: Maybe Bool
- sendAnimationReplyMarkup :: Maybe InlineKeyboardMarkup
}
type SendAnimationContent = "sendAnimation" :> (MultipartForm Tmp SendAnimationRequest :> Post '[JSON] (Response Message))
type SendAnimationLink = "sendAnimation" :> (ReqBody '[JSON] SendAnimationRequest :> Post '[JSON] (Response Message))
sendAnimation :: SendAnimationRequest -> ClientM (Response Message)
data SendVoiceRequest = SendVoiceRequest {
- sendVoiceChatId :: SomeChatId
- sendVoiceVoice :: InputFile
- sendVoiceCaption :: Maybe Text
- sendVoiceParseMode :: Maybe ParseMode
- sendVoiceCaptionEntities :: Maybe [MessageEntity]
- sendVoiceDuration :: Maybe Int
- sendVoiceDisableNotification :: Maybe Bool
- sendVoiceProtectContent :: Maybe Bool
- sendVoiceReplyToMessageId :: Maybe MessageId
- sendVoiceAllowSendingWithoutReply :: Maybe Bool
- sendVoiceReplyMarkup :: Maybe InlineKeyboardMarkup
}
type SendVoiceContent = "sendVoice" :> (MultipartForm Tmp SendVoiceRequest :> Post '[JSON] (Response Message))
type SendVoiceLink = "sendVoice" :> (ReqBody '[JSON] SendVoiceRequest :> Post '[JSON] (Response Message))
sendVoice :: SendVoiceRequest -> ClientM (Response Message)
data SendVideoNoteRequest = SendVideoNoteRequest {
- sendVideoNoteChatId :: SomeChatId
- sendVideoNoteVideoNote :: InputFile
- sendVideoNoteDuration :: Maybe Int
- sendVideoNoteLength :: Maybe Int
- sendVideoNoteThumb :: Maybe InputFile
- sendVideoNoteDisableNotification :: Maybe Bool
- sendVideoNoteProtectContent :: Maybe Bool
- sendVideoNoteReplyToMessageId :: Maybe MessageId
- sendVideoNoteAllowSendingWithoutReply :: Maybe Bool
- sendVideoNoteReplyMarkup :: Maybe InlineKeyboardMarkup
}
type SendVideoNoteContent = "sendVideoNote" :> (MultipartForm Tmp SendVideoNoteRequest :> Post '[JSON] (Response Message))
type SendVideoNoteLink = "sendVideoNote" :> (ReqBody '[JSON] SendVideoNoteRequest :> Post '[JSON] (Response Message))
sendVideoNote :: SendVideoNoteRequest -> ClientM (Response Message)
data SendMediaGroupRequest = SendMediaGroupRequest {
- sendMediaGroupChatId :: SomeChatId
- sendMediaGroupMedia :: [InputMedia]
- sendMediaGroupDisableNotification :: Maybe Bool
- sendMediaGroupProtectContent :: Maybe Bool
- sendMediaGroupReplyToMessageId :: Maybe MessageId
- sendMediaGroupAllowSendingWithoutReply :: Maybe Bool
- sendMediaGroupReplyMarkup :: Maybe InlineKeyboardMarkup
}
type SendMediaGroup = "sendMediaGroup" :> (ReqBody '[JSON] SendMediaGroupRequest :> Post '[JSON] (Response [Message]))
sendMediaGroup :: SendMediaGroupRequest -> ClientM (Response [Message])
data SendLocationRequest = SendLocationRequest {
- sendLocationChatId :: SomeChatId
- sendLocationLatitude :: Float
- sendLocationLongitude :: Float
- sendLocationHorizontalAccuracy :: Maybe Float
- sendLocationLivePeriod :: Int
- sendLocationHeading :: Maybe Int
- sendLocationProximityAlertRadius :: Maybe Int
- sendLocationDisableNotification :: Maybe Bool
- sendLocationProtectContent :: Maybe Bool
- sendLocationReplyToMessageId :: Maybe MessageId
- sendLocationAllowSendingWithoutReply :: Maybe Bool
- sendLocationReplyMarkup :: Maybe InlineKeyboardMarkup
}
data EditMessageLiveLocationRequest = EditMessageLiveLocationRequest {
- editMessageLiveLocationChatId :: Maybe SomeChatId
- editMessageLiveLocationMessageId :: Maybe MessageId
- editMessageLiveLocationInlineMessageId :: Maybe Text
- editMessageLiveLocationLatitude :: Float
- editMessageLiveLocationLongitude :: Float
- editMessageLiveLocationHorizontalAccuracy :: Maybe Float
- editMessageLiveLocationHeading :: Maybe Int
- editMessageLiveLocationProximityAlertRadius :: Maybe Int
- editMessageLiveLocationReplyMarkup :: Maybe InlineKeyboardMarkup
}
data StopMessageLiveLocationRequest = StopMessageLiveLocationRequest {
- stopMessageLiveLocationChatId :: Maybe SomeChatId
- stopMessageLiveLocationMessageId :: Maybe MessageId
- stopMessageLiveLocationInlineMessageId :: Maybe Text
- stopMessageLiveLocationReplyMarkup :: Maybe InlineKeyboardMarkup
}
data SendVenueRequest = SendVenueRequest {
- sendVenueChatId :: SomeChatId
- sendVenueLatitude :: Float
- sendVenueLongitude :: Float
- sendVenueTitle :: Text
- sendVenueAddress :: Text
- sendVenueFoursquareId :: Maybe Text
- sendVenueFoursquareType :: Maybe Text
- sendVenueGooglePlaceId :: Maybe Text
- sendVenueGooglePlaceType :: Maybe Text
- sendVenueDisableNotification :: Maybe Bool
- sendVenueProtectContent :: Maybe Bool
- sendVenueReplyToMessageId :: Maybe MessageId
- sendVenueAllowSendingWithoutReply :: Maybe Bool
- sendVenueReplyMarkup :: Maybe InlineKeyboardMarkup
}
data SendContactRequest = SendContactRequest {
- sendContactChatId :: SomeChatId
- sendContactPhoneNumber :: Text
- sendContactFirstName :: Text
- sendContactLastName :: Text
- sendContactVcard :: Text
- sendContactDisableNotification :: Maybe Bool
- sendContactProtectContent :: Maybe Bool
- sendContactReplyToMessageId :: Maybe MessageId
- sendContactAllowSendingWithoutReply :: Maybe Bool
- sendContactReplyMarkup :: Maybe InlineKeyboardMarkup
}
data SendPollRequest = SendPollRequest {
- sendPollChatId :: SomeChatId
- sendPollQuestion :: Text
- sendPollOptions :: [Text]
- 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
- sendPollReplyToMessageId :: Maybe MessageId
- sendPollAllowSendingWithoutReply :: Maybe Bool
- sendPollReplyMarkup :: Maybe InlineKeyboardMarkup
}
data SendDiceRequest = SendDiceRequest {
- sendDiceChatId :: SomeChatId
- sendDiceEmoji :: Maybe Text
- sendDiceDisableNotification :: Maybe Bool
- sendDiceProtectContent :: Maybe Bool
- sendDiceReplyToMessageId :: Maybe MessageId
- sendDiceAllowSendingWithoutReply :: Maybe Bool
- sendDiceReplyMarkup :: Maybe InlineKeyboardMarkup
}
type SendChatAction = "sendChatAction" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "action" Text :> Post '[JSON] (Response Bool)))
sendChatAction :: SomeChatId -> Text -> ClientM (Response Bool)
data GetUserProfilePhotosRequest = GetUserProfilePhotosRequest {
- getUserProfilePhotosUserId :: UserId
- getUserProfilePhotosOffset :: Maybe Int
- getUserProfilePhotosLimit :: Maybe Int
}
data BanChatMemberRequest = BanChatMemberRequest {
- banChatMemberChatId :: SomeChatId
- banChatMemberUserId :: UserId
- banChatMemberUntilDate :: Maybe Int
- banChatMemberRevokeMessages :: Maybe Bool
}
data UnbanChatMemberRequest = UnbanChatMemberRequest {
- unbanChatMemberChatId :: SomeChatId
- unbanChatMemberUserId :: UserId
- unbanChatMemberOnlyIfBanned :: Maybe Bool
}
data RestrictChatMemberRequest = RestrictChatMemberRequest {
- restrictChatMemberChatId :: SomeChatId
- restrictChatMemberUserId :: UserId
- restrictChatMemberPermissions :: ChatPermissions
- restrictChatMemberUntilDate :: Maybe Int
}
data PromoteChatMemberRequest = PromoteChatMemberRequest {
- promoteChatMemberChatId :: SomeChatId
- promoteChatMemberUserId :: UserId
- promoteChatMemberIsAnonymous :: Maybe Bool
- promoteChatMemberCanManageChat :: Maybe Bool
- promoteChatMemberCanPostMessages :: Maybe Bool
- promoteChatMemberCanEditMessages :: Maybe Bool
- promoteChatMemberCanDeleteMessages :: Maybe Bool
- promoteChatMemberCanManageVideoChats :: Maybe Bool
- promoteChatMemberCanRestrictMembers :: Maybe Bool
- promoteChatMemberCanPromoteMembers :: Maybe Bool
- promoteChatMemberCanChangeInfo :: Maybe Bool
- promoteChatMemberCanInviteUsers :: Maybe Bool
- promoteChatMemberCanPinMessages :: Maybe Bool
}
data SetChatAdministratorCustomTitleRequest = SetChatAdministratorCustomTitleRequest {
- setChatAdministratorCustomTitleChatId :: SomeChatId
- setChatAdministratorCustomTitleUserId :: UserId
- setChatAdministratorCustomTitleCustomTitle :: Text
}
type BanChatSenderChat = "banChatSenderChat" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "sender_chat_id" ChatId :> Post '[JSON] (Response Bool)))
banChatSenderChat :: SomeChatId -> ChatId -> ClientM (Response Bool)
type UnbanChatSenderChat = "unbanChatSenderChat" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "sender_chat_id" ChatId :> Post '[JSON] (Response Bool)))
unbanChatSenderChat :: SomeChatId -> ChatId -> ClientM (Response Bool)
data SetChatPermissionsRequest = SetChatPermissionsRequest {
- setChatPermissionsChatId :: SomeChatId
- setChatPermissionsPermissions :: ChatPermissions
}
type ExportChatInviteLink = "exportChatInviteLink" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Text))
exportChatInviteLink :: SomeChatId -> ClientM (Response Text)
data CreateChatInviteLinkRequest = CreateChatInviteLinkRequest {
- createChatInviteLinkChatId :: SomeChatId
- createChatInviteLinkName :: Maybe Text
- createChatInviteLinkExpireDate :: Maybe Integer
- createChatInviteLinkMemberLimit :: Maybe Int
- createChatInviteLinkCreatesJoinRequest :: Maybe Bool
}
data EditChatInviteLinkRequest = EditChatInviteLinkRequest {
- editChatInviteLinkChatId :: SomeChatId
- editChatInviteLinkInviteLink :: Text
- editChatInviteLinkName :: Maybe Text
- editChatInviteLinkExpireDate :: Maybe Integer
- editChatInviteLinkMemberLimit :: Maybe Int
- editChatInviteLinkCreatesJoinRequest :: Maybe Bool
}
type RevokeChatInviteLink = "revokeChatInviteLink" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "invite_link" Text :> Post '[JSON] (Response ChatInviteLink)))
revokeChatInviteLink :: SomeChatId -> Text -> ClientM (Response ChatInviteLink)
type ApproveChatJoinRequest = "approveChatJoinRequest" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "user_id" UserId :> Post '[JSON] (Response Bool)))
approveChatJoinRequest :: SomeChatId -> UserId -> ClientM (Response Bool)
type DeclineChatJoinRequest = "declineChatJoinRequest" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "user_id" UserId :> Post '[JSON] (Response Bool)))
declineChatJoinRequest :: SomeChatId -> UserId -> ClientM (Response Bool)
data SetChatPhotoRequest = SetChatPhotoRequest {
- setChatPhotoChatId :: SomeChatId
- setChatPhotoPhoto :: InputFile
}
type SetChatPhoto = "setChatPhoto" :> (MultipartForm Tmp SetChatPhotoRequest :> Post '[JSON] (Response Bool))
setChatPhoto :: SetChatPhotoRequest -> ClientM (Response Bool)
type DeleteChatPhoto = "deleteChatPhoto" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool))
deleteChatPhoto :: SomeChatId -> ClientM (Response Bool)
type SetChatTitle = "setChatTitle" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "title" Text :> Post '[JSON] (Response Bool)))
setChatTitle :: SomeChatId -> Text -> ClientM (Response Bool)
type SetChatDescription = "setChatDescription" :> (RequiredQueryParam "chat_id" SomeChatId :> (QueryParam "description" Text :> Post '[JSON] (Response Bool)))
setChatDescription :: SomeChatId -> Maybe Text -> ClientM (Response Bool)
data PinChatMessageRequest = PinChatMessageRequest {
- pinChatMessageChatId :: SomeChatId
- pinChatMessageMessageId :: MessageId
- pinChatMessageDisableNotification :: Maybe Bool
}
type UnpinChatMessage = "unpinChatMessage" :> (RequiredQueryParam "chat_id" SomeChatId :> (QueryParam "message_id" MessageId :> Post '[JSON] (Response Bool)))
unpinChatMessage :: SomeChatId -> Maybe MessageId -> ClientM (Response Bool)
type UnpinAllChatMessages = "unpinAllChatMessages" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool))
unpinAllChatMessages :: SomeChatId -> ClientM (Response Bool)
type LeaveChat = "leaveChat" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool))
leaveChat :: SomeChatId -> ClientM (Response Bool)
type GetChat = "getChat" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Chat))
getChat :: SomeChatId -> ClientM (Response Chat)
type GetChatAdministrators = "getChatAdministrators" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response [ChatMember]))
getChatAdministrators :: SomeChatId -> ClientM (Response [ChatMember])
type GetChatMemberCount = "getChatMemberCount" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Integer))
getChatMemberCount :: SomeChatId -> ClientM (Response Integer)
type GetChatMember = "getChatMember" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "user_id" UserId :> Post '[JSON] (Response ChatMember)))
getChatMember :: SomeChatId -> UserId -> ClientM (Response ChatMember)
type SetChatStickerSet = "setChatStickerSet" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "sticker_set_name" Text :> Post '[JSON] (Response Bool)))
setChatStickerSet :: SomeChatId -> Text -> ClientM (Response Bool)
type DeleteChatStickerSet = "deleteChatStickerSet" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool))
deleteChatStickerSet :: SomeChatId -> ClientM (Response Bool)
data AnswerCallbackQueryRequest = AnswerCallbackQueryRequest {
- answerCallbackQueryCallbackQueryId :: CallbackQueryId
- answerCallbackQueryText :: Maybe Text
- answerCallbackQueryShowAlert :: Maybe Bool
- answerCallbackQueryUrl :: Maybe Text
- answerCallbackQueryCacheTime :: Maybe Integer
}
data SetMyCommandsRequest = SetMyCommandsRequest {
- setMyCommandsCommands :: [BotCommand]
- setMyCommandsScope :: Maybe BotCommandScope
- setMyCommandsLanguageCode :: Maybe Text
}
data DeleteMyCommandsRequest = DeleteMyCommandsRequest {
- deleteMyCommandsScope :: Maybe BotCommandScope
- deleteMyCommandsLanguageCode :: Maybe Text
}
data GetMyCommandsRequest = GetMyCommandsRequest {
- getMyCommandsScope :: Maybe BotCommandScope
- getMyCommandsLanguageCode :: Maybe Text
}
data SetChatMenuButtonRequest = SetChatMenuButtonRequest {
- setChatMenuButtonRequestChatId :: Maybe ChatId
- setChatMenuButtonRequestMenuButton :: Maybe MenuButton
}
data GetChatMenuButtonRequest = GetChatMenuButtonRequest {
- getChatMenuButtonRequestChatId :: Maybe ChatId
}
data SetMyDefaultAdministratorRightsRequest = SetMyDefaultAdministratorRightsRequest {
- setMyDefaultAdministratorRightsRequestRights :: Maybe ChatAdministratorRights
- setMyDefaultAdministratorRightsRequestForChannels :: Maybe Bool
}
data GetMyDefaultAdministratorRightsRequest = GetMyDefaultAdministratorRightsRequest {
- getMyDefaultAdministratorRightsRequestForChannels :: Maybe Bool
}
type CopyMessage = "copyMessage" :> (ReqBody '[JSON] CopyMessageRequest :> Post '[JSON] (Response CopyMessageId))
copyMessage :: CopyMessageRequest -> ClientM (Response CopyMessageId)
type SendLocation = "sendLocation" :> (ReqBody '[JSON] SendLocationRequest :> Post '[JSON] (Response Message))
sendLocation :: SendLocationRequest -> ClientM (Response Message)
type EditMessageLiveLocation = "editMessageLiveLocation" :> (ReqBody '[JSON] EditMessageLiveLocationRequest :> Post '[JSON] (Response (Either Bool Message)))
editMessageLiveLocation :: EditMessageLiveLocationRequest -> ClientM (Response (Either Bool Message))
type StopMessageLiveLocation = "stopMessageLiveLocation" :> (ReqBody '[JSON] StopMessageLiveLocationRequest :> Post '[JSON] (Response (Either Bool Message)))
stopMessageLiveLocation :: StopMessageLiveLocationRequest -> ClientM (Response (Either Bool Message))
type SendVenue = "sendVenue" :> (ReqBody '[JSON] SendVenueRequest :> Post '[JSON] (Response Message))
sendVenue :: SendVenueRequest -> ClientM (Response Message)
type SendContact = "sendContact" :> (ReqBody '[JSON] SendContactRequest :> Post '[JSON] (Response Message))
sendContact :: SendContactRequest -> ClientM (Response Message)
type SendPoll = "sendPoll" :> (ReqBody '[JSON] SendPollRequest :> Post '[JSON] (Response Message))
sendPoll :: SendPollRequest -> ClientM (Response Message)
type SendDice = "sendDice" :> (ReqBody '[JSON] SendDiceRequest :> Post '[JSON] (Response Message))
sendDice :: SendDiceRequest -> ClientM (Response Message)
type GetUserProfilePhotos = "getUserProfilePhotos" :> (ReqBody '[JSON] GetUserProfilePhotosRequest :> Post '[JSON] (Response UserProfilePhotos))
getUserProfilePhotos :: GetUserProfilePhotosRequest -> ClientM (Response UserProfilePhotos)
type BanChatMember = "banChatMember" :> (ReqBody '[JSON] BanChatMemberRequest :> Post '[JSON] (Response Bool))
banChatMember :: BanChatMemberRequest -> ClientM (Response Bool)
type UnbanChatMember = "unbanChatMember" :> (ReqBody '[JSON] UnbanChatMemberRequest :> Post '[JSON] (Response Bool))
unbanChatMember :: UnbanChatMemberRequest -> ClientM (Response Bool)
type RestrictChatMember = "restrictChatMember" :> (ReqBody '[JSON] RestrictChatMemberRequest :> Post '[JSON] (Response Bool))
restrictChatMember :: RestrictChatMemberRequest -> ClientM (Response Bool)
type PromoteChatMember = "promoteChatMember" :> (ReqBody '[JSON] PromoteChatMemberRequest :> Post '[JSON] (Response Bool))
promoteChatMember :: PromoteChatMemberRequest -> ClientM (Response Bool)
type SetChatAdministratorCustomTitle = "setChatAdministratorCustomTitle" :> (ReqBody '[JSON] SetChatAdministratorCustomTitleRequest :> Post '[JSON] (Response Bool))
setChatAdministratorCustomTitle :: SetChatAdministratorCustomTitleRequest -> ClientM (Response Bool)
type SetChatPermissions = "setChatPermissions" :> (ReqBody '[JSON] SetChatPermissionsRequest :> Post '[JSON] (Response Bool))
setChatPermissions :: SetChatPermissionsRequest -> ClientM (Response Bool)
type CreateChatInviteLink = "createChatInviteLink" :> (ReqBody '[JSON] CreateChatInviteLinkRequest :> Post '[JSON] (Response ChatInviteLink))
createChatInviteLink :: CreateChatInviteLinkRequest -> ClientM (Response ChatInviteLink)
type EditChatInviteLink = "editChatInviteLink" :> (ReqBody '[JSON] EditChatInviteLinkRequest :> Post '[JSON] (Response ChatInviteLink))
editChatInviteLink :: EditChatInviteLinkRequest -> ClientM (Response ChatInviteLink)
type PinChatMessage = "pinChatMessage" :> (ReqBody '[JSON] PinChatMessageRequest :> Post '[JSON] (Response Bool))
pinChatMessage :: PinChatMessageRequest -> ClientM (Response Bool)
type AnswerCallbackQuery = "answerCallbackQuery" :> (ReqBody '[JSON] AnswerCallbackQueryRequest :> Post '[JSON] (Response Bool))
answerCallbackQuery :: AnswerCallbackQueryRequest -> ClientM (Response Bool)
type SetMyCommands = "setMyCommands" :> (ReqBody '[JSON] SetMyCommandsRequest :> Post '[JSON] (Response Bool))
setMyCommands :: SetMyCommandsRequest -> ClientM (Response Bool)
type DeleteMyCommands = "deleteMyCommands" :> (ReqBody '[JSON] DeleteMyCommandsRequest :> Post '[JSON] (Response Bool))
deleteMyCommands :: DeleteMyCommandsRequest -> ClientM (Response Bool)
type GetMyCommands = "getMyCommands" :> (ReqBody '[JSON] GetMyCommandsRequest :> Post '[JSON] (Response [BotCommand]))
getMyCommands :: GetMyCommandsRequest -> ClientM (Response [BotCommand])
type SetChatMenuButton = "setChatMenuButton" :> (ReqBody '[JSON] SetChatMenuButtonRequest :> Post '[JSON] (Response Bool))
setChatMenuButton :: SetChatMenuButtonRequest -> ClientM (Response Bool)
type GetChatMenuButton = "getChatMenuButton" :> (ReqBody '[JSON] GetChatMenuButtonRequest :> Post '[JSON] (Response MenuButton))
getChatMenuButton :: GetChatMenuButtonRequest -> ClientM (Response MenuButton)
type SetMyDefaultAdministratorRights = "setMyDefaultAdministratorRights" :> (ReqBody '[JSON] SetMyDefaultAdministratorRightsRequest :> Post '[JSON] (Response Bool))
setMyDefaultAdministratorRights :: SetMyDefaultAdministratorRightsRequest -> ClientM (Response Bool)
type GetMyDefaultAdministratorRights = "getMyDefaultAdministratorRights" :> (ReqBody '[JSON] GetMyDefaultAdministratorRightsRequest :> Post '[JSON] (Response ChatAdministratorRights))
getMyDefaultAdministratorRights :: GetMyDefaultAdministratorRightsRequest -> ClientM (Response ChatAdministratorRights)

Available methods

`getMe`

type GetMe = "getMe" :> Get '[JSON] (Response User) Source #

getMe :: ClientM (Response User) Source #

A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object.

`deleteMessage`

type DeleteMessage = "deleteMessage" :> (RequiredQueryParam "chat_id" ChatId :> (RequiredQueryParam "message_id" MessageId :> Get '[JSON] (Response Bool))) Source #

Notice that deleting by POST method was bugged, so we use GET

deleteMessage :: ChatId -> MessageId -> ClientM (Response Bool) Source #

Use this method to delete message in chat. On success, the sent Bool is returned.

`sendMessage`

type SendMessage = "sendMessage" :> (ReqBody '[JSON] SendMessageRequest :> Post '[JSON] (Response Message)) Source #

sendMessage :: SendMessageRequest -> ClientM (Response Message) Source #

Use this method to send text messages. On success, the sent Message is returned.

`forwardMessage`

type ForwardMessage = "forwardMessage" :> (ReqBody '[JSON] ForwardMessageRequest :> Post '[JSON] (Response Message)) Source #

forwardMessage :: ForwardMessageRequest -> ClientM (Response Message) Source #

Use this method to forward messages of any kind. On success, the sent Message is returned.

data SomeReplyMarkup Source #

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.

Constructors

SomeInlineKeyboardMarkup InlineKeyboardMarkup
SomeReplyKeyboardMarkup ReplyKeyboardMarkup
SomeReplyKeyboardRemove ReplyKeyboardRemove
SomeForceReply ForceReply

Instances

Instances details

Generic SomeReplyMarkup Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SomeReplyMarkup :: Type -> Type # Methods from :: SomeReplyMarkup -> Rep SomeReplyMarkup x # to :: Rep SomeReplyMarkup x -> SomeReplyMarkup #
FromJSON SomeReplyMarkup Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SomeReplyMarkup parseJSONList :: Value -> Parser [SomeReplyMarkup]
ToJSON SomeReplyMarkup Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SomeReplyMarkup -> Value toEncoding :: SomeReplyMarkup -> Encoding toJSONList :: [SomeReplyMarkup] -> Value toEncodingList :: [SomeReplyMarkup] -> Encoding
type Rep SomeReplyMarkup Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SomeReplyMarkup = D1 ('MetaData "SomeReplyMarkup" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) ((C1 ('MetaCons "SomeInlineKeyboardMarkup" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InlineKeyboardMarkup)) :+: C1 ('MetaCons "SomeReplyKeyboardMarkup" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReplyKeyboardMarkup))) :+: (C1 ('MetaCons "SomeReplyKeyboardRemove" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReplyKeyboardRemove)) :+: C1 ('MetaCons "SomeForceReply" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ForceReply))))

data ParseMode Source #

Constructors

Markdown
HTML
MarkdownV2

Instances

Instances details

Generic ParseMode Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep ParseMode :: Type -> Type # Methods from :: ParseMode -> Rep ParseMode x # to :: Rep ParseMode x -> ParseMode #
FromJSON ParseMode Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser ParseMode parseJSONList :: Value -> Parser [ParseMode]
ToJSON ParseMode Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: ParseMode -> Value toEncoding :: ParseMode -> Encoding toJSONList :: [ParseMode] -> Value toEncodingList :: [ParseMode] -> Encoding
type Rep ParseMode Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep ParseMode = D1 ('MetaData "ParseMode" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "Markdown" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "HTML" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MarkdownV2" 'PrefixI 'False) (U1 :: Type -> Type)))

data SendMessageRequest Source #

Request parameters for sendMessage.

Constructors

SendMessageRequest

Fields

sendMessageChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername).
sendMessageText :: Text
Text of the message to be sent.
sendMessageParseMode :: 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.
sendMessageEntities :: Maybe [MessageEntity]
A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode.
sendMessageDisableWebPagePreview :: Maybe Bool
Disables link previews for links in this message.
sendMessageDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendMessageProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving.
sendMessageReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message.
sendMessageAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found.
sendMessageReplyMarkup :: Maybe SomeReplyMarkup
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

Generic SendMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendMessageRequest :: Type -> Type # Methods from :: SendMessageRequest -> Rep SendMessageRequest x # to :: Rep SendMessageRequest x -> SendMessageRequest #
FromJSON SendMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SendMessageRequest parseJSONList :: Value -> Parser [SendMessageRequest]
ToJSON SendMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendMessageRequest -> Value toEncoding :: SendMessageRequest -> Encoding toJSONList :: [SendMessageRequest] -> Value toEncodingList :: [SendMessageRequest] -> Encoding
type Rep SendMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendMessageRequest = D1 ('MetaData "SendMessageRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendMessageRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendMessageChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: S1 ('MetaSel ('Just "sendMessageText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "sendMessageParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode)) :: (S1 ('MetaSel ('Just "sendMessageEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity])) :: S1 ('MetaSel ('Just "sendMessageDisableWebPagePreview") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "sendMessageDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendMessageProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "sendMessageReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :: (S1 ('MetaSel ('Just "sendMessageAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendMessageReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeReplyMarkup)))))))

data ForwardMessageRequest Source #

Request parameters for forwardMessage.

Constructors

ForwardMessageRequest

Fields

forwardMessageChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @@channelusername).
forwardMessageFromChatId :: SomeChatId
Unique identifier for the chat where the original message was sent (or channel username in the format @@channelusername).
forwardMessageDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
forwardMessageProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving.
forwardMessageMessageId :: MessageId
Message identifier in the chat specified in from_chat_id.

Instances

Instances details

Generic ForwardMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep ForwardMessageRequest :: Type -> Type # Methods from :: ForwardMessageRequest -> Rep ForwardMessageRequest x # to :: Rep ForwardMessageRequest x -> ForwardMessageRequest #
FromJSON ForwardMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser ForwardMessageRequest parseJSONList :: Value -> Parser [ForwardMessageRequest]
ToJSON ForwardMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: ForwardMessageRequest -> Value toEncoding :: ForwardMessageRequest -> Encoding toJSONList :: [ForwardMessageRequest] -> Value toEncodingList :: [ForwardMessageRequest] -> Encoding
type Rep ForwardMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep ForwardMessageRequest = D1 ('MetaData "ForwardMessageRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "ForwardMessageRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "forwardMessageChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: S1 ('MetaSel ('Just "forwardMessageFromChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId)) :: (S1 ('MetaSel ('Just "forwardMessageDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "forwardMessageProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "forwardMessageMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageId)))))

`sendMessage`

type SendDocumentContent = "sendDocument" :> (MultipartForm Tmp SendDocumentRequest :> Post '[JSON] (Response Message)) Source #

type SendDocumentLink = "sendDocument" :> (ReqBody '[JSON] SendDocumentRequest :> Post '[JSON] (Response Message)) Source #

sendDocument :: SendDocumentRequest -> ClientM (Response Message) Source #

Use this method to send text messages. On success, the sent Message is returned.

https://core.telegram.org/bots/api#senddocument

data SendDocumentRequest Source #

Request parameters for sendDocument

Constructors

SendDocumentRequest

Fields

sendDocumentChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername).
sendDocumentDocument :: DocumentFile
Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data
sendDocumentThumb :: Maybe FilePath
Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipartform-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach:file_attach_name” if the thumbnail was uploaded using multipartform-data under file_attach_name
sendDocumentCaption :: Maybe Text
Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing
sendDocumentParseMode :: 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.
sendDocumentCaptionEntities :: Maybe [MessageEntity]
A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode.
sendDocumentDisableContentTypeDetection :: Maybe Bool
Disables automatic server-side content type detection for files uploaded using multipart/form-data.
sendDocumentDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendDocumentProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving.
sendDocumentReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message.
sendDocumentAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found.
sendDocumentReplyMarkup :: Maybe SomeReplyMarkup
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

Generic SendDocumentRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendDocumentRequest :: Type -> Type # Methods from :: SendDocumentRequest -> Rep SendDocumentRequest x # to :: Rep SendDocumentRequest x -> SendDocumentRequest #
ToJSON SendDocumentRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendDocumentRequest -> Value toEncoding :: SendDocumentRequest -> Encoding toJSONList :: [SendDocumentRequest] -> Value toEncodingList :: [SendDocumentRequest] -> Encoding
ToMultipart Tmp SendDocumentRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toMultipart :: SendDocumentRequest -> MultipartData Tmp
type Rep SendDocumentRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendDocumentRequest = D1 ('MetaData "SendDocumentRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendDocumentRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendDocumentChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "sendDocumentDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DocumentFile) :: S1 ('MetaSel ('Just "sendDocumentThumb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)))) :: (S1 ('MetaSel ('Just "sendDocumentCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sendDocumentParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode)) :: S1 ('MetaSel ('Just "sendDocumentCaptionEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity]))))) :: ((S1 ('MetaSel ('Just "sendDocumentDisableContentTypeDetection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "sendDocumentDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendDocumentProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "sendDocumentReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :: (S1 ('MetaSel ('Just "sendDocumentAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendDocumentReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeReplyMarkup)))))))

newtype DocumentFile Source #

Constructors

MakeDocumentFile InputFile

Instances

Instances details

ToJSON DocumentFile Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: DocumentFile -> Value toEncoding :: DocumentFile -> Encoding toJSONList :: [DocumentFile] -> Value toEncodingList :: [DocumentFile] -> Encoding

pattern DocumentFileId :: FileId -> DocumentFile Source #

pattern DocumentUrl :: Text -> DocumentFile Source #

pattern DocumentFile :: FilePath -> ContentType -> DocumentFile Source #

toSendDocument :: SomeChatId -> DocumentFile -> SendDocumentRequest Source #

Generate send document structure.

`getFile`

type GetFile = "getFile" :> (RequiredQueryParam "file_id" FileId :> Get '[JSON] (Response File)) Source #

getFile :: FileId -> ClientM (Response File) Source #

`sendPhoto`

type SendPhotoContent = "sendPhoto" :> (MultipartForm Tmp SendPhotoRequest :> Post '[JSON] (Response Message)) Source #

type SendPhotoLink = "sendPhoto" :> (ReqBody '[JSON] SendPhotoRequest :> Post '[JSON] (Response Message)) Source #

newtype PhotoFile Source #

Constructors

MakePhotoFile InputFile

Instances

Instances details

ToJSON PhotoFile Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: PhotoFile -> Value toEncoding :: PhotoFile -> Encoding toJSONList :: [PhotoFile] -> Value toEncodingList :: [PhotoFile] -> Encoding

pattern PhotoFileId :: FileId -> PhotoFile Source #

pattern PhotoUrl :: Text -> PhotoFile Source #

pattern PhotoFile :: FilePath -> ContentType -> PhotoFile Source #

data SendPhotoRequest Source #

Request parameters for sendPhoto

Constructors

SendPhotoRequest

Fields

sendPhotoChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername).
sendPhotoPhoto :: PhotoFile
Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data
sendPhotoThumb :: Maybe FilePath
Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipartform-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach:file_attach_name” if the thumbnail was uploaded using multipartform-data under file_attach_name
sendPhotoCaption :: Maybe Text
Photo caption (may also be used when resending Photos by file_id), 0-1024 characters after entities parsing
sendPhotoParseMode :: 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.
sendPhotoCaptionEntities :: Maybe [MessageEntity]
A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode.
sendPhotoDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendPhotoProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving.
sendPhotoReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message.
sendPhotoAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found.
sendPhotoReplyMarkup :: Maybe SomeReplyMarkup
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

Generic SendPhotoRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendPhotoRequest :: Type -> Type # Methods from :: SendPhotoRequest -> Rep SendPhotoRequest x # to :: Rep SendPhotoRequest x -> SendPhotoRequest #
ToJSON SendPhotoRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendPhotoRequest -> Value toEncoding :: SendPhotoRequest -> Encoding toJSONList :: [SendPhotoRequest] -> Value toEncodingList :: [SendPhotoRequest] -> Encoding
ToMultipart Tmp SendPhotoRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toMultipart :: SendPhotoRequest -> MultipartData Tmp
type Rep SendPhotoRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendPhotoRequest = D1 ('MetaData "SendPhotoRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendPhotoRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendPhotoChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: S1 ('MetaSel ('Just "sendPhotoPhoto") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PhotoFile)) :: (S1 ('MetaSel ('Just "sendPhotoThumb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :: (S1 ('MetaSel ('Just "sendPhotoCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sendPhotoParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode))))) :: ((S1 ('MetaSel ('Just "sendPhotoCaptionEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity])) :: (S1 ('MetaSel ('Just "sendPhotoDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendPhotoProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "sendPhotoReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :: (S1 ('MetaSel ('Just "sendPhotoAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendPhotoReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeReplyMarkup)))))))

sendPhoto :: SendPhotoRequest -> ClientM (Response Message) Source #

Use this method to send photos. On success, the sent Message is returned.

https://core.telegram.org/bots/api#sendphoto

data CopyMessageRequest Source #

Request parameters for copyMessage.

Constructors

CopyMessageRequest

Fields

copyMessageChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
copyMessageFromChatId :: SomeChatId
Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
copyMessageMessageId :: MessageId
Message identifier in the chat specified in from_chat_id
copyMessageCaption :: Maybe Text
New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept
copyMessageParseMode :: 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.
copyMessageCaptionEntities :: Maybe [MessageEntity]
A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
copyMessageDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
copyMessageProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving
copyMessageReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message
copyMessageAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found
copyMessageReplyMarkup :: 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

Generic CopyMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep CopyMessageRequest :: Type -> Type # Methods from :: CopyMessageRequest -> Rep CopyMessageRequest x # to :: Rep CopyMessageRequest x -> CopyMessageRequest #
FromJSON CopyMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser CopyMessageRequest parseJSONList :: Value -> Parser [CopyMessageRequest]
ToJSON CopyMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: CopyMessageRequest -> Value toEncoding :: CopyMessageRequest -> Encoding toJSONList :: [CopyMessageRequest] -> Value toEncodingList :: [CopyMessageRequest] -> Encoding
type Rep CopyMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep CopyMessageRequest = D1 ('MetaData "CopyMessageRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "CopyMessageRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "copyMessageChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: S1 ('MetaSel ('Just "copyMessageFromChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId)) :: (S1 ('MetaSel ('Just "copyMessageMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageId) :: (S1 ('MetaSel ('Just "copyMessageCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "copyMessageParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode))))) :: ((S1 ('MetaSel ('Just "copyMessageCaptionEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity])) :: (S1 ('MetaSel ('Just "copyMessageDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "copyMessageProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "copyMessageReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :: (S1 ('MetaSel ('Just "copyMessageAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "copyMessageReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

data SendAudioRequest Source #

Request parameters for sendAudio.

Constructors

SendAudioRequest

Fields

sendAudioChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
sendAudioAudio :: InputFile
Audio to send. Pass a file_id as String to send an audio that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a audio from the Internet, or upload a new audio using multipart/form-data. More info on Sending Files »
sendAudioDuration :: Maybe Int
Duration of sent audio in seconds
sendAudioPerformer :: Maybe Text
Performer
sendAudioTitle :: Maybe Text
Track name
sendAudioThumb :: Maybe InputFile
Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipartform-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach:file_attach_name” if the thumbnail was uploaded using multipartform-data under file_attach_name. More info on Sending Files »
sendAudioCaption :: Maybe Text
Audio caption (may also be used when resending audios by file_id), 0-1024 characters after entities parsing
sendAudioParseMode :: 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.
sendAudioCaptionEntities :: Maybe [MessageEntity]
A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
sendAudioDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendAudioProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving
sendAudioReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message
sendAudioAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found
sendAudioReplyMarkup :: 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

Generic SendAudioRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendAudioRequest :: Type -> Type # Methods from :: SendAudioRequest -> Rep SendAudioRequest x # to :: Rep SendAudioRequest x -> SendAudioRequest #
ToJSON SendAudioRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendAudioRequest -> Value toEncoding :: SendAudioRequest -> Encoding toJSONList :: [SendAudioRequest] -> Value toEncodingList :: [SendAudioRequest] -> Encoding
ToMultipart Tmp SendAudioRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toMultipart :: SendAudioRequest -> MultipartData Tmp
type Rep SendAudioRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendAudioRequest = D1 ('MetaData "SendAudioRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendAudioRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendAudioChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "sendAudioAudio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputFile) :: S1 ('MetaSel ('Just "sendAudioDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "sendAudioPerformer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sendAudioTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sendAudioThumb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InputFile)) :: S1 ('MetaSel ('Just "sendAudioCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "sendAudioParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode)) :: (S1 ('MetaSel ('Just "sendAudioCaptionEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity])) :: S1 ('MetaSel ('Just "sendAudioDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "sendAudioProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendAudioReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :: (S1 ('MetaSel ('Just "sendAudioAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendAudioReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

type SendAudioContent = "sendAudio" :> (MultipartForm Tmp SendAudioRequest :> Post '[JSON] (Response Message)) Source #

type SendAudioLink = "sendAudio" :> (ReqBody '[JSON] SendAudioRequest :> Post '[JSON] (Response Message)) Source #

sendAudio :: SendAudioRequest -> ClientM (Response Message) Source #

Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

For sending voice messages, use the sendVoice method instead.

data SendVideoRequest Source #

Request parameters for sendVideo.

Constructors

SendVideoRequest

Fields

sendVideoChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
sendVideoVideo :: InputFile
Video to send. Pass a file_id as String to send an video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More info on Sending Files »
sendVideoDuration :: Maybe Int
Duration of sent video in seconds
sendVideoWidth :: Maybe Int
Video width
sendVideoHeight :: Maybe Int
Video height
sendVideoThumb :: Maybe InputFile
Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipartform-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach:file_attach_name” if the thumbnail was uploaded using multipartform-data under file_attach_name. More info on Sending Files »
sendVideoCaption :: Maybe Text
Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
sendVideoParseMode :: 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.
sendVideoCaptionEntities :: Maybe [MessageEntity]
A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
sendVideoSupportsStreaming :: Maybe Bool
Pass True, if the uploaded video is suitable for streaming
sendVideoDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendVideoProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving.
sendVideoReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message
sendVideoAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found
sendVideoReplyMarkup :: 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

Generic SendVideoRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendVideoRequest :: Type -> Type # Methods from :: SendVideoRequest -> Rep SendVideoRequest x # to :: Rep SendVideoRequest x -> SendVideoRequest #
ToJSON SendVideoRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendVideoRequest -> Value toEncoding :: SendVideoRequest -> Encoding toJSONList :: [SendVideoRequest] -> Value toEncodingList :: [SendVideoRequest] -> Encoding
ToMultipart Tmp SendVideoRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toMultipart :: SendVideoRequest -> MultipartData Tmp
type Rep SendVideoRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendVideoRequest = D1 ('MetaData "SendVideoRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendVideoRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendVideoChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "sendVideoVideo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputFile) :: S1 ('MetaSel ('Just "sendVideoDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "sendVideoWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "sendVideoHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "sendVideoThumb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InputFile)) :: S1 ('MetaSel ('Just "sendVideoCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "sendVideoParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode)) :: S1 ('MetaSel ('Just "sendVideoCaptionEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity]))) :: (S1 ('MetaSel ('Just "sendVideoSupportsStreaming") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendVideoDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "sendVideoProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendVideoReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :: (S1 ('MetaSel ('Just "sendVideoAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendVideoReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

type SendVideoContent = "sendVideo" :> (MultipartForm Tmp SendVideoRequest :> Post '[JSON] (Response Message)) Source #

type SendVideoLink = "sendVideo" :> (ReqBody '[JSON] SendVideoRequest :> Post '[JSON] (Response Message)) Source #

sendVideo :: SendVideoRequest -> ClientM (Response Message) Source #

Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

data SendAnimationRequest Source #

Request parameters for sendAnimation.

Constructors

SendAnimationRequest

Fields

sendAnimationChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
sendAnimationAnimation :: InputFile
Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More info on Sending Files »
sendAnimationDuration :: Maybe Int
Duration of sent animation in seconds
sendAnimationWidth :: Maybe Int
Animation width
sendAnimationHeight :: Maybe Int
Animation height
sendAnimationThumb :: Maybe InputFile
Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipartform-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach:file_attach_name” if the thumbnail was uploaded using multipartform-data under file_attach_name. More info on Sending Files »
sendAnimationCaption :: Maybe Text
Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing
sendAnimationParseMode :: 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.
sendAnimationCaptionEntities :: Maybe [MessageEntity]
A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
sendAnimationDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendAnimationProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving.
sendAnimationReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message.
sendAnimationAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found.
sendAnimationReplyMarkup :: 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

Generic SendAnimationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendAnimationRequest :: Type -> Type # Methods from :: SendAnimationRequest -> Rep SendAnimationRequest x # to :: Rep SendAnimationRequest x -> SendAnimationRequest #
ToJSON SendAnimationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendAnimationRequest -> Value toEncoding :: SendAnimationRequest -> Encoding toJSONList :: [SendAnimationRequest] -> Value toEncodingList :: [SendAnimationRequest] -> Encoding
ToMultipart Tmp SendAnimationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toMultipart :: SendAnimationRequest -> MultipartData Tmp
type Rep SendAnimationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendAnimationRequest = D1 ('MetaData "SendAnimationRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendAnimationRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendAnimationChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "sendAnimationAnimation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputFile) :: S1 ('MetaSel ('Just "sendAnimationDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "sendAnimationWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "sendAnimationHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "sendAnimationThumb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InputFile)) :: S1 ('MetaSel ('Just "sendAnimationCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "sendAnimationParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode)) :: (S1 ('MetaSel ('Just "sendAnimationCaptionEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity])) :: S1 ('MetaSel ('Just "sendAnimationDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "sendAnimationProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendAnimationReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :: (S1 ('MetaSel ('Just "sendAnimationAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendAnimationReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

type SendAnimationContent = "sendAnimation" :> (MultipartForm Tmp SendAnimationRequest :> Post '[JSON] (Response Message)) Source #

type SendAnimationLink = "sendAnimation" :> (ReqBody '[JSON] SendAnimationRequest :> Post '[JSON] (Response Message)) Source #

sendAnimation :: SendAnimationRequest -> ClientM (Response Message) Source #

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

data SendVoiceRequest Source #

Request parameters for sendVoice.

Constructors

SendVoiceRequest

Fields

sendVoiceChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
sendVoiceVoice :: InputFile
Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »
sendVoiceCaption :: Maybe Text
Voice message caption, 0-1024 characters after entities parsing
sendVoiceParseMode :: 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.
sendVoiceCaptionEntities :: Maybe [MessageEntity]
A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
sendVoiceDuration :: Maybe Int
Duration of the voice message in seconds
sendVoiceDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendVoiceProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving
sendVoiceReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message
sendVoiceAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found
sendVoiceReplyMarkup :: 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

Generic SendVoiceRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendVoiceRequest :: Type -> Type # Methods from :: SendVoiceRequest -> Rep SendVoiceRequest x # to :: Rep SendVoiceRequest x -> SendVoiceRequest #
ToJSON SendVoiceRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendVoiceRequest -> Value toEncoding :: SendVoiceRequest -> Encoding toJSONList :: [SendVoiceRequest] -> Value toEncodingList :: [SendVoiceRequest] -> Encoding
ToMultipart Tmp SendVoiceRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toMultipart :: SendVoiceRequest -> MultipartData Tmp
type Rep SendVoiceRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendVoiceRequest = D1 ('MetaData "SendVoiceRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendVoiceRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendVoiceChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: S1 ('MetaSel ('Just "sendVoiceVoice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputFile)) :: (S1 ('MetaSel ('Just "sendVoiceCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sendVoiceParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode)) :: S1 ('MetaSel ('Just "sendVoiceCaptionEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity]))))) :: ((S1 ('MetaSel ('Just "sendVoiceDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "sendVoiceDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendVoiceProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "sendVoiceReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :: (S1 ('MetaSel ('Just "sendVoiceAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendVoiceReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

type SendVoiceContent = "sendVoice" :> (MultipartForm Tmp SendVoiceRequest :> Post '[JSON] (Response Message)) Source #

type SendVoiceLink = "sendVoice" :> (ReqBody '[JSON] SendVoiceRequest :> Post '[JSON] (Response Message)) Source #

sendVoice :: SendVoiceRequest -> ClientM (Response Message) Source #

Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

data SendVideoNoteRequest Source #

Request parameters for sendVideoNote.

Constructors

SendVideoNoteRequest

Fields

sendVideoNoteChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
sendVideoNoteVideoNote :: InputFile
Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More info on Sending Files ». Sending video notes by a URL is currently unsupported
sendVideoNoteDuration :: Maybe Int
Duration of sent video in seconds
sendVideoNoteLength :: Maybe Int
Video width and height, i.e. diameter of the video message
sendVideoNoteThumb :: Maybe InputFile
Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipartform-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach:file_attach_name” if the thumbnail was uploaded using multipartform-data under file_attach_name. More info on Sending Files »
sendVideoNoteDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendVideoNoteProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving
sendVideoNoteReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message
sendVideoNoteAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found
sendVideoNoteReplyMarkup :: 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

Generic SendVideoNoteRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendVideoNoteRequest :: Type -> Type # Methods from :: SendVideoNoteRequest -> Rep SendVideoNoteRequest x # to :: Rep SendVideoNoteRequest x -> SendVideoNoteRequest #
ToJSON SendVideoNoteRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendVideoNoteRequest -> Value toEncoding :: SendVideoNoteRequest -> Encoding toJSONList :: [SendVideoNoteRequest] -> Value toEncodingList :: [SendVideoNoteRequest] -> Encoding
ToMultipart Tmp SendVideoNoteRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toMultipart :: SendVideoNoteRequest -> MultipartData Tmp
type Rep SendVideoNoteRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendVideoNoteRequest = D1 ('MetaData "SendVideoNoteRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendVideoNoteRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendVideoNoteChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: S1 ('MetaSel ('Just "sendVideoNoteVideoNote") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputFile)) :: (S1 ('MetaSel ('Just "sendVideoNoteDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "sendVideoNoteLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "sendVideoNoteThumb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InputFile))))) :: ((S1 ('MetaSel ('Just "sendVideoNoteDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendVideoNoteProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "sendVideoNoteReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :: (S1 ('MetaSel ('Just "sendVideoNoteAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendVideoNoteReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

type SendVideoNoteContent = "sendVideoNote" :> (MultipartForm Tmp SendVideoNoteRequest :> Post '[JSON] (Response Message)) Source #

type SendVideoNoteLink = "sendVideoNote" :> (ReqBody '[JSON] SendVideoNoteRequest :> Post '[JSON] (Response Message)) Source #

sendVideoNote :: SendVideoNoteRequest -> ClientM (Response Message) Source #

As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

data SendMediaGroupRequest Source #

Request parameters for sendMediaGroup.

Constructors

SendMediaGroupRequest

Fields

sendMediaGroupChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
sendMediaGroupMedia :: [InputMedia]
A JSON-serialized array describing messages to be sent, must include 2-10 items. InputMediaAudio, InputMediaDocument, InputMediaPhoto or InputMediaVideo.
sendMediaGroupDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendMediaGroupProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving
sendMediaGroupReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message
sendMediaGroupAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found
sendMediaGroupReplyMarkup :: 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

Generic SendMediaGroupRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendMediaGroupRequest :: Type -> Type # Methods from :: SendMediaGroupRequest -> Rep SendMediaGroupRequest x # to :: Rep SendMediaGroupRequest x -> SendMediaGroupRequest #
ToJSON SendMediaGroupRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendMediaGroupRequest -> Value toEncoding :: SendMediaGroupRequest -> Encoding toJSONList :: [SendMediaGroupRequest] -> Value toEncodingList :: [SendMediaGroupRequest] -> Encoding
type Rep SendMediaGroupRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendMediaGroupRequest = D1 ('MetaData "SendMediaGroupRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendMediaGroupRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sendMediaGroupChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "sendMediaGroupMedia") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [InputMedia]) :: S1 ('MetaSel ('Just "sendMediaGroupDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "sendMediaGroupProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendMediaGroupReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :: (S1 ('MetaSel ('Just "sendMediaGroupAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendMediaGroupReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup))))))

type SendMediaGroup = "sendMediaGroup" :> (ReqBody '[JSON] SendMediaGroupRequest :> Post '[JSON] (Response [Message])) Source #

sendMediaGroup :: SendMediaGroupRequest -> ClientM (Response [Message]) Source #

Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.

data SendLocationRequest Source #

Request parameters for sendLocation.

Constructors

SendLocationRequest

Fields

sendLocationChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
sendLocationLatitude :: Float
Latitude of new location
sendLocationLongitude :: Float
Longitude of new location
sendLocationHorizontalAccuracy :: Maybe Float
The radius of uncertainty for the location, measured in meters; 0-1500
sendLocationLivePeriod :: Int
Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.)
sendLocationHeading :: Maybe Int
Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
sendLocationProximityAlertRadius :: Maybe Int
Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
sendLocationDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendLocationProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving
sendLocationReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message
sendLocationAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found
sendLocationReplyMarkup :: 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

Generic SendLocationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendLocationRequest :: Type -> Type # Methods from :: SendLocationRequest -> Rep SendLocationRequest x # to :: Rep SendLocationRequest x -> SendLocationRequest #
FromJSON SendLocationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SendLocationRequest parseJSONList :: Value -> Parser [SendLocationRequest]
ToJSON SendLocationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendLocationRequest -> Value toEncoding :: SendLocationRequest -> Encoding toJSONList :: [SendLocationRequest] -> Value toEncodingList :: [SendLocationRequest] -> Encoding
type Rep SendLocationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendLocationRequest = D1 ('MetaData "SendLocationRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendLocationRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendLocationChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "sendLocationLatitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float) :: S1 ('MetaSel ('Just "sendLocationLongitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float))) :: (S1 ('MetaSel ('Just "sendLocationHorizontalAccuracy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Float)) :: (S1 ('MetaSel ('Just "sendLocationLivePeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: S1 ('MetaSel ('Just "sendLocationHeading") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "sendLocationProximityAlertRadius") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "sendLocationDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendLocationProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "sendLocationReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :: (S1 ('MetaSel ('Just "sendLocationAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendLocationReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

data EditMessageLiveLocationRequest Source #

Request parameters for editMessageLiveLocation.

Constructors

EditMessageLiveLocationRequest

Fields

editMessageLiveLocationChatId :: Maybe SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
editMessageLiveLocationMessageId :: Maybe MessageId
Required if inline_message_id is not specified. Identifier of the message with live location to stop
editMessageLiveLocationInlineMessageId :: Maybe Text
Required if chat_id and message_id are not specified. Identifier of the inline message
editMessageLiveLocationLatitude :: Float
Latitude of new location
editMessageLiveLocationLongitude :: Float
Longitude of new location
editMessageLiveLocationHorizontalAccuracy :: Maybe Float
The radius of uncertainty for the location, measured in meters; 0-1500
editMessageLiveLocationHeading :: Maybe Int
Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
editMessageLiveLocationProximityAlertRadius :: Maybe Int
Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
editMessageLiveLocationReplyMarkup :: 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

Generic EditMessageLiveLocationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep EditMessageLiveLocationRequest :: Type -> Type # Methods from :: EditMessageLiveLocationRequest -> Rep EditMessageLiveLocationRequest x # to :: Rep EditMessageLiveLocationRequest x -> EditMessageLiveLocationRequest #
FromJSON EditMessageLiveLocationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser EditMessageLiveLocationRequest parseJSONList :: Value -> Parser [EditMessageLiveLocationRequest]
ToJSON EditMessageLiveLocationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: EditMessageLiveLocationRequest -> Value toEncoding :: EditMessageLiveLocationRequest -> Encoding toJSONList :: [EditMessageLiveLocationRequest] -> Value toEncodingList :: [EditMessageLiveLocationRequest] -> Encoding
type Rep EditMessageLiveLocationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep EditMessageLiveLocationRequest = D1 ('MetaData "EditMessageLiveLocationRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "EditMessageLiveLocationRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "editMessageLiveLocationChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeChatId)) :: S1 ('MetaSel ('Just "editMessageLiveLocationMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :: (S1 ('MetaSel ('Just "editMessageLiveLocationInlineMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "editMessageLiveLocationLatitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float))) :: ((S1 ('MetaSel ('Just "editMessageLiveLocationLongitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float) :: S1 ('MetaSel ('Just "editMessageLiveLocationHorizontalAccuracy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Float))) :: (S1 ('MetaSel ('Just "editMessageLiveLocationHeading") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "editMessageLiveLocationProximityAlertRadius") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "editMessageLiveLocationReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

data StopMessageLiveLocationRequest Source #

Request parameters for stopMessageLiveLocation.

Constructors

StopMessageLiveLocationRequest

Fields

stopMessageLiveLocationChatId :: Maybe SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
stopMessageLiveLocationMessageId :: Maybe MessageId
Required if inline_message_id is not specified. Identifier of the message with live location to stop
stopMessageLiveLocationInlineMessageId :: Maybe Text
Required if chat_id and message_id are not specified. Identifier of the inline message
stopMessageLiveLocationReplyMarkup :: 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

Generic StopMessageLiveLocationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep StopMessageLiveLocationRequest :: Type -> Type # Methods from :: StopMessageLiveLocationRequest -> Rep StopMessageLiveLocationRequest x # to :: Rep StopMessageLiveLocationRequest x -> StopMessageLiveLocationRequest #
FromJSON StopMessageLiveLocationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser StopMessageLiveLocationRequest parseJSONList :: Value -> Parser [StopMessageLiveLocationRequest]
ToJSON StopMessageLiveLocationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: StopMessageLiveLocationRequest -> Value toEncoding :: StopMessageLiveLocationRequest -> Encoding toJSONList :: [StopMessageLiveLocationRequest] -> Value toEncodingList :: [StopMessageLiveLocationRequest] -> Encoding
type Rep StopMessageLiveLocationRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep StopMessageLiveLocationRequest = D1 ('MetaData "StopMessageLiveLocationRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "StopMessageLiveLocationRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stopMessageLiveLocationChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeChatId)) :: S1 ('MetaSel ('Just "stopMessageLiveLocationMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :: (S1 ('MetaSel ('Just "stopMessageLiveLocationInlineMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stopMessageLiveLocationReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))

data SendVenueRequest Source #

Request parameters for sendVenue.

Constructors

SendVenueRequest

Fields

sendVenueChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
sendVenueLatitude :: Float
Latitude of the venue
sendVenueLongitude :: Float
Longitude of the venue
sendVenueTitle :: Text
Name of the venue
sendVenueAddress :: Text
Address of the venue
sendVenueFoursquareId :: Maybe Text
Foursquare identifier of the venue
sendVenueFoursquareType :: Maybe Text
Foursquare type of the venue, if known. (For example, “arts_entertainmentdefault”, “arts_entertainmentaquarium” or “food/icecream”.)
sendVenueGooglePlaceId :: Maybe Text
Google Places identifier of the venue
sendVenueGooglePlaceType :: Maybe Text
Google Places type of the venue. (See supported types https://developers.google.com/maps/documentation/places/web-service/supported_types.)
sendVenueDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendVenueProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving
sendVenueReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message
sendVenueAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found
sendVenueReplyMarkup :: 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

Generic SendVenueRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendVenueRequest :: Type -> Type # Methods from :: SendVenueRequest -> Rep SendVenueRequest x # to :: Rep SendVenueRequest x -> SendVenueRequest #
FromJSON SendVenueRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SendVenueRequest parseJSONList :: Value -> Parser [SendVenueRequest]
ToJSON SendVenueRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendVenueRequest -> Value toEncoding :: SendVenueRequest -> Encoding toJSONList :: [SendVenueRequest] -> Value toEncodingList :: [SendVenueRequest] -> Encoding
type Rep SendVenueRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendVenueRequest = D1 ('MetaData "SendVenueRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendVenueRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendVenueChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "sendVenueLatitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float) :: S1 ('MetaSel ('Just "sendVenueLongitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float))) :: ((S1 ('MetaSel ('Just "sendVenueTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "sendVenueAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "sendVenueFoursquareId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sendVenueFoursquareType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "sendVenueGooglePlaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sendVenueGooglePlaceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sendVenueDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "sendVenueProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendVenueReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :: (S1 ('MetaSel ('Just "sendVenueAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendVenueReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

data SendContactRequest Source #

Request parameters for sendContact.

Constructors

SendContactRequest

Fields

sendContactChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
sendContactPhoneNumber :: Text
Contact's phone number
sendContactFirstName :: Text
Contact's first name
sendContactLastName :: Text
Contact's last name
sendContactVcard :: Text
Additional data about the contact in the form of a vCard, 0-2048 bytes
sendContactDisableNotification :: Maybe Bool
Sends the message silently. Users will receive a notification with no sound.
sendContactProtectContent :: Maybe Bool
Protects the contents of the sent message from forwarding and saving
sendContactReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message
sendContactAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found
sendContactReplyMarkup :: 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

Generic SendContactRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendContactRequest :: Type -> Type # Methods from :: SendContactRequest -> Rep SendContactRequest x # to :: Rep SendContactRequest x -> SendContactRequest #
FromJSON SendContactRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SendContactRequest parseJSONList :: Value -> Parser [SendContactRequest]
ToJSON SendContactRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendContactRequest -> Value toEncoding :: SendContactRequest -> Encoding toJSONList :: [SendContactRequest] -> Value toEncodingList :: [SendContactRequest] -> Encoding
type Rep SendContactRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendContactRequest = D1 ('MetaData "SendContactRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendContactRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendContactChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: S1 ('MetaSel ('Just "sendContactPhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "sendContactFirstName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "sendContactLastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "sendContactVcard") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "sendContactDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendContactProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "sendContactReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :: (S1 ('MetaSel ('Just "sendContactAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendContactReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

data SendPollRequest Source #

Request parameters for sendPoll.

Constructors

SendPollRequest

Fields

sendPollChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
sendPollQuestion :: Text
Poll question, 1-300 characters
sendPollOptions :: [Text]
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
sendPollReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message
sendPollAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found
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

Generic SendPollRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendPollRequest :: Type -> Type # Methods from :: SendPollRequest -> Rep SendPollRequest x # to :: Rep SendPollRequest x -> SendPollRequest #
FromJSON SendPollRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SendPollRequest parseJSONList :: Value -> Parser [SendPollRequest]
ToJSON SendPollRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendPollRequest -> Value toEncoding :: SendPollRequest -> Encoding toJSONList :: [SendPollRequest] -> Value toEncodingList :: [SendPollRequest] -> Encoding
type Rep SendPollRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendPollRequest = D1 ('MetaData "SendPollRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendPollRequest" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "sendPollChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: S1 ('MetaSel ('Just "sendPollQuestion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "sendPollOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]) :: 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 "sendPollReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :: (S1 ('MetaSel ('Just "sendPollAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendPollReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup))))))))

data SendDiceRequest Source #

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)
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

Instances details

Generic SendDiceRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendDiceRequest :: Type -> Type # Methods from :: SendDiceRequest -> Rep SendDiceRequest x # to :: Rep SendDiceRequest x -> SendDiceRequest #
FromJSON SendDiceRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SendDiceRequest parseJSONList :: Value -> Parser [SendDiceRequest]
ToJSON SendDiceRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendDiceRequest -> Value toEncoding :: SendDiceRequest -> Encoding toJSONList :: [SendDiceRequest] -> Value toEncodingList :: [SendDiceRequest] -> Encoding
type Rep SendDiceRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendDiceRequest = D1 ('MetaData "SendDiceRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendDiceRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sendDiceChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (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 SendChatAction = "sendChatAction" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "action" Text :> Post '[JSON] (Response Bool))) Source #

sendChatAction Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> Text	Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.
-> ClientM (Response Bool)

Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.

Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot.

We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

data GetUserProfilePhotosRequest Source #

Request parameters for getUserProfilePhotos.

Constructors

GetUserProfilePhotosRequest
Fields getUserProfilePhotosUserId :: UserId Unique identifier of the target user getUserProfilePhotosOffset :: Maybe Int Sequential number of the first photo to be returned. By default, all photos are returned. getUserProfilePhotosLimit :: Maybe Int Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.

Instances

Instances details

Generic GetUserProfilePhotosRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep GetUserProfilePhotosRequest :: Type -> Type # Methods from :: GetUserProfilePhotosRequest -> Rep GetUserProfilePhotosRequest x # to :: Rep GetUserProfilePhotosRequest x -> GetUserProfilePhotosRequest #
FromJSON GetUserProfilePhotosRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser GetUserProfilePhotosRequest parseJSONList :: Value -> Parser [GetUserProfilePhotosRequest]
ToJSON GetUserProfilePhotosRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: GetUserProfilePhotosRequest -> Value toEncoding :: GetUserProfilePhotosRequest -> Encoding toJSONList :: [GetUserProfilePhotosRequest] -> Value toEncodingList :: [GetUserProfilePhotosRequest] -> Encoding
type Rep GetUserProfilePhotosRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep GetUserProfilePhotosRequest = D1 ('MetaData "GetUserProfilePhotosRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "GetUserProfilePhotosRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "getUserProfilePhotosUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :: (S1 ('MetaSel ('Just "getUserProfilePhotosOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "getUserProfilePhotosLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))))

data BanChatMemberRequest Source #

Request parameters for banChatMember.

Constructors

BanChatMemberRequest

Fields

banChatMemberChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
banChatMemberUserId :: UserId
Unique identifier of the target user
banChatMemberUntilDate :: Maybe Int
Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.
banChatMemberRevokeMessages :: Maybe Bool
Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.

Instances

Instances details

Generic BanChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep BanChatMemberRequest :: Type -> Type # Methods from :: BanChatMemberRequest -> Rep BanChatMemberRequest x # to :: Rep BanChatMemberRequest x -> BanChatMemberRequest #
FromJSON BanChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser BanChatMemberRequest parseJSONList :: Value -> Parser [BanChatMemberRequest]
ToJSON BanChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: BanChatMemberRequest -> Value toEncoding :: BanChatMemberRequest -> Encoding toJSONList :: [BanChatMemberRequest] -> Value toEncodingList :: [BanChatMemberRequest] -> Encoding
type Rep BanChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep BanChatMemberRequest = D1 ('MetaData "BanChatMemberRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "BanChatMemberRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "banChatMemberChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: S1 ('MetaSel ('Just "banChatMemberUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId)) :: (S1 ('MetaSel ('Just "banChatMemberUntilDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "banChatMemberRevokeMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

data UnbanChatMemberRequest Source #

Request parameters for unbanChatMember.

Constructors

UnbanChatMemberRequest
Fields unbanChatMemberChatId :: SomeChatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) unbanChatMemberUserId :: UserId Unique identifier of the target user unbanChatMemberOnlyIfBanned :: Maybe Bool Do nothing if the user is not banned

Instances

Instances details

Generic UnbanChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep UnbanChatMemberRequest :: Type -> Type # Methods from :: UnbanChatMemberRequest -> Rep UnbanChatMemberRequest x # to :: Rep UnbanChatMemberRequest x -> UnbanChatMemberRequest #
FromJSON UnbanChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser UnbanChatMemberRequest parseJSONList :: Value -> Parser [UnbanChatMemberRequest]
ToJSON UnbanChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: UnbanChatMemberRequest -> Value toEncoding :: UnbanChatMemberRequest -> Encoding toJSONList :: [UnbanChatMemberRequest] -> Value toEncodingList :: [UnbanChatMemberRequest] -> Encoding
type Rep UnbanChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep UnbanChatMemberRequest = D1 ('MetaData "UnbanChatMemberRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "UnbanChatMemberRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "unbanChatMemberChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "unbanChatMemberUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :: S1 ('MetaSel ('Just "unbanChatMemberOnlyIfBanned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

data RestrictChatMemberRequest Source #

Request parameters for restrictChatMember.

Constructors

RestrictChatMemberRequest

Fields

restrictChatMemberChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
restrictChatMemberUserId :: UserId
Unique identifier of the target user
restrictChatMemberPermissions :: ChatPermissions
A JSON-serialized object for new user permissions
restrictChatMemberUntilDate :: Maybe Int
Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever

Instances

Instances details

Generic RestrictChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep RestrictChatMemberRequest :: Type -> Type # Methods from :: RestrictChatMemberRequest -> Rep RestrictChatMemberRequest x # to :: Rep RestrictChatMemberRequest x -> RestrictChatMemberRequest #
FromJSON RestrictChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser RestrictChatMemberRequest parseJSONList :: Value -> Parser [RestrictChatMemberRequest]
ToJSON RestrictChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: RestrictChatMemberRequest -> Value toEncoding :: RestrictChatMemberRequest -> Encoding toJSONList :: [RestrictChatMemberRequest] -> Value toEncodingList :: [RestrictChatMemberRequest] -> Encoding
type Rep RestrictChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep RestrictChatMemberRequest = D1 ('MetaData "RestrictChatMemberRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "RestrictChatMemberRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "restrictChatMemberChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: S1 ('MetaSel ('Just "restrictChatMemberUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId)) :: (S1 ('MetaSel ('Just "restrictChatMemberPermissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChatPermissions) :*: S1 ('MetaSel ('Just "restrictChatMemberUntilDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))))

data PromoteChatMemberRequest Source #

Request parameters for promoteChatMember.

Constructors

PromoteChatMemberRequest

Fields

promoteChatMemberChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
promoteChatMemberUserId :: UserId
Unique identifier of the target user
promoteChatMemberIsAnonymous :: Maybe Bool
Pass True, if the administrator's presence in the chat is hidden
promoteChatMemberCanManageChat :: Maybe Bool
Pass True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege
promoteChatMemberCanPostMessages :: Maybe Bool
Pass True, if the administrator can create channel posts, channels only
promoteChatMemberCanEditMessages :: Maybe Bool
Pass True, if the administrator can edit messages of other users and can pin messages, channels only
promoteChatMemberCanDeleteMessages :: Maybe Bool
Pass True, if the administrator can delete messages of other users
promoteChatMemberCanManageVideoChats :: Maybe Bool
Pass True, if the administrator can manage video chats
promoteChatMemberCanRestrictMembers :: Maybe Bool
Pass True, if the administrator can restrict, ban or unban chat members
promoteChatMemberCanPromoteMembers :: Maybe Bool
Pass True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him)
promoteChatMemberCanChangeInfo :: Maybe Bool
Pass True, if the administrator can change chat title, photo and other settings
promoteChatMemberCanInviteUsers :: Maybe Bool
Pass True, if the administrator can invite new users to the chat
promoteChatMemberCanPinMessages :: Maybe Bool
Pass True, if the administrator can pin messages, supergroups only

Instances

Instances details

Generic PromoteChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep PromoteChatMemberRequest :: Type -> Type # Methods from :: PromoteChatMemberRequest -> Rep PromoteChatMemberRequest x # to :: Rep PromoteChatMemberRequest x -> PromoteChatMemberRequest #
FromJSON PromoteChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser PromoteChatMemberRequest parseJSONList :: Value -> Parser [PromoteChatMemberRequest]
ToJSON PromoteChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: PromoteChatMemberRequest -> Value toEncoding :: PromoteChatMemberRequest -> Encoding toJSONList :: [PromoteChatMemberRequest] -> Value toEncodingList :: [PromoteChatMemberRequest] -> Encoding
type Rep PromoteChatMemberRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep PromoteChatMemberRequest = D1 ('MetaData "PromoteChatMemberRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "PromoteChatMemberRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "promoteChatMemberChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "promoteChatMemberUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :: S1 ('MetaSel ('Just "promoteChatMemberIsAnonymous") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "promoteChatMemberCanManageChat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "promoteChatMemberCanPostMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "promoteChatMemberCanEditMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "promoteChatMemberCanDeleteMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "promoteChatMemberCanManageVideoChats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "promoteChatMemberCanRestrictMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "promoteChatMemberCanPromoteMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "promoteChatMemberCanChangeInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "promoteChatMemberCanInviteUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "promoteChatMemberCanPinMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))))

data SetChatAdministratorCustomTitleRequest Source #

Request parameters for setChatAdministratorCustomTitle.

Constructors

SetChatAdministratorCustomTitleRequest
Fields setChatAdministratorCustomTitleChatId :: SomeChatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) setChatAdministratorCustomTitleUserId :: UserId Unique identifier of the target user setChatAdministratorCustomTitleCustomTitle :: Text New custom title for the administrator; 0-16 characters, emoji are not allowed

Instances

Instances details

Generic SetChatAdministratorCustomTitleRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SetChatAdministratorCustomTitleRequest :: Type -> Type # Methods from :: SetChatAdministratorCustomTitleRequest -> Rep SetChatAdministratorCustomTitleRequest x # to :: Rep SetChatAdministratorCustomTitleRequest x -> SetChatAdministratorCustomTitleRequest #
FromJSON SetChatAdministratorCustomTitleRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SetChatAdministratorCustomTitleRequest parseJSONList :: Value -> Parser [SetChatAdministratorCustomTitleRequest]
ToJSON SetChatAdministratorCustomTitleRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SetChatAdministratorCustomTitleRequest -> Value toEncoding :: SetChatAdministratorCustomTitleRequest -> Encoding toJSONList :: [SetChatAdministratorCustomTitleRequest] -> Value toEncodingList :: [SetChatAdministratorCustomTitleRequest] -> Encoding
type Rep SetChatAdministratorCustomTitleRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SetChatAdministratorCustomTitleRequest = D1 ('MetaData "SetChatAdministratorCustomTitleRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SetChatAdministratorCustomTitleRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "setChatAdministratorCustomTitleChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "setChatAdministratorCustomTitleUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :: S1 ('MetaSel ('Just "setChatAdministratorCustomTitleCustomTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

type BanChatSenderChat = "banChatSenderChat" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "sender_chat_id" ChatId :> Post '[JSON] (Response Bool))) Source #

banChatSenderChat Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> ChatId	Unique identifier of the target sender chat
-> ClientM (Response Bool)

Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

type UnbanChatSenderChat = "unbanChatSenderChat" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "sender_chat_id" ChatId :> Post '[JSON] (Response Bool))) Source #

unbanChatSenderChat Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> ChatId	Unique identifier of the target sender chat
-> ClientM (Response Bool)

Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

data SetChatPermissionsRequest Source #

Request parameters for setChatPermissions.

Constructors

SetChatPermissionsRequest
Fields setChatPermissionsChatId :: SomeChatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) setChatPermissionsPermissions :: ChatPermissions A JSON-serialized object for new default chat permissions

Instances

Instances details

Generic SetChatPermissionsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SetChatPermissionsRequest :: Type -> Type # Methods from :: SetChatPermissionsRequest -> Rep SetChatPermissionsRequest x # to :: Rep SetChatPermissionsRequest x -> SetChatPermissionsRequest #
FromJSON SetChatPermissionsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SetChatPermissionsRequest parseJSONList :: Value -> Parser [SetChatPermissionsRequest]
ToJSON SetChatPermissionsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SetChatPermissionsRequest -> Value toEncoding :: SetChatPermissionsRequest -> Encoding toJSONList :: [SetChatPermissionsRequest] -> Value toEncodingList :: [SetChatPermissionsRequest] -> Encoding
type Rep SetChatPermissionsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SetChatPermissionsRequest = D1 ('MetaData "SetChatPermissionsRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SetChatPermissionsRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "setChatPermissionsChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "setChatPermissionsPermissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChatPermissions)))

type ExportChatInviteLink = "exportChatInviteLink" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Text)) Source #

exportChatInviteLink Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> ClientM (Response Text)

Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

data CreateChatInviteLinkRequest Source #

Request parameters for createChatInviteLink.

Constructors

CreateChatInviteLinkRequest

Fields

createChatInviteLinkChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
createChatInviteLinkName :: Maybe Text
Invite link name; 0-32 characters
createChatInviteLinkExpireDate :: Maybe Integer
Point in time (Unix timestamp) when the link will expire
createChatInviteLinkMemberLimit :: Maybe Int
Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
createChatInviteLinkCreatesJoinRequest :: Maybe Bool
True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified

Instances

Instances details

Generic CreateChatInviteLinkRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep CreateChatInviteLinkRequest :: Type -> Type # Methods from :: CreateChatInviteLinkRequest -> Rep CreateChatInviteLinkRequest x # to :: Rep CreateChatInviteLinkRequest x -> CreateChatInviteLinkRequest #
FromJSON CreateChatInviteLinkRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser CreateChatInviteLinkRequest parseJSONList :: Value -> Parser [CreateChatInviteLinkRequest]
ToJSON CreateChatInviteLinkRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: CreateChatInviteLinkRequest -> Value toEncoding :: CreateChatInviteLinkRequest -> Encoding toJSONList :: [CreateChatInviteLinkRequest] -> Value toEncodingList :: [CreateChatInviteLinkRequest] -> Encoding
type Rep CreateChatInviteLinkRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep CreateChatInviteLinkRequest = D1 ('MetaData "CreateChatInviteLinkRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "CreateChatInviteLinkRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createChatInviteLinkChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: S1 ('MetaSel ('Just "createChatInviteLinkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createChatInviteLinkExpireDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "createChatInviteLinkMemberLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "createChatInviteLinkCreatesJoinRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))

data EditChatInviteLinkRequest Source #

Request parameters for editChatInviteLink.

Constructors

EditChatInviteLinkRequest

Fields

editChatInviteLinkChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
editChatInviteLinkInviteLink :: Text
The invite link to edit
editChatInviteLinkName :: Maybe Text
Invite link name; 0-32 characters
editChatInviteLinkExpireDate :: Maybe Integer
Point in time (Unix timestamp) when the link will expire
editChatInviteLinkMemberLimit :: Maybe Int
Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
editChatInviteLinkCreatesJoinRequest :: Maybe Bool
True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified

Instances

Instances details

Generic EditChatInviteLinkRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep EditChatInviteLinkRequest :: Type -> Type # Methods from :: EditChatInviteLinkRequest -> Rep EditChatInviteLinkRequest x # to :: Rep EditChatInviteLinkRequest x -> EditChatInviteLinkRequest #
FromJSON EditChatInviteLinkRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser EditChatInviteLinkRequest parseJSONList :: Value -> Parser [EditChatInviteLinkRequest]
ToJSON EditChatInviteLinkRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: EditChatInviteLinkRequest -> Value toEncoding :: EditChatInviteLinkRequest -> Encoding toJSONList :: [EditChatInviteLinkRequest] -> Value toEncodingList :: [EditChatInviteLinkRequest] -> Encoding
type Rep EditChatInviteLinkRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep EditChatInviteLinkRequest = D1 ('MetaData "EditChatInviteLinkRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "EditChatInviteLinkRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "editChatInviteLinkChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "editChatInviteLinkInviteLink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "editChatInviteLinkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "editChatInviteLinkExpireDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "editChatInviteLinkMemberLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "editChatInviteLinkCreatesJoinRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))

type RevokeChatInviteLink = "revokeChatInviteLink" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "invite_link" Text :> Post '[JSON] (Response ChatInviteLink))) Source #

revokeChatInviteLink Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> Text	The invite link to revoke
-> ClientM (Response ChatInviteLink)

Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.

type ApproveChatJoinRequest = "approveChatJoinRequest" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "user_id" UserId :> Post '[JSON] (Response Bool))) Source #

approveChatJoinRequest Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> UserId	Unique identifier of the target user
-> ClientM (Response Bool)

Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

type DeclineChatJoinRequest = "declineChatJoinRequest" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "user_id" UserId :> Post '[JSON] (Response Bool))) Source #

declineChatJoinRequest Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> UserId	Unique identifier of the target user
-> ClientM (Response Bool)

Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

data SetChatPhotoRequest Source #

Request parameters for setChatPhoto.

Constructors

SetChatPhotoRequest
Fields setChatPhotoChatId :: SomeChatId Unique identifier for the target chat or username of the target channel (in the format @channelusername) setChatPhotoPhoto :: InputFile New chat photo, uploaded using multipart/form-data

Instances

Instances details

ToMultipart Tmp SetChatPhotoRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toMultipart :: SetChatPhotoRequest -> MultipartData Tmp

type SetChatPhoto = "setChatPhoto" :> (MultipartForm Tmp SetChatPhotoRequest :> Post '[JSON] (Response Bool)) Source #

setChatPhoto :: SetChatPhotoRequest -> ClientM (Response Bool) Source #

Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Note*: Only InputFile case might be used in SetChatPhotoRequest. Rest cases will be rejected by Telegram.

type DeleteChatPhoto = "deleteChatPhoto" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool)) Source #

deleteChatPhoto Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> ClientM (Response Bool)

Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

type SetChatTitle = "setChatTitle" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "title" Text :> Post '[JSON] (Response Bool))) Source #

setChatTitle Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> Text	New chat title, 0-255 characters
-> ClientM (Response Bool)

Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

type SetChatDescription = "setChatDescription" :> (RequiredQueryParam "chat_id" SomeChatId :> (QueryParam "description" Text :> Post '[JSON] (Response Bool))) Source #

setChatDescription Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> Maybe Text	New chat description, 0-255 characters
-> ClientM (Response Bool)

Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

data PinChatMessageRequest Source #

Request parameters for pinChatMessage.

Constructors

PinChatMessageRequest

Fields

pinChatMessageChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
pinChatMessageMessageId :: MessageId
Identifier of a message to pin
pinChatMessageDisableNotification :: Maybe Bool
Pass True, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.

Instances

Instances details

Generic PinChatMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep PinChatMessageRequest :: Type -> Type # Methods from :: PinChatMessageRequest -> Rep PinChatMessageRequest x # to :: Rep PinChatMessageRequest x -> PinChatMessageRequest #
FromJSON PinChatMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser PinChatMessageRequest parseJSONList :: Value -> Parser [PinChatMessageRequest]
ToJSON PinChatMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: PinChatMessageRequest -> Value toEncoding :: PinChatMessageRequest -> Encoding toJSONList :: [PinChatMessageRequest] -> Value toEncodingList :: [PinChatMessageRequest] -> Encoding
type Rep PinChatMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep PinChatMessageRequest = D1 ('MetaData "PinChatMessageRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "PinChatMessageRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "pinChatMessageChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "pinChatMessageMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageId) :: S1 ('MetaSel ('Just "pinChatMessageDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

type UnpinChatMessage = "unpinChatMessage" :> (RequiredQueryParam "chat_id" SomeChatId :> (QueryParam "message_id" MessageId :> Post '[JSON] (Response Bool))) Source #

unpinChatMessage Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> Maybe MessageId	Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.
-> ClientM (Response Bool)

Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in a supergroup or can_edit_messages administrator right in a channel. Returns True on success.

type UnpinAllChatMessages = "unpinAllChatMessages" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool)) Source #

unpinAllChatMessages Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> ClientM (Response Bool)

Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in a supergroup or can_edit_messages administrator right in a channel. Returns True on success.

type LeaveChat = "leaveChat" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool)) Source #

leaveChat Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> ClientM (Response Bool)

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

type GetChat = "getChat" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Chat)) Source #

getChat Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> ClientM (Response Chat)

Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.

type GetChatAdministrators = "getChatAdministrators" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response [ChatMember])) Source #

getChatAdministrators Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> ClientM (Response [ChatMember])

Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.

type GetChatMemberCount = "getChatMemberCount" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Integer)) Source #

getChatMemberCount Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> ClientM (Response Integer)

Use this method to get the number of members in a chat. Returns Int on success.

type GetChatMember = "getChatMember" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "user_id" UserId :> Post '[JSON] (Response ChatMember))) Source #

getChatMember Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> UserId	Unique identifier of the target user
-> ClientM (Response ChatMember)

Use this method to get information about a member of a chat. Returns a ChatMember object on success.

type SetChatStickerSet = "setChatStickerSet" :> (RequiredQueryParam "chat_id" SomeChatId :> (RequiredQueryParam "sticker_set_name" Text :> Post '[JSON] (Response Bool))) Source #

setChatStickerSet Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> Text	Name of the sticker set to be set as the group sticker set
-> ClientM (Response Bool)

Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

type DeleteChatStickerSet = "deleteChatStickerSet" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool)) Source #

deleteChatStickerSet Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> ClientM (Response Bool)

Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

data AnswerCallbackQueryRequest Source #

Request parameters for answerCallbackQuery.

Constructors

AnswerCallbackQueryRequest

Fields

answerCallbackQueryCallbackQueryId :: CallbackQueryId
Unique identifier for the query to be answered
answerCallbackQueryText :: Maybe Text
Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
answerCallbackQueryShowAlert :: Maybe Bool
If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
answerCallbackQueryUrl :: Maybe Text
URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game — note that this will only work if the query comes from a callback_game button.
Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
answerCallbackQueryCacheTime :: Maybe Integer
The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.

Instances

Instances details

Generic AnswerCallbackQueryRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep AnswerCallbackQueryRequest :: Type -> Type # Methods from :: AnswerCallbackQueryRequest -> Rep AnswerCallbackQueryRequest x # to :: Rep AnswerCallbackQueryRequest x -> AnswerCallbackQueryRequest #
FromJSON AnswerCallbackQueryRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser AnswerCallbackQueryRequest parseJSONList :: Value -> Parser [AnswerCallbackQueryRequest]
ToJSON AnswerCallbackQueryRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: AnswerCallbackQueryRequest -> Value toEncoding :: AnswerCallbackQueryRequest -> Encoding toJSONList :: [AnswerCallbackQueryRequest] -> Value toEncodingList :: [AnswerCallbackQueryRequest] -> Encoding
type Rep AnswerCallbackQueryRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep AnswerCallbackQueryRequest = D1 ('MetaData "AnswerCallbackQueryRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "AnswerCallbackQueryRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "answerCallbackQueryCallbackQueryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CallbackQueryId) :: S1 ('MetaSel ('Just "answerCallbackQueryText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "answerCallbackQueryShowAlert") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "answerCallbackQueryUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "answerCallbackQueryCacheTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))))))

data SetMyCommandsRequest Source #

Request parameters for setMyCommands.

Constructors

SetMyCommandsRequest

Fields

setMyCommandsCommands :: [BotCommand]
A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.
setMyCommandsScope :: Maybe BotCommandScope
A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
setMyCommandsLanguageCode :: Maybe Text
A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands

Instances

Instances details

Generic SetMyCommandsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SetMyCommandsRequest :: Type -> Type # Methods from :: SetMyCommandsRequest -> Rep SetMyCommandsRequest x # to :: Rep SetMyCommandsRequest x -> SetMyCommandsRequest #
FromJSON SetMyCommandsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SetMyCommandsRequest parseJSONList :: Value -> Parser [SetMyCommandsRequest]
ToJSON SetMyCommandsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SetMyCommandsRequest -> Value toEncoding :: SetMyCommandsRequest -> Encoding toJSONList :: [SetMyCommandsRequest] -> Value toEncodingList :: [SetMyCommandsRequest] -> Encoding
type Rep SetMyCommandsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SetMyCommandsRequest = D1 ('MetaData "SetMyCommandsRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SetMyCommandsRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "setMyCommandsCommands") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [BotCommand]) :: (S1 ('MetaSel ('Just "setMyCommandsScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BotCommandScope)) :: S1 ('MetaSel ('Just "setMyCommandsLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

data DeleteMyCommandsRequest Source #

Request parameters for deleteMyCommands.

Constructors

DeleteMyCommandsRequest
Fields deleteMyCommandsScope :: Maybe BotCommandScope A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault. deleteMyCommandsLanguageCode :: Maybe Text A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands

Instances

Instances details

Generic DeleteMyCommandsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep DeleteMyCommandsRequest :: Type -> Type # Methods from :: DeleteMyCommandsRequest -> Rep DeleteMyCommandsRequest x # to :: Rep DeleteMyCommandsRequest x -> DeleteMyCommandsRequest #
FromJSON DeleteMyCommandsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser DeleteMyCommandsRequest parseJSONList :: Value -> Parser [DeleteMyCommandsRequest]
ToJSON DeleteMyCommandsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: DeleteMyCommandsRequest -> Value toEncoding :: DeleteMyCommandsRequest -> Encoding toJSONList :: [DeleteMyCommandsRequest] -> Value toEncodingList :: [DeleteMyCommandsRequest] -> Encoding
type Rep DeleteMyCommandsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep DeleteMyCommandsRequest = D1 ('MetaData "DeleteMyCommandsRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "DeleteMyCommandsRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "deleteMyCommandsScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BotCommandScope)) :*: S1 ('MetaSel ('Just "deleteMyCommandsLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

data GetMyCommandsRequest Source #

Request parameters for getMyCommands.

Constructors

GetMyCommandsRequest
Fields getMyCommandsScope :: Maybe BotCommandScope A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault. getMyCommandsLanguageCode :: Maybe Text A two-letter ISO 639-1 language code or an empty string

Instances

Instances details

Generic GetMyCommandsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep GetMyCommandsRequest :: Type -> Type # Methods from :: GetMyCommandsRequest -> Rep GetMyCommandsRequest x # to :: Rep GetMyCommandsRequest x -> GetMyCommandsRequest #
FromJSON GetMyCommandsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser GetMyCommandsRequest parseJSONList :: Value -> Parser [GetMyCommandsRequest]
ToJSON GetMyCommandsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: GetMyCommandsRequest -> Value toEncoding :: GetMyCommandsRequest -> Encoding toJSONList :: [GetMyCommandsRequest] -> Value toEncodingList :: [GetMyCommandsRequest] -> Encoding
type Rep GetMyCommandsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep GetMyCommandsRequest = D1 ('MetaData "GetMyCommandsRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "GetMyCommandsRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "getMyCommandsScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BotCommandScope)) :*: S1 ('MetaSel ('Just "getMyCommandsLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

data SetChatMenuButtonRequest Source #

Request parameters for setChatMenuButton

Constructors

SetChatMenuButtonRequest
Fields setChatMenuButtonRequestChatId :: Maybe ChatId Unique identifier for the target private chat. If not specified, default bot's menu button will be changed. setChatMenuButtonRequestMenuButton :: Maybe MenuButton A JSON-serialized object for the new bot's menu button. Defaults to `MenuButtonDefault`.

Instances

Instances details

Generic SetChatMenuButtonRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SetChatMenuButtonRequest :: Type -> Type # Methods from :: SetChatMenuButtonRequest -> Rep SetChatMenuButtonRequest x # to :: Rep SetChatMenuButtonRequest x -> SetChatMenuButtonRequest #
FromJSON SetChatMenuButtonRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SetChatMenuButtonRequest parseJSONList :: Value -> Parser [SetChatMenuButtonRequest]
ToJSON SetChatMenuButtonRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SetChatMenuButtonRequest -> Value toEncoding :: SetChatMenuButtonRequest -> Encoding toJSONList :: [SetChatMenuButtonRequest] -> Value toEncodingList :: [SetChatMenuButtonRequest] -> Encoding
type Rep SetChatMenuButtonRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SetChatMenuButtonRequest = D1 ('MetaData "SetChatMenuButtonRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SetChatMenuButtonRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "setChatMenuButtonRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChatId)) :*: S1 ('MetaSel ('Just "setChatMenuButtonRequestMenuButton") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MenuButton))))

data GetChatMenuButtonRequest Source #

Request parameters for getChatMenuButton

Constructors

GetChatMenuButtonRequest
Fields getChatMenuButtonRequestChatId :: Maybe ChatId Unique identifier for the target private chat. If not specified, default bot's menu button will be returned.

Instances

Instances details

Generic GetChatMenuButtonRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep GetChatMenuButtonRequest :: Type -> Type # Methods from :: GetChatMenuButtonRequest -> Rep GetChatMenuButtonRequest x # to :: Rep GetChatMenuButtonRequest x -> GetChatMenuButtonRequest #
FromJSON GetChatMenuButtonRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser GetChatMenuButtonRequest parseJSONList :: Value -> Parser [GetChatMenuButtonRequest]
ToJSON GetChatMenuButtonRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: GetChatMenuButtonRequest -> Value toEncoding :: GetChatMenuButtonRequest -> Encoding toJSONList :: [GetChatMenuButtonRequest] -> Value toEncodingList :: [GetChatMenuButtonRequest] -> Encoding
type Rep GetChatMenuButtonRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep GetChatMenuButtonRequest = D1 ('MetaData "GetChatMenuButtonRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "GetChatMenuButtonRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "getChatMenuButtonRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChatId))))

data SetMyDefaultAdministratorRightsRequest Source #

Request parameters for setMyDefaultAdministratorRights

Constructors

SetMyDefaultAdministratorRightsRequest

Fields

setMyDefaultAdministratorRightsRequestRights :: Maybe ChatAdministratorRights
A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.
setMyDefaultAdministratorRightsRequestForChannels :: Maybe Bool
Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.

Instances

Instances details

Generic SetMyDefaultAdministratorRightsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SetMyDefaultAdministratorRightsRequest :: Type -> Type # Methods from :: SetMyDefaultAdministratorRightsRequest -> Rep SetMyDefaultAdministratorRightsRequest x # to :: Rep SetMyDefaultAdministratorRightsRequest x -> SetMyDefaultAdministratorRightsRequest #
FromJSON SetMyDefaultAdministratorRightsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SetMyDefaultAdministratorRightsRequest parseJSONList :: Value -> Parser [SetMyDefaultAdministratorRightsRequest]
ToJSON SetMyDefaultAdministratorRightsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SetMyDefaultAdministratorRightsRequest -> Value toEncoding :: SetMyDefaultAdministratorRightsRequest -> Encoding toJSONList :: [SetMyDefaultAdministratorRightsRequest] -> Value toEncodingList :: [SetMyDefaultAdministratorRightsRequest] -> Encoding
type Rep SetMyDefaultAdministratorRightsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SetMyDefaultAdministratorRightsRequest = D1 ('MetaData "SetMyDefaultAdministratorRightsRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SetMyDefaultAdministratorRightsRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "setMyDefaultAdministratorRightsRequestRights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChatAdministratorRights)) :*: S1 ('MetaSel ('Just "setMyDefaultAdministratorRightsRequestForChannels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))

data GetMyDefaultAdministratorRightsRequest Source #

Request parameters for getMyDefaultAdministratorRights

Constructors

GetMyDefaultAdministratorRightsRequest
Fields getMyDefaultAdministratorRightsRequestForChannels :: Maybe Bool Pass `True` to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.

Instances

Instances details

Generic GetMyDefaultAdministratorRightsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep GetMyDefaultAdministratorRightsRequest :: Type -> Type # Methods from :: GetMyDefaultAdministratorRightsRequest -> Rep GetMyDefaultAdministratorRightsRequest x # to :: Rep GetMyDefaultAdministratorRightsRequest x -> GetMyDefaultAdministratorRightsRequest #
FromJSON GetMyDefaultAdministratorRightsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser GetMyDefaultAdministratorRightsRequest parseJSONList :: Value -> Parser [GetMyDefaultAdministratorRightsRequest]
ToJSON GetMyDefaultAdministratorRightsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: GetMyDefaultAdministratorRightsRequest -> Value toEncoding :: GetMyDefaultAdministratorRightsRequest -> Encoding toJSONList :: [GetMyDefaultAdministratorRightsRequest] -> Value toEncodingList :: [GetMyDefaultAdministratorRightsRequest] -> Encoding
type Rep GetMyDefaultAdministratorRightsRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep GetMyDefaultAdministratorRightsRequest = D1 ('MetaData "GetMyDefaultAdministratorRightsRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "GetMyDefaultAdministratorRightsRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "getMyDefaultAdministratorRightsRequestForChannels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))

type CopyMessage = "copyMessage" :> (ReqBody '[JSON] CopyMessageRequest :> Post '[JSON] (Response CopyMessageId)) Source #

copyMessage :: CopyMessageRequest -> ClientM (Response CopyMessageId) Source #

Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.

type SendLocation = "sendLocation" :> (ReqBody '[JSON] SendLocationRequest :> Post '[JSON] (Response Message)) Source #

sendLocation :: SendLocationRequest -> ClientM (Response Message) Source #

Use this method to send point on the map. On success, the sent Message is returned.

type EditMessageLiveLocation = "editMessageLiveLocation" :> (ReqBody '[JSON] EditMessageLiveLocationRequest :> Post '[JSON] (Response (Either Bool Message))) Source #

editMessageLiveLocation :: EditMessageLiveLocationRequest -> ClientM (Response (Either Bool Message)) Source #

Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

type StopMessageLiveLocation = "stopMessageLiveLocation" :> (ReqBody '[JSON] StopMessageLiveLocationRequest :> Post '[JSON] (Response (Either Bool Message))) Source #

stopMessageLiveLocation :: StopMessageLiveLocationRequest -> ClientM (Response (Either Bool Message)) Source #

Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

type SendVenue = "sendVenue" :> (ReqBody '[JSON] SendVenueRequest :> Post '[JSON] (Response Message)) Source #

sendVenue :: SendVenueRequest -> ClientM (Response Message) Source #

Use this method to send information about a venue. On success, the sent Message is returned.

type SendContact = "sendContact" :> (ReqBody '[JSON] SendContactRequest :> Post '[JSON] (Response Message)) Source #

sendContact :: SendContactRequest -> ClientM (Response Message) Source #

Use this method to send phone contacts. On success, the sent Message is returned.

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.

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

sendDice :: SendDiceRequest -> ClientM (Response Message) Source #

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

type GetUserProfilePhotos = "getUserProfilePhotos" :> (ReqBody '[JSON] GetUserProfilePhotosRequest :> Post '[JSON] (Response UserProfilePhotos)) Source #

getUserProfilePhotos :: GetUserProfilePhotosRequest -> ClientM (Response UserProfilePhotos) Source #

Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

type BanChatMember = "banChatMember" :> (ReqBody '[JSON] BanChatMemberRequest :> Post '[JSON] (Response Bool)) Source #

banChatMember :: BanChatMemberRequest -> ClientM (Response Bool) Source #

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

type UnbanChatMember = "unbanChatMember" :> (ReqBody '[JSON] UnbanChatMemberRequest :> Post '[JSON] (Response Bool)) Source #

unbanChatMember :: UnbanChatMemberRequest -> ClientM (Response Bool) Source #

Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.

type RestrictChatMember = "restrictChatMember" :> (ReqBody '[JSON] RestrictChatMemberRequest :> Post '[JSON] (Response Bool)) Source #

restrictChatMember :: RestrictChatMemberRequest -> ClientM (Response Bool) Source #

Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

type PromoteChatMember = "promoteChatMember" :> (ReqBody '[JSON] PromoteChatMemberRequest :> Post '[JSON] (Response Bool)) Source #

promoteChatMember :: PromoteChatMemberRequest -> ClientM (Response Bool) Source #

Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

type SetChatAdministratorCustomTitle = "setChatAdministratorCustomTitle" :> (ReqBody '[JSON] SetChatAdministratorCustomTitleRequest :> Post '[JSON] (Response Bool)) Source #

setChatAdministratorCustomTitle :: SetChatAdministratorCustomTitleRequest -> ClientM (Response Bool) Source #

Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

type SetChatPermissions = "setChatPermissions" :> (ReqBody '[JSON] SetChatPermissionsRequest :> Post '[JSON] (Response Bool)) Source #

setChatPermissions :: SetChatPermissionsRequest -> ClientM (Response Bool) Source #

Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.

type CreateChatInviteLink = "createChatInviteLink" :> (ReqBody '[JSON] CreateChatInviteLinkRequest :> Post '[JSON] (Response ChatInviteLink)) Source #

createChatInviteLink :: CreateChatInviteLinkRequest -> ClientM (Response ChatInviteLink) Source #

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

type EditChatInviteLink = "editChatInviteLink" :> (ReqBody '[JSON] EditChatInviteLinkRequest :> Post '[JSON] (Response ChatInviteLink)) Source #

editChatInviteLink :: EditChatInviteLinkRequest -> ClientM (Response ChatInviteLink) Source #

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

type PinChatMessage = "pinChatMessage" :> (ReqBody '[JSON] PinChatMessageRequest :> Post '[JSON] (Response Bool)) Source #

pinChatMessage :: PinChatMessageRequest -> ClientM (Response Bool) Source #

Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in a supergroup or can_edit_messages administrator right in a channel. Returns True on success.

type AnswerCallbackQuery = "answerCallbackQuery" :> (ReqBody '[JSON] AnswerCallbackQueryRequest :> Post '[JSON] (Response Bool)) Source #

answerCallbackQuery :: AnswerCallbackQueryRequest -> ClientM (Response Bool) Source #

Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @Botfather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.

type SetMyCommands = "setMyCommands" :> (ReqBody '[JSON] SetMyCommandsRequest :> Post '[JSON] (Response Bool)) Source #

setMyCommands :: SetMyCommandsRequest -> ClientM (Response Bool) Source #

Use this method to change the list of the bot's commands. See https://core.telegram.org/bots#commands for more details about bot commands. Returns True on success.

type DeleteMyCommands = "deleteMyCommands" :> (ReqBody '[JSON] DeleteMyCommandsRequest :> Post '[JSON] (Response Bool)) Source #

deleteMyCommands :: DeleteMyCommandsRequest -> ClientM (Response Bool) Source #

Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

type GetMyCommands = "getMyCommands" :> (ReqBody '[JSON] GetMyCommandsRequest :> Post '[JSON] (Response [BotCommand])) Source #

getMyCommands :: GetMyCommandsRequest -> ClientM (Response [BotCommand]) Source #

Use this method to get the current list of the bot's commands for the given scope and user language. Returns Array of BotCommand on success. If commands aren't set, an empty list is returned.

type SetChatMenuButton = "setChatMenuButton" :> (ReqBody '[JSON] SetChatMenuButtonRequest :> Post '[JSON] (Response Bool)) Source #

setChatMenuButton :: SetChatMenuButtonRequest -> ClientM (Response Bool) Source #

Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.

type GetChatMenuButton = "getChatMenuButton" :> (ReqBody '[JSON] GetChatMenuButtonRequest :> Post '[JSON] (Response MenuButton)) Source #

getChatMenuButton :: GetChatMenuButtonRequest -> ClientM (Response MenuButton) Source #

Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.

type SetMyDefaultAdministratorRights = "setMyDefaultAdministratorRights" :> (ReqBody '[JSON] SetMyDefaultAdministratorRightsRequest :> Post '[JSON] (Response Bool)) Source #

setMyDefaultAdministratorRights :: SetMyDefaultAdministratorRightsRequest -> ClientM (Response Bool) Source #

Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.

type GetMyDefaultAdministratorRights = "getMyDefaultAdministratorRights" :> (ReqBody '[JSON] GetMyDefaultAdministratorRightsRequest :> Post '[JSON] (Response ChatAdministratorRights)) Source #

getMyDefaultAdministratorRights :: GetMyDefaultAdministratorRightsRequest -> ClientM (Response ChatAdministratorRights) Source #

Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.