Class KeyboardButtonRequestUsers

java.lang.Object

io.github.natanimn.telebof.types.keyboard.KeyboardButtonRequestUsers

All Implemented Interfaces:

Serializable

public class KeyboardButtonRequestUsers
extends Object
implements Serializable

This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed.

Since:

3 March 2025

See Also:

• More about requesting users »
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
KeyboardButtonRequestUsers(long request_id)	Required

Method Summary

Modifier and Type	Method	Description
KeyboardButtonRequestUsers	maxQuantity(byte max_quantity)	Optional
KeyboardButtonRequestUsers	requestName(boolean request_name)	Optional
KeyboardButtonRequestUsers	requestPhoto(boolean request_photo)	Optional
KeyboardButtonRequestUsers	requestUsername(boolean request_username)	Optional
KeyboardButtonRequestUsers	userIsBot(boolean user_is_bot)	Optional
KeyboardButtonRequestUsers	userIsPremium(boolean user_is_premium)	Optional

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

KeyboardButtonRequestUsers

public KeyboardButtonRequestUsers(long request_id)

Required

Parameters:

request_id - Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message

Method Details

userIsBot

public KeyboardButtonRequestUsers userIsBot(boolean user_is_bot)

Optional

Parameters:

user_is_bot - Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied.

Returns:

KeyboardButtonRequestUsers

userIsPremium

public KeyboardButtonRequestUsers userIsPremium(boolean user_is_premium)

Optional

Parameters:

user_is_premium - Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied.

Returns:

KeyboardButtonRequestUsers

maxQuantity

public KeyboardButtonRequestUsers maxQuantity(byte max_quantity)

Optional

Parameters:

max_quantity - The maximum number of users to be selected; 1-10. Defaults to 1

Returns:

KeyboardButtonRequestUsers

requestName

public KeyboardButtonRequestUsers requestName(boolean request_name)

Optional

Parameters:

request_name - Pass True to request the users' first and last names

Returns:

KeyboardButtonRequestUsers

requestUsername

public KeyboardButtonRequestUsers requestUsername(boolean request_username)

Optional

Parameters:

request_username - Pass True to request the users' usernames

Returns:

KeyboardButtonRequestUsers

requestPhoto

public KeyboardButtonRequestUsers requestPhoto(boolean request_photo)

Optional

Parameters:

request_photo - Pass True to request the users' photos

Returns:

KeyboardButtonRequestUsers