docs/dev.inmo.tgbotapi.requests.send

Package-level declarations

Types

@Serializable

data class CopyMessage : SimpleRequest<MessageId> , ReplyingMarkupSendMessageRequest<MessageId> , WithCustomizableCaptionRequest<MessageId> , MessageAction, TextedOutput, ProtectContent, OptionallyMessageThreadRequest, WithCustomStartMediaData, OptionallyWithEffectId

CopyMessages

@Serializable

data class CopyMessages(val toChatId: ChatIdentifier, val fromChatId: ChatIdentifier, val messageIds: List<MessageId>, val threadId: MessageThreadId? = toChatId.threadId, val directMessageThreadId: DirectMessageThreadId? = toChatId.directMessageThreadId, val disableNotification: Boolean = false, val protectContent: Boolean = false, removeCaption: Boolean = false) : SimpleRequest<List<MessageId>> , MessagesAction, ProtectContent, OptionallyMessageThreadRequest, OptionallyDirectMessageThreadRequest, DisableNotification

DeleteAllMessageReactions

@Serializable

data class DeleteAllMessageReactions(val chatId: ChatIdentifier, val userId: UserId? = null, val actorChatId: ChatId? = null) : SimpleRequest<Unit> , ChatRequest

DeleteMessageReaction

@Serializable

data class DeleteMessageReaction(val chatId: ChatIdentifier, val messageId: MessageId, val userId: UserId? = null, val actorChatId: ChatId? = null) : SimpleRequest<Unit> , ChatRequest

SendAction

@Serializable

data class SendAction(val chatId: ChatIdentifier, val action: BotAction, val threadId: MessageThreadId? = chatId.threadId, val businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId) : SendChatMessageRequest<Unit> , OptionallyMessageThreadRequest, OptionallyBusinessConnectionRequest

Send notification to user which will be shown for 5 seconds or while user have no messages from bot

SendChecklist

@Serializable

data class SendChecklist(val chatId: ChatIdentifier, val checklist: Checklist.Input, val businessConnectionId: BusinessConnectionId, val disableNotification: Boolean = false, val protectContent: Boolean = false, val effectId: EffectId? = null, val replyParameters: ReplyParameters? = null, val replyMarkup: KeyboardMarkup? = null) : SendChatMessageRequest<ChatContentMessage<ChecklistContent>> , WithReplyParameters, DisableNotification, ProtectContent, OptionallyWithEffectId, WithBusinessConnectionId, WithReplyMarkup

SendContact

@Serializable

data class SendContact(val chatId: ChatIdentifier, val phoneNumber: String, val firstName: String, val lastName: String? = null, val threadId: MessageThreadId? = chatId.threadId, val directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, val businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, val disableNotification: Boolean = false, val protectContent: Boolean = false, val allowPaidBroadcast: Boolean = false, val effectId: EffectId? = null, val suggestedPostParameters: SuggestedPostParameters? = null, val replyParameters: ReplyParameters? = null, val replyMarkup: KeyboardMarkup? = null) : SendContentMessageRequest<ChatContentMessage<ContactContent>> , ReplyingMarkupSendMessageRequest<ChatContentMessage<ContactContent>>

SendDice

@Serializable

data class SendDice(val chatId: ChatIdentifier, val animationType: DiceAnimationType? = null, val threadId: MessageThreadId? = chatId.threadId, val directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, val businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, val disableNotification: Boolean = false, val protectContent: Boolean = false, val allowPaidBroadcast: Boolean = false, val effectId: EffectId? = null, val suggestedPostParameters: SuggestedPostParameters? = null, val replyParameters: ReplyParameters? = null, val replyMarkup: KeyboardMarkup? = null) : SendContentMessageRequest<ChatContentMessage<DiceContent>> , ReplyingMarkupSendMessageRequest<ChatContentMessage<DiceContent>> , WithReplyParameters, DisableNotification, OptionallyBusinessConnectionRequest

SendLocation

@Serializable(with = SendLocation.Companion::class)

sealed interface SendLocation<T : LocationContent> : SendContentMessageRequest<ChatContentMessage<T>> , ReplyingMarkupSendMessageRequest<ChatContentMessage<T>> , PositionedSendMessageRequest<ChatContentMessage<T>> , HorizontallyAccured, Livable, ProximityAlertable, Headed

SendMessageDraft

@Serializable

data class SendMessageDraft : SendChatMessageRequest<Unit> , TextedOutput, OptionallyMessageThreadRequest

SendRichMessage

@Serializable

data class SendRichMessage(val chatId: ChatIdentifier, val richMessage: InputRichMessage, val threadId: MessageThreadId? = chatId.threadId, val directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, val businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, val disableNotification: Boolean = false, val protectContent: Boolean = false, val allowPaidBroadcast: Boolean = false, val effectId: EffectId? = null, val suggestedPostParameters: SuggestedPostParameters? = null, val replyParameters: ReplyParameters? = null, val replyMarkup: KeyboardMarkup? = null) : SendContentMessageRequest<ChatContentMessage<RichMessageContent>> , ReplyingMarkupSendMessageRequest<ChatContentMessage<RichMessageContent>>

Use this method to send rich messages.

SendRichMessageDraft

@Serializable

data class SendRichMessageDraft(val chatId: ChatId, val draftId: Long, val richMessage: InputRichMessage, val threadId: MessageThreadId? = chatId.threadId) : SimpleRequest<Unit>

Use this method to stream a partial rich message to a user while the message is being generated. The streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, SendRichMessage must be called with the complete message to persist it in the user's chat.

