simbot-component-telegram-type/love.forte.simbot.telegram.type/KeyboardButtonRequestChat

KeyboardButtonRequestChat

data class KeyboardButtonRequestChat(val requestId: Int, val chatIsChannel: Boolean, val chatIsForum: Boolean? = null, val chatHasUsername: Boolean? = null, val chatIsCreated: Boolean? = null, val userAdministratorRights: ChatAdministratorRights? = null, val botAdministratorRights: ChatAdministratorRights? = null, val botIsMember: Boolean? = null)(source)

This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed. More about requesting chats »

(auto-generated)

Author

ForteScarlet

Constructors

KeyboardButtonRequestChat

constructor(requestId: Int, chatIsChannel: Boolean, chatIsForum: Boolean? = null, chatHasUsername: Boolean? = null, chatIsCreated: Boolean? = null, userAdministratorRights: ChatAdministratorRights? = null, botAdministratorRights: ChatAdministratorRights? = null, botIsMember: Boolean? = null)

Properties

botAdministratorRights

@SerialName(value = "bot_administrator_rights")

val botAdministratorRights: ChatAdministratorRights? = null

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

botIsMember

@SerialName(value = "bot_is_member")

val botIsMember: Boolean? = null

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

chatHasUsername

@SerialName(value = "chat_has_username")

val chatHasUsername: Boolean? = null

Optional. 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.

chatIsChannel

@SerialName(value = "chat_is_channel")

val chatIsChannel: Boolean

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

chatIsCreated

@SerialName(value = "chat_is_created")

val chatIsCreated: Boolean? = null

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

chatIsForum

@SerialName(value = "chat_is_forum")

val chatIsForum: Boolean? = null

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

requestId

@SerialName(value = "request_id")

val requestId: Int

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

userAdministratorRights

@SerialName(value = "user_administrator_rights")

val userAdministratorRights: ChatAdministratorRights? = null

Optional. 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.