1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-17 22:03:48 +00:00
tgbotapi/docs/dev.inmo.tgbotapi.requests.send.media/index.md
2021-03-17 15:18:37 +00:00

55 KiB

//docs/dev.inmo.tgbotapi.requests.send.media

Package dev.inmo.tgbotapi.requests.send.media

Types

Name Summary
SendAnimationData [common]
Content
data class SendAnimationData : DataRequest<ContentMessage<AnimationContent>> , SendMessageRequest<ContentMessage<AnimationContent>> , ReplyingMarkupSendMessageRequest<ContentMessage<AnimationContent>> , TextableSendMessageRequest<ContentMessage<AnimationContent>> , ThumbedSendMessageRequest<ContentMessage<AnimationContent>> , DuratedSendMessageRequest<ContentMessage<AnimationContent>> , SizedSendMessageRequest<ContentMessage<AnimationContent>>


SendAnimationFiles [common]
Content
data class SendAnimationFiles : Map<String, MultipartFile>


SendAudioData [common]
Content
data class SendAudioData : DataRequest<ContentMessage<AudioContent>> , SendMessageRequest<ContentMessage<AudioContent>> , ReplyingMarkupSendMessageRequest<ContentMessage<AudioContent>> , TextableSendMessageRequest<ContentMessage<AudioContent>> , ThumbedSendMessageRequest<ContentMessage<AudioContent>> , TitledSendMessageRequest<ContentMessage<AudioContent>> , DuratedSendMessageRequest<ContentMessage<AudioContent>> , Performerable


SendAudioFiles [common]
Content
data class SendAudioFiles : Map<String, MultipartFile>


SendDocumentData [common]
Content
data class SendDocumentData : DataRequest<ContentMessage<DocumentContent>> , SendMessageRequest<ContentMessage<DocumentContent>> , ReplyingMarkupSendMessageRequest<ContentMessage<DocumentContent>> , TextableSendMessageRequest<ContentMessage<DocumentContent>> , ThumbedSendMessageRequest<ContentMessage<DocumentContent>>
More info
Use this method to send general files.


SendDocumentFiles [common]
Content
data class SendDocumentFiles : Map<String, MultipartFile>


SendMediaGroupData [common]
Content
data class SendMediaGroupData : DataRequest<List<MediaGroupMessage<MediaGroupContent>>> , SendMessageRequest<List<MediaGroupMessage<MediaGroupContent>>>


SendMediaGroupFiles [common]
Content
data class SendMediaGroupFiles : Map<String, MultipartFile>


SendPhotoData [common]
Content
data class SendPhotoData : DataRequest<ContentMessage<PhotoContent>> , SendMessageRequest<ContentMessage<PhotoContent>> , ReplyingMarkupSendMessageRequest<ContentMessage<PhotoContent>> , TextableSendMessageRequest<ContentMessage<PhotoContent>>


SendPhotoFiles [common]
Content
data class SendPhotoFiles : Map<String, MultipartFile>


SendStickerByFile [common]
Content
data class SendStickerByFile : MultipartRequest<ContentMessage<StickerContent>> , Request<ContentMessage<StickerContent>>


SendStickerByFileId [common]
Content
data class SendStickerByFileId : SendMessageRequest<ContentMessage<StickerContent>> , ReplyingMarkupSendMessageRequest<ContentMessage<StickerContent>>


SendVideoData [common]
Content
data class SendVideoData : DataRequest<ContentMessage<VideoContent>> , SendMessageRequest<ContentMessage<VideoContent>> , ReplyingMarkupSendMessageRequest<ContentMessage<VideoContent>> , TextableSendMessageRequest<ContentMessage<VideoContent>> , ThumbedSendMessageRequest<ContentMessage<VideoContent>> , DuratedSendMessageRequest<ContentMessage<VideoContent>> , SizedSendMessageRequest<ContentMessage<VideoContent>>


SendVideoFiles [common]
Content
data class SendVideoFiles : Map<String, MultipartFile>


SendVideoNoteData [common]
Content
data class SendVideoNoteData : DataRequest<ContentMessage<VideoNoteContent>> , SendMessageRequest<ContentMessage<VideoNoteContent>> , ReplyingMarkupSendMessageRequest<ContentMessage<VideoNoteContent>> , ThumbedSendMessageRequest<ContentMessage<VideoNoteContent>> , DuratedSendMessageRequest<ContentMessage<VideoNoteContent>> , SizedSendMessageRequest<ContentMessage<VideoNoteContent>>


SendVideoNoteFiles [common]
Content
data class SendVideoNoteFiles : Map<String, MultipartFile>


SendVoiceData [common]
Content
data class SendVoiceData : DataRequest<ContentMessage<VoiceContent>> , SendMessageRequest<ContentMessage<VoiceContent>> , ReplyingMarkupSendMessageRequest<ContentMessage<VoiceContent>> , TextableSendMessageRequest<ContentMessage<VoiceContent>> , DuratedSendMessageRequest<ContentMessage<VoiceContent>>


