telega/keyboard

This module contains the keyboard constructors and usefull utilities to work with keyboards

Types

InlineKeyboard

opaque </>

pub opaque type InlineKeyboard

Keyboard

opaque </>

pub opaque type Keyboard

KeyboardCallback

</>

pub type KeyboardCallback(data) {
  KeyboardCallback(
    id: String,
    payload: String,
    data: data,
    callback_data: KeyboardCallbackData(data),
  )
}

Constructors

KeyboardCallback(
  id: String,
  payload: String,
  data: data,
  callback_data: KeyboardCallbackData(data),
)

KeyboardCallbackData

opaque </>

pub opaque type KeyboardCallbackData(data)

Functions

build

</>

pub fn build(keyboard: Keyboard) -> ReplyMarkup

Build a reply markup for Message from a keyboard

build_inline

</>

pub fn build_inline(keyboard: InlineKeyboard) -> ReplyMarkup

Build a reply markup for Message from an inline keyboard

button

</>

pub fn button(text: String) -> KeyboardButton

Create a new keyboard button

filter_inline_keyboard_query

</>

pub fn filter_inline_keyboard_query(
  keyboard: InlineKeyboard,
) -> CallbackQueryFilter

hear

</>

pub fn hear(keyboard: Keyboard) -> Hears

inline_button

</>

pub fn inline_button(
  text text: String,
  callback_data callback_data: KeyboardCallback(a),
) -> InlineKeyboardButton

Create a new inline button

new

</>

pub fn new(buttons: List(List(KeyboardButton))) -> Keyboard

Create a new keyboard

new_callback_data

</>

pub fn new_callback_data(
  id id: String,
  serilize serilize: fn(a) -> String,
  deserialize deserialize: fn(String) -> a,
) -> KeyboardCallbackData(a)

Create a new callback data for inline keyboard buttons

new_inline

</>

pub fn new_inline(
  buttons: List(List(InlineKeyboardButton)),
) -> InlineKeyboard

Create a new inline keyboard

one_time

</>

pub fn one_time(keyboard: Keyboard) -> Keyboard

Make the keyboard one-time

pack_callback

</>

pub fn pack_callback(
  callback_data callback_data: KeyboardCallbackData(a),
  data data: a,
) -> KeyboardCallback(a)

Pack callback data into a callback

persistent

</>

pub fn persistent(keyboard: Keyboard) -> Keyboard

Make the keyboard persistent

placeholder

</>

pub fn placeholder(keyboard: Keyboard, text: String) -> Keyboard

Set the placeholder for the input field

resized

</>

pub fn resized(keyboard: Keyboard) -> Keyboard

Make the keyboard resizable

selected

</>

pub fn selected(keyboard: Keyboard) -> Keyboard

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

set_callback_data_delimiter

</>

pub fn set_callback_data_delimiter(
  data: KeyboardCallbackData(a),
  delimiter: String,
) -> KeyboardCallbackData(a)

Change the delimiter for the callback data, usefull if you need to use : in the id

unpack_callback

</>

pub fn unpack_callback(
  payload payload: String,
  callback_data callback_data: KeyboardCallbackData(a),
) -> Result(KeyboardCallback(a), Nil)

Unpack payload into a callback