class Hamilton::Types::KeyboardButtonRequestChat

• Hamilton::Types::KeyboardButtonRequestChat
• Reference
• Object

Overview

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.

Included Modules

• Hamilton::Types::Common
• JSON::Serializable

Defined in:

types/keyboard_button_request_chat.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(params)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)
• .new(**params)

Instance Method Summary

• #bot_administrator_rights : Hamilton::Types::ChatAdministratorRights | Nil

  A JSON-serialized object listing the required administrator rights of the bot in the chat.

• #bot_administrator_rights=(bot_administrator_rights : Hamilton::Types::ChatAdministratorRights | Nil)

  A JSON-serialized object listing the required administrator rights of the bot in the chat.

• #bot_is_member : Bool | Nil

  Pass True to request a chat with the bot as a member.

• #bot_is_member=(bot_is_member : Bool | Nil)

  Pass True to request a chat with the bot as a member.

• #chat_created : Bool | Nil

  Pass True to request a chat owned by the user.

• #chat_created=(chat_created : Bool | Nil)

  Pass True to request a chat owned by the user.

• #chat_has_username : Bool | Nil

  Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username.

• #chat_has_username=(chat_has_username : Bool | Nil)

  Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username.

• #chat_is_channel : Bool

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

• #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_forum : Bool | Nil

  Pass True to request a forum supergroup, pass False to request a non-forum chat.

• #chat_is_forum=(chat_is_forum : Bool | Nil)

  Pass True to request a forum supergroup, pass False to request a non-forum chat.

• #non_nil_fields : Array(String)

  List of available non-nil fields.

• #non_nil_fields=(non_nil_fields : Array(String))

  List of available non-nil fields.

• #request_id : Int32

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

• #request_id=(request_id : Int32)

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

• #request_photo : Bool | Nil

  Pass True to request the chat's photo.

• #request_photo=(request_photo : Bool | Nil)

  Pass True to request the chat's photo.

• #request_title : Bool | Nil

  Pass True to request the chat's title.

• #request_title=(request_title : Bool | Nil)

  Pass True to request the chat's title.

• #request_username : Bool | Nil

  Pass True to request the chat's username.

• #request_username=(request_username : Bool | Nil)

  Pass True to request the chat's username.

• #user_administrator_rights : Hamilton::Types::ChatAdministratorRights | Nil

  A JSON-serialized object listing the required administrator rights of the user in the chat.

• #user_administrator_rights=(user_administrator_rights : Hamilton::Types::ChatAdministratorRights | Nil)

  A JSON-serialized object listing the required administrator rights of the user in the chat.

Constructor Detail

Instance Method Detail