Class

com.bot4s.telegram.methods

SendAudio

Related Doc: package methods

Permalink

case class SendAudio(chatId: ChatId, audio: InputFile, duration: Option[Int] = None, caption: Option[String] = None, parseMode: Option[ParseMode] = None, performer: Option[String] = None, title: Option[String] = 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 audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .mp3 format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

For sending voice messages, use the sendVoice method instead.

chatId

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

audio

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

duration

Integer Optional Duration of the audio in seconds

caption

String Optional Audio caption, 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.

performer

String Optional Performer

title

String Optional Track name

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. SendAudio
  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 SendAudio(chatId: ChatId, audio: InputFile, duration: Option[Int] = None, caption: Option[String] = None, parseMode: Option[ParseMode] = None, performer: Option[String] = None, title: Option[String] = 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)

    audio

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

    duration

    Integer Optional Duration of the audio in seconds

    caption

    String Optional Audio caption, 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.

    performer

    String Optional Performer

    title

    String Optional Track name

    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 audio: InputFile

    Permalink

    InputFile or String Audio file to send.

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

  6. val caption: Option[String]

    Permalink

    String Optional Audio caption, 0-200 characters

  7. val chatId: ChatId

    Permalink

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

  8. def clone(): AnyRef

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

  10. val duration: Option[Int]

    Permalink

    Integer Optional Duration of the audio in seconds

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

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

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

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

    Permalink
    Definition Classes
    SendAudioMultipartRequest
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. def methodName: String

    Permalink

    Extract request URL from class name.

    Extract request URL from class name.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  20. 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.

  21. val performer: Option[String]

    Permalink

    String Optional Performer

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

  23. val replyToMessageId: Option[Long]

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  25. val title: Option[String]

    Permalink

    String Optional Track name

  26. final def wait(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. 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