SendTextMessage

@Serializable

data class SendTextMessage : SendContentMessageRequest<ChatContentMessage<TextContent>> , ReplyingMarkupSendMessageRequest<ChatContentMessage<TextContent>> , TextableSendMessageRequest<ChatContentMessage<TextContent>> , LinkPreviewOptionsContainer

SendVenue

@Serializable

data class SendVenue(val chatId: ChatIdentifier, val latitude: Double, val longitude: Double, val title: String, val address: String, val foursquareId: FoursquareId? = null, val foursquareType: FoursquareType? = null, val googlePlaceId: GooglePlaceId? = null, val googlePlaceType: GooglePlaceType? = null, val threadId: MessageThreadId? = chatId.threadId, val directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, val businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, val disableNotification: Boolean = false, val protectContent: Boolean = false, val allowPaidBroadcast: Boolean = false, val effectId: EffectId? = null, val suggestedPostParameters: SuggestedPostParameters? = null, val replyParameters: ReplyParameters? = null, val replyMarkup: KeyboardMarkup? = null) : SendContentMessageRequest<ChatContentMessage<VenueContent>> , ReplyingMarkupSendMessageRequest<ChatContentMessage<VenueContent>> , TitledSendMessageRequest<ChatContentMessage<VenueContent>> , PositionedSendMessageRequest<ChatContentMessage<VenueContent>>

SetMessageReactions

@Serializable

data class SetMessageReactions(val chatId: ChatIdentifier, val messageId: MessageId, val reactions: List<Reaction>, val big: Boolean = false) : SimpleRequest<Unit> , ChatRequest

Properties

OrderChangingDeprecationWarn

const val OrderChangingDeprecationWarn: String

Functions

CopyMessage

fun CopyMessage(fromChatId: ChatIdentifier, messageId: MessageId, toChatId: ChatIdentifier, entities: List<TextSource>, showCaptionAboveMedia: Boolean = false, threadId: MessageThreadId? = toChatId.threadId, directMessageThreadId: DirectMessageThreadId? = toChatId.directMessageThreadId, startTimestamp: Seconds? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): CopyMessage

fun CopyMessage(fromChatId: ChatIdentifier, messageId: MessageId, toChatId: ChatIdentifier, text: String? = null, parseMode: ParseMode? = null, showCaptionAboveMedia: Boolean = false, threadId: MessageThreadId? = toChatId.threadId, directMessageThreadId: DirectMessageThreadId? = toChatId.directMessageThreadId, startTimestamp: Seconds? = null, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): CopyMessage

CopyMessages

fun CopyMessages(toChatId: ChatIdentifier, fromChatId: ChatIdentifier, messageIds: Array<MessageId>, threadId: MessageThreadId? = toChatId.threadId, directMessageThreadId: DirectMessageThreadId? = toChatId.directMessageThreadId, disableNotification: Boolean = false, protectContent: Boolean = false, removeCaption: Boolean = false): CopyMessages

DeleteActorChatMessageReaction

fun DeleteActorChatMessageReaction(chatId: ChatIdentifier, messageId: MessageId, actorChatId: ChatId): DeleteMessageReaction

DeleteAllActorChatMessageReactions

fun DeleteAllActorChatMessageReactions(chatId: ChatIdentifier, actorChatId: ChatId): DeleteAllMessageReactions

DeleteAllUserMessageReactions

fun DeleteAllUserMessageReactions(chatId: ChatIdentifier, userId: UserId): DeleteAllMessageReactions

DeleteUserMessageReaction

fun DeleteUserMessageReaction(chatId: ChatIdentifier, messageId: MessageId, userId: UserId): DeleteMessageReaction

SendLiveLocation

fun SendLiveLocation(chatId: ChatIdentifier, latitude: Double, longitude: Double, livePeriod: Seconds, horizontalAccuracy: Meters? = null, heading: Degrees? = null, proximityAlertRadius: Meters? = null, 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, replyMarkup: KeyboardMarkup? = null): SendLocation.Live

SendLocation

fun SendLocation(chatId: ChatIdentifier, latitude: Double, longitude: Double, 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, replyMarkup: KeyboardMarkup? = null): SendLocation.Static

SendMessageDraft

fun SendMessageDraft(chatId: IdChatIdentifier, draftId: DraftId, entities: TextSourcesList, threadId: MessageThreadId? = chatId.threadId): SendMessageDraft

fun SendMessageDraft(chatId: IdChatIdentifier, draftId: DraftId, text: String, parseMode: ParseMode? = null, threadId: MessageThreadId? = chatId.threadId): SendMessageDraft

SendStaticLocation

fun SendStaticLocation(chatId: ChatIdentifier, latitude: Double, longitude: Double, 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, replyMarkup: KeyboardMarkup? = null): SendLocation.Static

SendTextMessage

fun SendTextMessage(chatId: ChatIdentifier, entities: TextSourcesList, linkPreviewOptions: LinkPreviewOptions? = null, 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, replyMarkup: KeyboardMarkup? = null): SendTextMessage

fun SendTextMessage(chatId: ChatIdentifier, text: String, parseMode: ParseMode? = null, linkPreviewOptions: LinkPreviewOptions? = null, 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, replyMarkup: KeyboardMarkup? = null): SendTextMessage

toRequest

fun Contact.toRequest(chatId: ChatIdentifier, 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, replyMarkup: KeyboardMarkup? = null): SendContact

fun Venue.toRequest(chatId: ChatIdentifier, 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, replyMarkup: KeyboardMarkup? = null): SendVenue