class KeyboardButton

This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields web_app, request_contact, request_location, and request_poll are mutually exclusive.

Methods

__construct(string $text, bool|null $request_contact = null, bool|null $request_location = null, KeyboardButtonPollType|null $request_poll = null, WebAppInfo|null $web_app = null)

No description

string
getText()

Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed.

bool|null
getRequestContact()

Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.

bool|null
getRequestLocation()

Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.

KeyboardButtonPollType|null
getRequestPoll()

Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

WebAppInfo|null
getWebApp()

Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.

Details

at line 17
__construct(string $text, bool|null $request_contact = null, bool|null $request_location = null, KeyboardButtonPollType|null $request_poll = null, WebAppInfo|null $web_app = null)

No description

Parameters

string $text
bool|null $request_contact
bool|null $request_location
KeyboardButtonPollType|null $request_poll
WebAppInfo|null $web_app

at line 29
string getText()

Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed.

Return Value

string

at line 37
bool|null getRequestContact()

Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.

Return Value

bool|null

at line 45
bool|null getRequestLocation()

Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.

Return Value

bool|null

at line 53
KeyboardButtonPollType|null getRequestPoll()

Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

Return Value

KeyboardButtonPollType|null

at line 61
WebAppInfo|null getWebApp()

Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.

Return Value

WebAppInfo|null