Class/Object

com.bot4s.telegram.models

ReplyKeyboardMarkup

Related Docs: object ReplyKeyboardMarkup | package models

Permalink

case class ReplyKeyboardMarkup(keyboard: Seq[Seq[KeyboardButton]], resizeKeyboard: Option[Boolean] = None, oneTimeKeyboard: Option[Boolean] = None, selective: Option[Boolean] = None) extends ReplyMarkup with Product with Serializable

This object represents a custom keyboard with reply options (see Introduction to bots for details and telegrambot4s.examples).

Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.

keyboard

Array of button rows, each represented by an Array of KeyboardButton objects

resizeKeyboard

Optional Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.

oneTimeKeyboard

Optional Requests clients to hide the keyboard as soon as it's been used. Defaults to false.

selective

Optional Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has replyToMessage_id), sender of the original message.

Linear Supertypes
Serializable, Serializable, Product, Equals, ReplyMarkup, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReplyKeyboardMarkup
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ReplyMarkup
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ReplyKeyboardMarkup(keyboard: Seq[Seq[KeyboardButton]], resizeKeyboard: Option[Boolean] = None, oneTimeKeyboard: Option[Boolean] = None, selective: Option[Boolean] = None)

    Permalink

    keyboard

    Array of button rows, each represented by an Array of KeyboardButton objects

    resizeKeyboard

    Optional Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.

    oneTimeKeyboard

    Optional Requests clients to hide the keyboard as soon as it's been used. Defaults to false.

    selective

    Optional Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has replyToMessage_id), sender of the original message.

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. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  10. val keyboard: Seq[Seq[KeyboardButton]]

    Permalink

    Array of button rows, each represented by an Array of KeyboardButton objects

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

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

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

    Permalink
    Definition Classes
    AnyRef
  14. val oneTimeKeyboard: Option[Boolean]

    Permalink

    Optional Requests clients to hide the keyboard as soon as it's been used.

    Optional Requests clients to hide the keyboard as soon as it's been used. Defaults to false.

  15. val resizeKeyboard: Option[Boolean]

    Permalink

    Optional Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons).

    Optional Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.

  16. val selective: Option[Boolean]

    Permalink

    Optional Use this parameter if you want to show the keyboard to specific users only.

    Optional Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has replyToMessage_id), sender of the original message.

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped