class Tourmaline::KeyboardButtonRequestChat
- Tourmaline::KeyboardButtonRequestChat
- Reference
- Object
Overview
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: https://core.telegram.org/bots/features#chat-and-user-selection
Included Modules
- JSON::Serializable
Defined in:
tourmaline/types/api.crConstructors
- .new(request_id : Int32 | Int64, chat_is_channel : Bool, chat_is_forum : Bool | Nil = nil, chat_has_username : Bool | Nil = nil, chat_is_created : Bool | Nil = nil, user_administrator_rights : Tourmaline::ChatAdministratorRights | Nil = nil, bot_administrator_rights : Tourmaline::ChatAdministratorRights | Nil = nil, bot_is_member : Bool | Nil = nil)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#bot_administrator_rights : Tourmaline::ChatAdministratorRights | Nil
Optional.
-
#bot_administrator_rights=(bot_administrator_rights : Tourmaline::ChatAdministratorRights | Nil)
Optional.
-
#bot_is_member=(bot_is_member : Bool | Nil)
Optional.
-
#bot_is_member? : Bool | Nil
Optional.
-
#chat_has_username=(chat_has_username : Bool | Nil)
Optional.
-
#chat_has_username? : Bool | Nil
Optional.
-
#chat_is_channel=(chat_is_channel : Bool)
Pass True to request a channel chat, pass False to request a group or a supergroup chat.
-
#chat_is_channel? : Bool
Pass True to request a channel chat, pass False to request a group or a supergroup chat.
-
#chat_is_created=(chat_is_created : Bool | Nil)
Optional.
-
#chat_is_created? : Bool | Nil
Optional.
-
#chat_is_forum=(chat_is_forum : Bool | Nil)
Optional.
-
#chat_is_forum? : Bool | Nil
Optional.
-
#request_id : Int32 | Int64
Signed 32-bit identifier of the request, which will be received back in the ChatShared object.
-
#request_id=(request_id : Int32 | Int64)
Signed 32-bit identifier of the request, which will be received back in the ChatShared object.
-
#user_administrator_rights : Tourmaline::ChatAdministratorRights | Nil
Optional.
-
#user_administrator_rights=(user_administrator_rights : Tourmaline::ChatAdministratorRights | Nil)
Optional.
Constructor Detail
Instance Method Detail
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.
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.
Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.
Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.
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.
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.
Pass True to request a channel chat, pass False to request a group or a supergroup chat.
Pass True to request a channel chat, pass False to request a group or a supergroup chat.
Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.
Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.
Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.
Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.
Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message
Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message
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.
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.