keyboard

Documentation

Index

• Constants
• type Action
• type Button
• type Color
• type Keyboard
  • func Empty() *Keyboard
  • func New(oneTime bool, inline bool) *Keyboard
  • func (k *Keyboard) AddCallback(label string, color Color, payload vkapi.JSONData) bool
  • func (k *Keyboard) AddLocation(payload vkapi.JSONData) bool
  • func (k *Keyboard) AddOpenApp(appID, ownerID int, hash string) bool
  • func (k *Keyboard) AddOpenLink(label string, link string) bool
  • func (k *Keyboard) AddText(label string, color Color, payload vkapi.JSONData) bool
  • func (k *Keyboard) AddVkPay(hash string) bool
  • func (k *Keyboard) Data() vkapi.JSONData
  • func (k *Keyboard) NextRow() bool

Constants

const (
	MaxButtonsOnLine = 5
	MaxDefaultLines  = 10
	MaxInlineLines   = 6
)

Types

type Action

type Action struct {
	Type    string         `json:"type"`
	Payload vkapi.JSONData `json:"payload,omitempty"`
	Label   string         `json:"label,omitempty"`
	Link    string         `json:"link,omitempty"`
	Hash    string         `json:"hash,omitempty"`
	AppID   int            `json:"app_id,omitempty"`
	OwnerID int            `json:"owner_id,omitempty"`
}

Action type.

type Button

type Button struct {
	Color  Color  `json:"color,omitempty"`
	Action Action `json:"action"`
}

Button type.

type Color

type Color string

Color type.

const (
	// Blue
	ColorPrimary Color = "primary"
	// White
	ColorSecondary Color = "secondary"
	// Red
	ColorNegative Color = "negative"
	// Green
	ColorPositive Color = "positive"
)

type Keyboard

type Keyboard struct {
	Buttons [][]Button `json:"buttons"`
	OneTime bool       `json:"one_time"`
	Inline  bool       `json:"inline"`
}

Keyboard struct.

func Empty

func Empty() *Keyboard

Empty creates empty keyboard to remove an existing.

func New

func New(oneTime bool, inline bool) *Keyboard

New creates new keyboard.

func (*Keyboard) AddCallback

func (k *Keyboard) AddCallback(label string, color Color, payload vkapi.JSONData) bool

AddCallback adds a callback text button to the last row.

func (*Keyboard) AddLocation

func (k *Keyboard) AddLocation(payload vkapi.JSONData) bool

AddLocation adds a location button to the last row.

func (*Keyboard) AddOpenApp

func (k *Keyboard) AddOpenApp(appID, ownerID int, hash string) bool

AddOpenApp adds a button with link to the vkapp to the last row.

func (*Keyboard) AddOpenLink

func (k *Keyboard) AddOpenLink(label string, link string) bool

AddOpenLink adds a button with external link to the last row.

func (*Keyboard) AddText

func (k *Keyboard) AddText(label string, color Color, payload vkapi.JSONData) bool

AddText adds a text button to the last row.

func (*Keyboard) AddVkPay

func (k *Keyboard) AddVkPay(hash string) bool

AddVkPay adds a VKPay button to the last row.

func (*Keyboard) Data

func (k *Keyboard) Data() vkapi.JSONData

Data converts the keyboard into a sandable object.

func (*Keyboard) NextRow

func (k *Keyboard) NextRow() bool

NextRow adds line of buttons.