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

Package-level declarations

Types

SendAnimationData

SendAnimationFiles

data class SendAnimationFiles : Map<String, MultipartFile>

SendAudioData

SendAudioFiles

data class SendAudioFiles : Map<String, MultipartFile>

SendDocumentData

@Serializable

data class SendDocumentData : DataRequest<ChatContentMessage<DocumentContent>> , SendContentMessageRequest<ChatContentMessage<DocumentContent>> , ReplyingMarkupSendMessageRequest<ChatContentMessage<DocumentContent>> , TextableSendMessageRequest<ChatContentMessage<DocumentContent>> , ThumbedSendMessageRequest<ChatContentMessage<DocumentContent>> , OptionallyEphemeralSendRequest

Use this method to send general files. On success, the sent ContentMessage with DocumentContent is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

SendDocumentFiles

data class SendDocumentFiles : Map<String, MultipartFile>

SendLivePhotoData

@Serializable

data class SendLivePhotoData : DataRequest<ChatContentMessage<LivePhotoContent>> , SendContentMessageRequest<ChatContentMessage<LivePhotoContent>> , ReplyingMarkupSendMessageRequest<ChatContentMessage<LivePhotoContent>> , TextableSendMessageRequest<ChatContentMessage<LivePhotoContent>> , WithCustomizableCaptionRequest<ChatContentMessage<LivePhotoContent>> , OptionallyWithSpoilerRequest, OptionallyEphemeralSendRequest

SendLivePhotoFiles

data class SendLivePhotoFiles : Map<String, MultipartFile>

SendMediaGroupData

@Serializable

data class SendMediaGroupData : DataRequest<CommonContentMessage<MediaGroupContent<MediaGroupPartContent>>> , SendContentMessageRequest<CommonContentMessage<MediaGroupContent<MediaGroupPartContent>>>

SendMediaGroupFiles

data class SendMediaGroupFiles : Map<String, MultipartFile>

SendPaidMediaData

@Serializable

data class SendPaidMediaData : DataRequest<ChatContentMessage<PaidMediaInfoContent>> , SendContentMessageRequest<ChatContentMessage<PaidMediaInfoContent>> , ReplyingMarkupSendMessageRequest<ChatContentMessage<PaidMediaInfoContent>> , TextableSendMessageRequest<ChatContentMessage<PaidMediaInfoContent>> , WithCustomizableCaptionRequest<ChatContentMessage<PaidMediaInfoContent>>

SendPaidMediaFiles

data class SendPaidMediaFiles : Map<String, MultipartFile>

SendPhotoData

@Serializable

data class SendPhotoData : DataRequest<ChatContentMessage<PhotoContent>> , SendContentMessageRequest<ChatContentMessage<PhotoContent>> , ReplyingMarkupSendMessageRequest<ChatContentMessage<PhotoContent>> , TextableSendMessageRequest<ChatContentMessage<PhotoContent>> , WithCustomizableCaptionRequest<ChatContentMessage<PhotoContent>> , OptionallyWithSpoilerRequest, OptionallyEphemeralSendRequest

SendPhotoFiles

data class SendPhotoFiles : Map<String, MultipartFile>

SendStickerByFileId

@Serializable

data class SendStickerByFileId : SendContentMessageRequest<ChatContentMessage<StickerContent>> , ReplyingMarkupSendMessageRequest<ChatContentMessage<StickerContent>> , OptionallyEphemeralSendRequest

SendVideoData

SendVideoFiles

data class SendVideoFiles : Map<String, MultipartFile>

SendVideoNoteData

SendVideoNoteFiles

data class SendVideoNoteFiles : Map<String, MultipartFile>

SendVoiceData

@Serializable

data class SendVoiceData : DataRequest<ChatContentMessage<VoiceContent>> , SendContentMessageRequest<ChatContentMessage<VoiceContent>> , ReplyingMarkupSendMessageRequest<ChatContentMessage<VoiceContent>> , TextableSendMessageRequest<ChatContentMessage<VoiceContent>> , DuratedSendMessageRequest<ChatContentMessage<VoiceContent>> , OptionallyEphemeralSendRequest

SendVoiceFiles

data class SendVoiceFiles : Map<String, MultipartFile>

Properties

rawSendingMediaGroupsWarning

const val rawSendingMediaGroupsWarning: String

Functions

SendAnimation

