Class

com.bot4s.telegram.methods

SendMessage

Related Doc: package methods

Permalink

case class SendMessage(chatId: ChatId, text: String, parseMode: Option[ParseMode] = None, disableWebPagePreview: Option[Boolean] = None, disableNotification: Option[Boolean] = None, replyToMessageId: Option[Int] = None, replyMarkup: Option[ReplyMarkup] = None) extends JsonRequest[Message] with Product with Serializable

Use this method to send text messages. On success, the sent Message is returned.

Formatting options

The Bot API supports basic formatting for messages. You can use bold and italic text, as well as inline links and pre-formatted code in your bots' messages. Telegram clients will render them accordingly. You can use either markdown-style or HTML-style formatting. Note that Telegram clients will display an alert to the user before opening an inline link ('Open this link?' together with the full URL).

Markdown style

To use this mode, pass Markdown in the parse_mode field when using sendMessage. Use the following syntax in your message: *bold text* _italic text_ [text](URL) inline fixed-width code pre-formatted fixed-width code block

HTML style

To use this mode, pass HTML in the parse_mode field when using sendMessage. The following tags are currently supported: bold, bold italic, italic inline URL inline fixed-width code

pre-formatted fixed-width code block

Please note:

Only the tags mentioned above are currently supported. Tags must not be nested. All <, > and & symbols that are not a part of a tag or an HTML entity must be replaced with the corresponding HTML entities (< with <, > with > and & with &). All numerical HTML entities are supported. The API currently supports only the following named HTML entities: <, >, & and ".

chatId

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

text

String Text of the message to be sent

parseMode

String Optional Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.

disableWebPagePreview

Boolean Optional Disables link previews for links in this message

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, JsonRequest[Message], Request[Message], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SendMessage
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. JsonRequest
  7. Request
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SendMessage(chatId: ChatId, text: String, parseMode: Option[ParseMode] = None, disableWebPagePreview: Option[Boolean] = None, disableNotification: Option[Boolean] = None, replyToMessageId: Option[Int] = 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)

    text

    String Text of the message to be sent

    parseMode

    String Optional Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.

    disableWebPagePreview

    Boolean Optional Disables link previews for links in this message

    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 chatId: ChatId

    Permalink

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

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. 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.

  8. val disableWebPagePreview: Option[Boolean]

    Permalink

    Boolean Optional Disables link previews for links in this message

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. def methodName: String

    Permalink

    Extract request URL from class name.

    Extract request URL from class name.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  17. 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 your bot's message.

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

  19. val replyToMessageId: Option[Int]

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  21. val text: String

    Permalink

    String Text of the message to be sent

  22. final def wait(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. 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 JsonRequest[Message]

Inherited from Request[Message]

Inherited from AnyRef

Inherited from Any

Ungrouped