Telegram.Bot.API.Methods.SendAnimation

sendAnimation

data SendAnimationRequest

Request parameters for sendAnimation.

Constructors

SendAnimationRequest

Fields

• sendAnimationBusinessConnectionId :: Maybe BusinessConnectionId

  Unique identifier of the business connection on behalf of which the message will be sent.

• sendAnimationChatId :: SomeChatId

  Unique identifier for the target chat or username of the target channel (in the format @channelusername)

• sendAnimationMessageThreadId :: Maybe MessageThreadId

  Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

• 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

• sendAnimationThumbnail :: 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.

• sendAnimationShowCaptionAboveMedia :: Maybe Bool

  Pass True, if the caption must be shown above the message media.

• sendAnimationHasSpoiler :: Maybe Bool

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

• 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.

• sendAnimationMessageEffectId :: Maybe Text

  Unique identifier of the message effect to be added to the message; for private chats only.

• sendAnimationReplyToMessageId :: Maybe MessageId

  If the message is a reply, ID of the original message.

• sendAnimationReplyParameters :: Maybe ReplyParameters

  Description of the message to reply to.

• 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

ToJSON SendAnimationRequest

Defined in Telegram.Bot.API.Methods.SendAnimation

Methods

toJSON :: SendAnimationRequest -> Value

toEncoding :: SendAnimationRequest -> Encoding

toJSONList :: [SendAnimationRequest] -> Value

toEncodingList :: [SendAnimationRequest] -> Encoding

omitField :: SendAnimationRequest -> Bool

Generic SendAnimationRequest

Defined in Telegram.Bot.API.Methods.SendAnimation

Associated Types

type Rep SendAnimationRequest :: Type -> Type

Methods

from :: SendAnimationRequest -> Rep SendAnimationRequest x

to :: Rep SendAnimationRequest x -> SendAnimationRequest

ToMultipart Tmp SendAnimationRequest

Defined in Telegram.Bot.API.Methods.SendAnimation

Methods

toMultipart :: SendAnimationRequest -> MultipartData Tmp

type Rep SendAnimationRequest

Defined in Telegram.Bot.API.Methods.SendAnimation

type Rep SendAnimationRequest = D1 ('MetaData "SendAnimationRequest" "Telegram.Bot.API.Methods.SendAnimation" "telegram-bot-api-7.4.4-fdOK3VCUfTCfzXncfzYz7" 'False) (C1 ('MetaCons "SendAnimationRequest" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "sendAnimationBusinessConnectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BusinessConnectionId)) :*: S1 ('MetaSel ('Just "sendAnimationChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId)) :*: (S1 ('MetaSel ('Just "sendAnimationMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageThreadId)) :*: 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 "sendAnimationThumbnail") '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 "sendAnimationShowCaptionAboveMedia") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "sendAnimationHasSpoiler") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendAnimationDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "sendAnimationProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendAnimationMessageEffectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sendAnimationReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :*: (S1 ('MetaSel ('Just "sendAnimationReplyParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ReplyParameters)) :*: S1 ('MetaSel ('Just "sendAnimationReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (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)

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.

defSendAnimation :: SomeChatId -> InputFile -> SendAnimationRequest