fun SendAnimation(chatId: ChatIdentifier, animation: InputFile, thumbnail: InputFile? = null, entities: TextSourcesList, showCaptionAboveMedia: Boolean = false, spoilered: Boolean = false, duration: Long? = null, width: Int? = null, height: Int? = null, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<AnimationContent>>

fun SendAnimation(chatId: ChatIdentifier, animation: InputFile, thumbnail: InputFile? = null, text: String? = null, parseMode: ParseMode? = null, showCaptionAboveMedia: Boolean = false, spoilered: Boolean = false, duration: Long? = null, width: Int? = null, height: Int? = null, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<AnimationContent>>

SendAudio

fun SendAudio(chatId: ChatIdentifier, audio: InputFile, thumbnail: InputFile? = null, entities: List<TextSource>, duration: Long? = null, performer: String? = null, title: String? = null, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<AudioContent>>

fun SendAudio(chatId: ChatIdentifier, audio: InputFile, thumbnail: InputFile? = null, text: String? = null, parseMode: ParseMode? = null, duration: Long? = null, performer: String? = null, title: String? = null, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<AudioContent>>

SendDocument

fun SendDocument(chatId: ChatIdentifier, document: InputFile, thumbnail: InputFile? = null, entities: TextSourcesList, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null, disableContentTypeDetection: Boolean? = null): Request<ChatContentMessage<DocumentContent>>

fun SendDocument(chatId: ChatIdentifier, document: InputFile, thumbnail: InputFile? = null, text: String? = null, parseMode: ParseMode? = null, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null, disableContentTypeDetection: Boolean? = null): Request<ChatContentMessage<DocumentContent>>

SendDocumentsGroup

inline fun SendDocumentsGroup(chatId: ChatIdentifier, media: List<DocumentMediaGroupMemberTelegramMedia>, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null): Request<ChatContentMessage<MediaGroupContent<DocumentContent>>>

Use this method to be sure that you are correctly sending documents media group

SendLivePhoto

fun SendLivePhoto(chatId: ChatIdentifier, livePhoto: InputFile, photo: InputFile, entities: TextSourcesList, showCaptionAboveMedia: Boolean = false, spoilered: Boolean = false, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<LivePhotoContent>>

fun SendLivePhoto(chatId: ChatIdentifier, livePhoto: InputFile, photo: InputFile, text: String? = null, parseMode: ParseMode? = null, showCaptionAboveMedia: Boolean = false, spoilered: Boolean = false, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<LivePhotoContent>>

SendMediaGroup

fun <T : MediaGroupPartContent> SendMediaGroup(chatId: ChatIdentifier, media: List<MediaGroupMemberTelegramMedia>, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null): Request<ChatContentMessage<MediaGroupContent<T>>>

SendPaidMedia

fun SendPaidMedia(chatId: ChatIdentifier, starCount: Int, media: List<TelegramPaidMedia>, entities: TextSourcesList, payload: PaidMediaPayload? = null, showCaptionAboveMedia: Boolean = false, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<PaidMediaInfoContent>>

fun SendPaidMedia(chatId: ChatIdentifier, starCount: Int, media: List<TelegramPaidMedia>, text: String? = null, parseMode: ParseMode? = null, payload: PaidMediaPayload? = null, showCaptionAboveMedia: Boolean = false, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<PaidMediaInfoContent>>

SendPhoto

fun SendPhoto(chatId: ChatIdentifier, photo: InputFile, entities: TextSourcesList, showCaptionAboveMedia: Boolean = false, spoilered: Boolean = false, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<PhotoContent>>

fun SendPhoto(chatId: ChatIdentifier, photo: InputFile, text: String? = null, parseMode: ParseMode? = null, showCaptionAboveMedia: Boolean = false, spoilered: Boolean = false, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<PhotoContent>>

SendPlaylist

inline fun SendPlaylist(chatId: ChatIdentifier, media: List<AudioMediaGroupMemberTelegramMedia>, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null): Request<ChatContentMessage<MediaGroupContent<AudioContent>>>

Use this method to be sure that you are correctly sending playlist with audios

SendSticker

fun SendSticker(chatId: ChatIdentifier, sticker: InputFile, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, emoji: String? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<StickerContent>>

SendVideo

fun SendVideo(chatId: ChatIdentifier, video: InputFile, thumbnail: InputFile? = null, entities: TextSourcesList, showCaptionAboveMedia: Boolean = false, spoilered: Boolean = false, cover: InputFile? = null, startTimestamp: Seconds? = null, duration: Long? = null, width: Int? = null, height: Int? = null, supportsStreaming: Boolean = false, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<VideoContent>>

fun SendVideo(chatId: ChatIdentifier, video: InputFile, thumbnail: InputFile? = null, text: String? = null, parseMode: ParseMode? = null, showCaptionAboveMedia: Boolean = false, spoilered: Boolean = false, cover: InputFile? = null, startTimestamp: Seconds? = null, duration: Long? = null, width: Int? = null, height: Int? = null, supportsStreaming: Boolean = false, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<VideoContent>>

SendVideoNote

fun SendVideoNote(chatId: ChatIdentifier, videoNote: InputFile, thumbnail: InputFile? = null, duration: Long? = null, size: Int? = null, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<VideoNoteContent>>

SendVisualMediaGroup

inline fun SendVisualMediaGroup(chatId: ChatIdentifier, media: List<VisualMediaGroupMemberTelegramMedia>, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null): Request<ChatContentMessage<MediaGroupContent<VisualMediaGroupPartContent>>>

Use this method to be sure that you are correctly sending visual media group

SendVoice

fun SendVoice(chatId: ChatIdentifier, voice: InputFile, entities: TextSourcesList, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, duration: Long? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<VoiceContent>>

fun SendVoice(chatId: ChatIdentifier, voice: InputFile, text: String? = null, parseMode: ParseMode? = null, duration: Long? = null, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, receiverUserId: UserId? = chatId.receiverUser, callbackQueryId: CallbackQueryId? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<VoiceContent>>