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

Class KeyboardButtonRequestChat

java.lang.Object

io.github.natanimn.telebof.types.keyboard.KeyboardButtonRequestChat

All Implemented Interfaces:

Serializable

public class KeyboardButtonRequestChat
extends Object
implements Serializable

This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate.

Since:

3 March 2025, More about requesting chats ».

Author:

Natanim

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private ChatAdministratorRights	botAdministratorRights
private Boolean	botIsMember
private Boolean	chatHasUsername
private Boolean	chatIsChannel
private Boolean	chatIsCreated
private Boolean	chatIsForum
private Long	requestId
private Boolean	requestName
private Boolean	requestPhoto
private Boolean	requestTitle
private Boolean	requestUsername
private ChatAdministratorRights	userAdministratorRights

Constructor Summary

Constructors

Constructor	Description
KeyboardButtonRequestChat(Long requestId, boolean chatIsChannel)	Required

Method Summary

Modifier and Type	Method	Description
KeyboardButtonRequestChat	setBotAdministratorRights(ChatAdministratorRights botAdministratorRights)	Optional
KeyboardButtonRequestChat	setBotIsMember(boolean botIsMember)	Optional
KeyboardButtonRequestChat	setChatHasUsername(boolean chatHasUsername)	Optional
KeyboardButtonRequestChat	setChatIsCreated(boolean chatIsCreated)	Optional
KeyboardButtonRequestChat	setChatIsForum(boolean chatIsForum)	Optional
KeyboardButtonRequestChat	setRequestPhoto(boolean requestPhoto)	Optional
KeyboardButtonRequestChat	setRequestTitle(boolean requestTitle)	Optional
KeyboardButtonRequestChat	setRequestUsername(boolean requestUsername)	Optional
KeyboardButtonRequestChat	setUserAdministratorRights(ChatAdministratorRights userAdministratorRights)	Optional

Methods inherited from class java.lang.Object

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

Field Details

userAdministratorRights

@SerializedName("user_administrator_rights")
private ChatAdministratorRights userAdministratorRights

botAdministratorRights

@SerializedName("bot_administrator_rights")
private ChatAdministratorRights botAdministratorRights

botIsMember

@SerializedName("bot_is_member")
private Boolean botIsMember

chatIsForum

@SerializedName("chat_is_forum")
private Boolean chatIsForum

chatHasUsername

@SerializedName("chat_has_username")
private Boolean chatHasUsername

chatIsCreated

@SerializedName("chat_is_created")
private Boolean chatIsCreated

chatIsChannel

@SerializedName("chat_is_channel")
private Boolean chatIsChannel

requestName

@SerializedName("request_name")
private Boolean requestName

requestTitle

@SerializedName("request_title")
private Boolean requestTitle

requestUsername

@SerializedName("request_username")
private Boolean requestUsername

requestPhoto

@SerializedName("request_photo")
private Boolean requestPhoto

requestId

@SerializedName("request_id")
private Long requestId

Constructor Details

KeyboardButtonRequestChat

public KeyboardButtonRequestChat(Long requestId,
 boolean chatIsChannel)

Required

Parameters:

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

chatIsChannel - Pass True to request a channel chat, pass False to request a group or a supergroup chat.

Method Details

setChatIsForum

public KeyboardButtonRequestChat setChatIsForum(boolean chatIsForum)

Optional

Parameters:

chatIsForum - Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.

Returns:

KeyboardButtonRequestChat

setChatHasUsername

public KeyboardButtonRequestChat setChatHasUsername(boolean chatHasUsername)

Optional

Parameters:

chatHasUsername - Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.

Returns:

KeyboardButtonRequestChat

setChatIsCreated

public KeyboardButtonRequestChat setChatIsCreated(boolean chatIsCreated)

Optional

Parameters:

chatIsCreated - Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.

Returns:

KeyboardButtonRequestChat

setUserAdministratorRights

public KeyboardButtonRequestChat setUserAdministratorRights(ChatAdministratorRights userAdministratorRights)

Optional

Parameters:

userAdministratorRights - A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.

Returns:

KeyboardButtonRequestChat

setBotAdministratorRights

public KeyboardButtonRequestChat setBotAdministratorRights(ChatAdministratorRights botAdministratorRights)

Optional

Parameters:

botAdministratorRights - A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of setUserAdministratorRights(ChatAdministratorRights). If not specified, no additional restrictions are applied.

Returns:

KeyboardButtonRequestChat

setBotIsMember

public KeyboardButtonRequestChat setBotIsMember(boolean botIsMember)

Optional

Parameters:

botIsMember - Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.

Returns:

KeyboardButtonRequestChat

setRequestTitle

public KeyboardButtonRequestChat setRequestTitle(boolean requestTitle)

Optional

Parameters:

requestTitle - Pass True to request the chat's title

Returns:

KeyboardButtonRequestChat

setRequestUsername

public KeyboardButtonRequestChat setRequestUsername(boolean requestUsername)

Optional

Parameters:

requestUsername - Pass True to request the chat's username

Returns:

KeyboardButtonRequestChat

setRequestPhoto

public KeyboardButtonRequestChat setRequestPhoto(boolean requestPhoto)

Optional

Parameters:

requestPhoto - Pass True to request the chat's photo

Returns:

KeyboardButtonRequestChat