markup

func Button ¶

func Button(text string, style ...StyleOption) tg.KeyboardButton

Button creates new plain text button.

func Buy ¶

func Buy(text string, style ...StyleOption) tg.KeyboardInlineButton

Buy creates button to buy a product.

func Callback ¶

func Callback(text string, data []byte, style ...StyleOption) tg.KeyboardInlineButton

Callback creates new callback button.

func Copy ¶

func Copy(text, copyText string, style ...StyleOption) tg.KeyboardInlineButton

Copy creates button that copies copyText to the clipboard when pressed.

func Disabled ¶

func Disabled(text string, style ...StyleOption) tg.KeyboardInlineButton

Disabled creates button that does nothing when pressed.

func ForceReply ¶

func ForceReply(singleUse, selective bool) tg.ReplyMarkupClass

ForceReply creates markup to force the user to send a reply.

func Game ¶

func Game(text string, style ...StyleOption) tg.KeyboardInlineButton

Game creates button to start a game.

func Hide ¶

func Hide() tg.ReplyMarkupClass

Hide creates markup to hide markup.

func InlineButtonRow ¶

func InlineButtonRow(buttons ...tg.KeyboardInlineButton) tg.KeyboardInlineButtonRow

InlineButtonRow creates inline keyboard row.

func InlineKeyboard ¶

func InlineKeyboard(rows ...tg.KeyboardInlineButtonRow) tg.ReplyMarkupClass

InlineKeyboard creates inline keyboard using given rows.

func InlineRow ¶

func InlineRow(buttons ...tg.KeyboardInlineButton) tg.ReplyMarkupClass

InlineRow creates inline keyboard with single row using given buttons.

func InputRequestPeer ¶

func InputRequestPeer(text string, typ tg.InputButtonTypeRequestPeer, style ...StyleOption) tg.KeyboardButton

InputRequestPeer creates button that prompts the user to select and share a peer with the bot, requesting the peer's name, username and/or photo. Use it to send a button, use RequestPeer to handle a received one.

func InputURLAuth ¶ added in v0.85.0

func InputURLAuth(
	requestWriteAccess bool, text, fwdText, url string, bot tg.InputUserClass, style ...StyleOption,
) tg.KeyboardInlineButton

InputURLAuth creates button to request a user to authorize via URL using Seamless Telegram Login. Use it to send a button, use URLAuth to handle a received one.

func InputUserProfile ¶ added in v0.85.0

func InputUserProfile(text string, user tg.InputUserClass, style ...StyleOption) tg.KeyboardInlineButton

InputUserProfile creates button that links directly to a user profile. Use it to send a button, use UserProfile to handle a received one.

func Keyboard ¶

func Keyboard(rows ...tg.KeyboardButtonRow) tg.ReplyMarkupClass

Keyboard creates keyboard using given rows.

func RequestGeoLocation ¶

func RequestGeoLocation(text string, style ...StyleOption) tg.KeyboardButton

RequestGeoLocation creates button to request a user's geo location.

func RequestPeer ¶ added in v0.85.0

func RequestPeer(text string, buttonID int, peerType tg.RequestPeerTypeClass, style ...StyleOption) tg.KeyboardButton

RequestPeer creates button that prompts the user to select and share a peer with the bot using messages.sendBotRequestedPeer.

func RequestPhone ¶

func RequestPhone(text string, style ...StyleOption) tg.KeyboardButton

RequestPhone creates button to request a user's phone number.

func RequestPoll ¶

func RequestPoll(text string, quiz bool, style ...StyleOption) tg.KeyboardButton

RequestPoll creates button that allows the user to create and send a poll when pressed. Available only in private.

func Row ¶

func Row(buttons ...tg.KeyboardButton) tg.KeyboardButtonRow

Row creates reply keyboard row.

func SelectiveHide ¶

func SelectiveHide() tg.ReplyMarkupClass

SelectiveHide creates markup to hide markup. Use this builder if you want to remove the keyboard for 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 reply_to_message_id), sender of the original message.

Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.

func SimpleWebView ¶ added in v0.85.0

func SimpleWebView(text, url string, style ...StyleOption) tg.KeyboardButton

SimpleWebView creates button to open a bot web app using messages.requestSimpleWebView, without sending user information to the web app. Can only be sent or received as part of a reply keyboard, use WebView for inline keyboards.

func SingleRow ¶

func SingleRow(buttons ...tg.KeyboardButton) tg.ReplyMarkupClass

SingleRow creates keyboard with single row using given buttons.

func SwitchInline ¶

func SwitchInline(text, query string, samePeer bool, style ...StyleOption) tg.KeyboardInlineButton

SwitchInline creates button to force a user to switch to inline mode. Pressing the button will prompt the user to select one of their chats, open that chat and insert the bot‘s username and the specified inline query in the input field.

If samePeer set, pressing the button will insert the bot‘s username and the specified inline query in the current chat's input field.

func URL ¶

func URL(text, url string, style ...StyleOption) tg.KeyboardInlineButton

URL creates new URL button.

func URLAuth ¶

func URLAuth(text, url string, buttonID int, fwdText string, style ...StyleOption) tg.KeyboardInlineButton

URLAuth creates button to request a user to authorize via URL using Seamless Telegram Login. Use InputURLAuth to send such a button.

func UserProfile ¶ added in v0.85.0

func UserProfile(text string, userID int64, style ...StyleOption) tg.KeyboardInlineButton

UserProfile creates button that links directly to a user profile. Use InputUserProfile to send such a button.

func WebView ¶ added in v0.85.0

func WebView(text, url string, style ...StyleOption) tg.KeyboardInlineButton

WebView creates button to open a bot web app using messages.requestWebView, sending over user information after user confirmation. Can only be sent or received as part of an inline keyboard, use SimpleWebView for reply keyboards.