Struct botapi::gen_types::KeyboardButtonRequestChat

pub struct KeyboardButtonRequestChat {
    pub request_id: i64,
    pub chat_is_channel: bool,
    pub chat_is_forum: Option<bool>,
    pub chat_has_username: Option<bool>,
    pub chat_is_created: Option<bool>,
    pub user_administrator_rights: Option<BoxWrapper<Unbox<ChatAdministratorRights>>>,
    pub bot_administrator_rights: Option<BoxWrapper<Unbox<ChatAdministratorRights>>>,
    pub bot_is_member: Option<bool>,
    pub request_title: Option<bool>,
    pub request_username: Option<bool>,
    pub request_photo: Option<bool>,
}

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. More about requesting chats: https://core.telegram.org/bots/features#chat-and-user-selection.

Fields

request_id: i64

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

chat_is_channel: bool

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

chat_is_forum: Option<bool>

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

chat_has_username: Option<bool>

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.

chat_is_created: Option<bool>

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

user_administrator_rights: Option<BoxWrapper<Unbox<ChatAdministratorRights>>>

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.

bot_administrator_rights: Option<BoxWrapper<Unbox<ChatAdministratorRights>>>

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.

bot_is_member: Option<bool>

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

request_title: Option<bool>

Optional. Pass True to request the chat’s title

request_username: Option<bool>

Optional. Pass True to request the chat’s username

request_photo: Option<bool>

Optional. Pass True to request the chat’s photo

Implementations

impl KeyboardButtonRequestChat

pub fn noskip(self) -> NoSkipKeyboardButtonRequestChat

impl KeyboardButtonRequestChat

pub fn new(request_id: i64, chat_is_channel: bool) -> Self

pub fn get_request_id<'a>(&'a self) -> i64

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

pub fn set_request_id<'a>(&'a mut self, request_id: i64) -> &'a mut Self

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

pub fn get_chat_is_channel<'a>(&'a self) -> bool

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

pub fn set_chat_is_channel<'a>( &'a mut self, chat_is_channel: bool, ) -> &'a mut Self

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

pub fn get_chat_is_forum<'a>(&'a self) -> Option<bool>

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

pub fn set_chat_is_forum<'a>( &'a mut self, chat_is_forum: Option<bool>, ) -> &'a mut Self

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

pub fn get_chat_has_username<'a>(&'a self) -> Option<bool>

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.

pub fn set_chat_has_username<'a>( &'a mut self, chat_has_username: Option<bool>, ) -> &'a mut Self

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.

pub fn get_chat_is_created<'a>(&'a self) -> Option<bool>

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

pub fn set_chat_is_created<'a>( &'a mut self, chat_is_created: Option<bool>, ) -> &'a mut Self

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

pub fn get_user_administrator_rights<'a>( &'a self, ) -> Option<&'a ChatAdministratorRights>

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.

pub fn set_user_administrator_rights<'a>( &'a mut self, user_administrator_rights: Option<ChatAdministratorRights>, ) -> &'a mut Self

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.

pub fn get_bot_administrator_rights<'a>( &'a self, ) -> Option<&'a ChatAdministratorRights>

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.

pub fn set_bot_administrator_rights<'a>( &'a mut self, bot_administrator_rights: Option<ChatAdministratorRights>, ) -> &'a mut Self

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.

pub fn get_bot_is_member<'a>(&'a self) -> Option<bool>

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

pub fn set_bot_is_member<'a>( &'a mut self, bot_is_member: Option<bool>, ) -> &'a mut Self

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

pub fn get_request_title<'a>(&'a self) -> Option<bool>

Optional. Pass True to request the chat’s title

pub fn set_request_title<'a>( &'a mut self, request_title: Option<bool>, ) -> &'a mut Self

Optional. Pass True to request the chat’s title

pub fn get_request_username<'a>(&'a self) -> Option<bool>

Optional. Pass True to request the chat’s username

pub fn set_request_username<'a>( &'a mut self, request_username: Option<bool>, ) -> &'a mut Self

Optional. Pass True to request the chat’s username

pub fn get_request_photo<'a>(&'a self) -> Option<bool>

Optional. Pass True to request the chat’s photo

pub fn set_request_photo<'a>( &'a mut self, request_photo: Option<bool>, ) -> &'a mut Self

Optional. Pass True to request the chat’s photo

Trait Implementations

impl Clone for KeyboardButtonRequestChat

fn clone(&self) -> KeyboardButtonRequestChat

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyboardButtonRequestChat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for KeyboardButtonRequestChat

fn default() -> KeyboardButtonRequestChat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyboardButtonRequestChat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BoxWrapper<Box<KeyboardButtonRequestChat>>> for KeyboardButtonRequestChat

fn from(t: BoxWrapper<Box<KeyboardButtonRequestChat>>) -> Self

Converts to this type from the input type.

impl From<BoxWrapper<Unbox<KeyboardButtonRequestChat>>> for KeyboardButtonRequestChat

fn from(t: BoxWrapper<Unbox<KeyboardButtonRequestChat>>) -> Self

Converts to this type from the input type.

impl From<NoSkipKeyboardButtonRequestChat> for KeyboardButtonRequestChat

fn from(t: NoSkipKeyboardButtonRequestChat) -> Self

Converts to this type from the input type.

impl Hash for KeyboardButtonRequestChat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Into<NoSkipKeyboardButtonRequestChat> for KeyboardButtonRequestChat

fn into(self) -> NoSkipKeyboardButtonRequestChat

Converts this type into the (usually inferred) input type.

impl Ord for KeyboardButtonRequestChat

fn cmp(&self, other: &KeyboardButtonRequestChat) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for KeyboardButtonRequestChat

fn eq(&self, other: &KeyboardButtonRequestChat) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for KeyboardButtonRequestChat

fn partial_cmp(&self, other: &KeyboardButtonRequestChat) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for KeyboardButtonRequestChat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for KeyboardButtonRequestChat

impl StructuralPartialEq for KeyboardButtonRequestChat