Class

com.bot4s.telegram.methods

SendDocument

Related Doc: package methods

Permalink

case class SendDocument(chatId: ChatId, document: InputFile, caption: Option[String] = None, parseMode: Option[ParseMode] = None, disableNotification: Option[Boolean] = None, replyToMessageId: Option[Long] = None, replyMarkup: Option[ReplyMarkup] = None) extends MultipartRequest[Message] with Product with Serializable

Use this method to send general files. On success, the sent Message 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.

chatId

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

document

InputFile or String File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.

caption

String Optional Document caption (may also be used when resending documents by file_id), 0-200 characters

parseMode

String Optional Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.

disableNotification

Boolean Optional Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound.

replyToMessageId

Integer Optional If the message is a reply, ID of the original message

replyMarkup

InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply Optional Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to hide reply keyboard or to force a reply from the user.

Linear Supertypes
Serializable, Serializable, Product, Equals, MultipartRequest[Message], Request[Message], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SendDocument
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. MultipartRequest
  7. Request
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SendDocument(chatId: ChatId, document: InputFile, caption: Option[String] = None, parseMode: Option[ParseMode] = None, disableNotification: Option[Boolean] = None, replyToMessageId: Option[Long] = None, replyMarkup: Option[ReplyMarkup] = None)

    Permalink

    chatId

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

    document

    InputFile or String File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.

    caption

    String Optional Document caption (may also be used when resending documents by file_id), 0-200 characters

    parseMode

    String Optional Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.

    disableNotification

    Boolean Optional Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound.

    replyToMessageId

    Integer Optional If the message is a reply, ID of the original message

    replyMarkup

    InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply Optional Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to hide reply keyboard or to force a reply from the user.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val caption: Option[String]

    Permalink

    String Optional Document caption (may also be used when resending documents by file_id), 0-200 characters

  6. val chatId: ChatId

    Permalink

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

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val disableNotification: Option[Boolean]

    Permalink

    Boolean Optional Sends the message silently.

    Boolean Optional Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound.

  9. val document: InputFile

    Permalink

    InputFile or String File to send.

    InputFile or String File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.

  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def getFiles: List[(String, InputFile)]

    Permalink
    Definition Classes
    SendDocumentMultipartRequest
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. def methodName: String

    Permalink

    Extract request URL from class name.

    Extract request URL from class name.

    Definition Classes
    Request
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. val parseMode: Option[ParseMode]

    Permalink

    String Optional Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.

  20. val replyMarkup: Option[ReplyMarkup]

    Permalink

    InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply Optional Additional interface options.

    InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply Optional Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to hide reply keyboard or to force a reply from the user.

  21. val replyToMessageId: Option[Long]

    Permalink

    Integer Optional If the message is a reply, ID of the original message

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from MultipartRequest[Message]

Inherited from Request[Message]

Inherited from AnyRef

Inherited from Any

Ungrouped