Safe Haskell	None
Language	Haskell2010

Telegram.Bot.API.Methods.SendDocument

Contents

sendDocument

Synopsis

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 {
}
newtype DocumentFile = MakeDocumentFile InputFile
pattern DocumentFileId :: FileId -> DocumentFile
pattern DocumentUrl :: Text -> DocumentFile
pattern DocumentFile :: FilePath -> ContentType -> DocumentFile
toSendDocument :: SomeChatId -> DocumentFile -> SendDocumentRequest

`sendDocument`

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).
sendDocumentMessageThreadId :: Maybe MessageThreadId
Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.
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.SendDocument 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.SendDocument 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.SendDocument Methods toMultipart :: SendDocumentRequest -> MultipartData Tmp
type Rep SendDocumentRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.SendDocument type Rep SendDocumentRequest = D1 ('MetaData "SendDocumentRequest" "Telegram.Bot.API.Methods.SendDocument" "telegram-bot-api-6.5-inplace" 'False) (C1 ('MetaCons "SendDocumentRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendDocumentChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "sendDocumentMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageThreadId)) :: 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.SendDocument 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.