Struct tgbot::types::LoginUrl

pub struct LoginUrl { /* fields omitted */ }

Represents a parameter of the inline keyboard button used to automatically authorize a user

Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram

Methods

impl LoginUrl

pub fn new<S>(url: S) -> Self where
    S: Into<String>, 

Creates a new LoginUrl with given URL

An HTTP URL will be opened with user authorization data added to the query string when the button is pressed

If the user refuses to provide authorization data, the original URL without information about the user will be opened

The data added is the same as described in Receiving authorization data

NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization

pub fn forward_text<S>(self, forward_text: S) -> Self where
    S: Into<String>, 

New text of the button in forwarded messages

pub fn bot_username<S>(self, bot_username: S) -> Self where
    S: Into<String>, 

Username of a bot, which will be used for user authorization

See Setting up a bot for more details

If not specified, the current bot's username will be assumed

The url's domain must be the same as the domain linked with the bot

See Linking your domain to the bot for more details

pub fn request_write_access(self, request_write_access: bool) -> Self

Pass True to request the permission for your bot to send messages to the user

Trait Implementations

impl Clone for LoginUrl

fn clone(&self) -> LoginUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoginUrl

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoginUrl

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<S> From<S> for LoginUrl where
    S: Into<String>, 

fn from(url: S) -> Self

Performs the conversion.

impl Serialize for LoginUrl

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

Serialize this value into the given Serde serializer.