Package io.github.natanimn.telebof.types.keyboard

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 requestId)	Required

Method Summary

Modifier and Type	Method	Description
KeyboardButtonRequestUsers	setMaxQuantity(int maxQuantity)	Optional
KeyboardButtonRequestUsers	setRequestName(boolean requestName)	Optional
KeyboardButtonRequestUsers	setRequestPhoto(boolean requestPhoto)	Optional
KeyboardButtonRequestUsers	setRequestUsername(boolean requestUsername)	Optional
KeyboardButtonRequestUsers	setUserIsBot(boolean userIsBot)	Optional
KeyboardButtonRequestUsers	setUserIsPremium(boolean userIsPremium)	Optional

Methods inherited from class java.lang.Object

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

Constructor Details

KeyboardButtonRequestUsers

public KeyboardButtonRequestUsers(long requestId)

Required

Parameters:

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

Method Details

setUserIsBot

public KeyboardButtonRequestUsers setUserIsBot(boolean userIsBot)

Optional

Parameters:

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

Returns:

KeyboardButtonRequestUsers

setUserIsPremium

public KeyboardButtonRequestUsers setUserIsPremium(boolean userIsPremium)

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

setMaxQuantity

public KeyboardButtonRequestUsers setMaxQuantity(int maxQuantity)

Optional

Parameters:

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

Returns:

KeyboardButtonRequestUsers

setRequestName

public KeyboardButtonRequestUsers setRequestName(boolean requestName)

Optional

Parameters:

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

Returns:

KeyboardButtonRequestUsers

setRequestUsername

public KeyboardButtonRequestUsers setRequestUsername(boolean requestUsername)

Optional

Parameters:

requestUsername - Pass True to request the users' usernames

Returns:

KeyboardButtonRequestUsers

setRequestPhoto

public KeyboardButtonRequestUsers setRequestPhoto(boolean requestPhoto)

Optional

Parameters:

requestPhoto - Pass True to request the users' photos

Returns:

KeyboardButtonRequestUsers