SendVoiceFiles [common]
Content
data class SendVoiceFiles : Map<String, MultipartFile>


Functions

Name Summary
SendAnimation [common]
Content
fun SendAnimation(chatId: ChatIdentifier, animation: InputFile, thumb: InputFile? = null, entities: List<TextSource>, duration: Long? = null, width: Int? = null, height: Int? = null, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<ContentMessage<AnimationContent>>
fun SendAnimation(chatId: ChatIdentifier, animation: InputFile, thumb: InputFile? = null, caption: String? = null, parseMode: ParseMode? = null, duration: Long? = null, width: Int? = null, height: Int? = null, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<ContentMessage<AnimationContent>>


SendAudio [common]
Content
fun SendAudio(chatId: ChatIdentifier, audio: InputFile, thumb: InputFile? = null, entities: List<TextSource>, duration: Long? = null, performer: String? = null, title: String? = null, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<ContentMessage<AudioContent>>
fun SendAudio(chatId: ChatIdentifier, audio: InputFile, thumb: InputFile? = null, caption: String? = null, parseMode: ParseMode? = null, duration: Long? = null, performer: String? = null, title: String? = null, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<ContentMessage<AudioContent>>


SendDocument [common]
Content
fun SendDocument(chatId: ChatIdentifier, document: InputFile, thumb: InputFile? = null, entities: List<TextSource>, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null, disableContentTypeDetection: Boolean? = null): Request<ContentMessage<DocumentContent>>
fun SendDocument(chatId: ChatIdentifier, document: InputFile, thumb: InputFile? = null, caption: String? = null, parseMode: ParseMode? = null, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null, disableContentTypeDetection: Boolean? = null): Request<ContentMessage<DocumentContent>>
More info
Use this method to send general files.


SendDocumentsGroup [common]
Content
inline fun SendDocumentsGroup(chatId: ChatIdentifier, media: List<DocumentMediaGroupMemberInputMedia>, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null): Request<List<MediaGroupMessage<DocumentContent>>>
More info
Use this method to be sure that you are correctly sending documents media group


SendMediaGroup [common]
Content
fun <T : MediaGroupContent> SendMediaGroup(chatId: ChatIdentifier, media: List<MediaGroupMemberInputMedia>, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null): Request<List<MediaGroupMessage<T>>>


SendPhoto [common]
Content
fun SendPhoto(chatId: ChatIdentifier, photo: InputFile, entities: List<TextSource>, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<ContentMessage<PhotoContent>>
fun SendPhoto(chatId: ChatIdentifier, photo: InputFile, caption: String? = null, parseMode: ParseMode? = null, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<ContentMessage<PhotoContent>>


SendPlaylist [common]
Content
inline fun SendPlaylist(chatId: ChatIdentifier, media: List<AudioMediaGroupMemberInputMedia>, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null): Request<List<MediaGroupMessage<AudioContent>>>
More info
Use this method to be sure that you are correctly sending playlist with audios


SendSticker [common]
Content
fun SendSticker(chatId: ChatIdentifier, sticker: InputFile, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<ContentMessage<StickerContent>>


SendVideo [common]
Content
fun SendVideo(chatId: ChatIdentifier, video: InputFile, thumb: InputFile? = null, entities: List<TextSource>, duration: Long? = null, width: Int? = null, height: Int? = null, supportStreaming: Boolean? = null, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<ContentMessage<VideoContent>>
fun SendVideo(chatId: ChatIdentifier, video: InputFile, thumb: InputFile? = null, caption: String? = null, parseMode: ParseMode? = null, duration: Long? = null, width: Int? = null, height: Int? = null, supportStreaming: Boolean? = null, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<ContentMessage<VideoContent>>


SendVideoNote [common]
Content
fun SendVideoNote(chatId: ChatIdentifier, videoNote: InputFile, thumb: InputFile? = null, duration: Long? = null, size: Int? = null, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<ContentMessage<VideoNoteContent>>


SendVisualMediaGroup [common]
Content
inline fun SendVisualMediaGroup(chatId: ChatIdentifier, media: List<VisualMediaGroupMemberInputMedia>, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null): Request<List<MediaGroupMessage<VisualMediaGroupContent>>>
More info
Use this method to be sure that you are correctly sending visual media group


SendVoice [common]
Content
fun SendVoice(chatId: ChatIdentifier, voice: InputFile, entities: List<TextSource>, duration: Long? = null, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<ContentMessage<VoiceContent>>
fun SendVoice(chatId: ChatIdentifier, voice: InputFile, caption: String? = null, parseMode: ParseMode? = null, duration: Long? = null, disableNotification: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<ContentMessage<VoiceContent>>


Properties

Name Summary
rawSendingMediaGroupsWarning [common] const val rawSendingMediaGroupsWarning: String