Telegram.Bot.API.Types.InputMedia

InputMedia

data InputMediaGeneric

Generic fields for all InputMedia structures

Constructors

InputMediaGeneric

Fields

• inputMediaGenericMedia :: InputFile

  File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach:/file_attach_name” to upload a new one using multipartform-data under file_attach_name name.

• inputMediaGenericCaption :: Maybe Text

  Caption of the photo to be sent, 0-1024 characters after entities parsing.

• inputMediaGenericParseMode :: Maybe Text

  Mode for parsing entities in the photo caption. See formatting options https://core.telegram.org/bots/api#formatting-options for more details.

• inputMediaGenericCaptionEntities :: Maybe [MessageEntity]

  List of special entities that appear in the caption, which can be specified instead of parse_mode.

Instances

ToJSON InputMediaGeneric

Defined in Telegram.Bot.API.Types.InputMedia

Methods

toJSON :: InputMediaGeneric -> Value

toEncoding :: InputMediaGeneric -> Encoding

toJSONList :: [InputMediaGeneric] -> Value

toEncodingList :: [InputMediaGeneric] -> Encoding

Generic InputMediaGeneric

Defined in Telegram.Bot.API.Types.InputMedia

Associated Types

type Rep InputMediaGeneric :: Type -> Type

Methods

from :: InputMediaGeneric -> Rep InputMediaGeneric x

to :: Rep InputMediaGeneric x -> InputMediaGeneric

ToMultipart Tmp InputMediaGeneric

Defined in Telegram.Bot.API.Types.InputMedia

Methods

toMultipart :: InputMediaGeneric -> MultipartData Tmp

type Rep InputMediaGeneric

Defined in Telegram.Bot.API.Types.InputMedia

type Rep InputMediaGeneric = D1 ('MetaData "InputMediaGeneric" "Telegram.Bot.API.Types.InputMedia" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "InputMediaGeneric" 'PrefixI 'True) ((S1 ('MetaSel ('Just "inputMediaGenericMedia") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputFile) :*: S1 ('MetaSel ('Just "inputMediaGenericCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "inputMediaGenericParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "inputMediaGenericCaptionEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity])))))

data InputMediaGenericThumb

Constructors

InputMediaGenericThumb

Fields

• inputMediaGenericGeneric :: InputMediaGeneric
• inputMediaGenericThumb :: 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.

Instances

ToJSON InputMediaGenericThumb

Defined in Telegram.Bot.API.Types.InputMedia

Methods

toJSON :: InputMediaGenericThumb -> Value

toEncoding :: InputMediaGenericThumb -> Encoding

toJSONList :: [InputMediaGenericThumb] -> Value

toEncodingList :: [InputMediaGenericThumb] -> Encoding

ToMultipart Tmp InputMediaGenericThumb

Defined in Telegram.Bot.API.Types.InputMedia

Methods

toMultipart :: InputMediaGenericThumb -> MultipartData Tmp

data InputMedia

Constructors

InputMediaPhoto

Represents a photo to be sent.

Fields

• inputMediaPhotoGeneric :: InputMediaGeneric
• inputMediaPhotoHasSpoiler :: Maybe Bool

  Pass True if the video needs to be covered with a spoiler animation.

InputMediaVideo

Represents a video to be sent.

Fields

• inputMediaVideoGeneric :: InputMediaGenericThumb
• inputMediaVideoWidth :: Maybe Integer

  Video width

• inputMediaVideoHeight :: Maybe Integer

  Video height

• inputMediaVideoDuration :: Maybe Integer

  Video duration in seconds

• inputMediaVideoSupportsStreaming :: Maybe Bool

  Pass True, if the uploaded video is suitable for streaming.

• inputMediaVideoHasSpoiler :: Maybe Bool

  Pass True if the video needs to be covered with a spoiler animation.

InputMediaAnimation

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

Fields

• inputMediaAnimationGeneric :: InputMediaGenericThumb
• inputMediaAnimationWidth :: Maybe Integer

  Animation width

• inputMediaAnimationHeight :: Maybe Integer

  Animation height

• inputMediaAnimationDuration :: Maybe Integer

  Animation duration in seconds

• inputMediaAnimationHasSpoiler :: Maybe Bool

  Pass True if the video needs to be covered with a spoiler animation.

InputMediaAudio

Represents an audio file to be treated as music to be sent.

Fields

• inputMediaAudioGeneric :: InputMediaGenericThumb
• inputMediaAudioDuration :: Maybe Integer

  Duration of the audio in seconds

• inputMediaAudioPerformer :: Maybe Text

  Performer of the audio

• inputMediaAudioTitle :: Maybe Text

  Title of the audio

InputMediaDocument

Represents a general file to be sent.

Fields

• inputMediaDocumentGeneric :: InputMediaGenericThumb
• inputMediaDocumentDisableContentTypeDetection :: Maybe Bool

  Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.

Instances

ToJSON InputMedia

Defined in Telegram.Bot.API.Types.InputMedia

Methods

toJSON :: InputMedia -> Value

toEncoding :: InputMedia -> Encoding

toJSONList :: [InputMedia] -> Value

toEncodingList :: [InputMedia] -> Encoding

ToMultipart Tmp InputMedia

Defined in Telegram.Bot.API.Types.InputMedia

Methods

toMultipart :: InputMedia -> MultipartData Tmp

type ContentType = Text

data InputFile

Constructors

InputFileId FileId

FileUrl Text

InputFile FilePath ContentType

Instances

ToJSON InputFile

Defined in Telegram.Bot.API.Types.InputMedia

Methods

toJSON :: InputFile -> Value

toEncoding :: InputFile -> Encoding

toJSONList :: [InputFile] -> Value

toEncodingList :: [InputFile] -> Encoding

makeFile :: Text -> InputFile -> MultipartData Tmp -> MultipartData Tmp

Multipart file helper