Enum rtdlib::types::AuthorizationState

pub enum AuthorizationState {
    Closed(AuthorizationStateClosed),
    Closing(AuthorizationStateClosing),
    LoggingOut(AuthorizationStateLoggingOut),
    Ready(AuthorizationStateReady),
    WaitCode(AuthorizationStateWaitCode),
    WaitEncryptionKey(AuthorizationStateWaitEncryptionKey),
    WaitOtherDeviceConfirmation(AuthorizationStateWaitOtherDeviceConfirmation),
    WaitPassword(AuthorizationStateWaitPassword),
    WaitPhoneNumber(AuthorizationStateWaitPhoneNumber),
    WaitRegistration(AuthorizationStateWaitRegistration),
    WaitTdlibParameters(AuthorizationStateWaitTdlibParameters),
    GetAuthorizationState(GetAuthorizationState),
    // some variants omitted
}

Represents the current authorization state of the client

Variants

Closed(AuthorizationStateClosed)

TDLib client is in its final state. All databases are closed and all resources are released. No other updates will be received after this. All queries will be responded to with error code 500. To continue working, one should create a new instance of the TDLib client

Closing(AuthorizationStateClosing)

TDLib is closing, all subsequent queries will be answered with the error 500. Note that closing TDLib can take a while. All resources will be freed only after authorizationStateClosed has been received

LoggingOut(AuthorizationStateLoggingOut)

The user is currently logging out

Ready(AuthorizationStateReady)

The user has been successfully authorized. TDLib is now ready to answer queries

WaitCode(AuthorizationStateWaitCode)

TDLib needs the user's authentication code to authorize

WaitEncryptionKey(AuthorizationStateWaitEncryptionKey)

TDLib needs an encryption key to decrypt the local database

WaitOtherDeviceConfirmation(AuthorizationStateWaitOtherDeviceConfirmation)

The user needs to confirm authorization on another logged in device by scanning a QR code with the provided link

WaitPassword(AuthorizationStateWaitPassword)

The user has been authorized, but needs to enter a password to start using the application

WaitPhoneNumber(AuthorizationStateWaitPhoneNumber)

TDLib needs the user's phone number to authorize. Call setAuthenticationPhoneNumber to provide the phone number, or use requestQrCodeAuthentication, or checkAuthenticationBotToken for other authentication options

WaitRegistration(AuthorizationStateWaitRegistration)

The user is unregistered and need to accept terms of service and enter their first name and last name to finish registration

WaitTdlibParameters(AuthorizationStateWaitTdlibParameters)

TDLib needs TdlibParameters for initialization

GetAuthorizationState(GetAuthorizationState)

Returns the current authorization state; this is an offline request. For informational purposes only. Use updateAuthorizationState instead to maintain the current authorization state

Implementations

impl AuthorizationState

pub fn from_json<S: AsRef<str>>(json: S) -> RTDResult<Self>

pub fn is_closed(&self) -> bool

pub fn is_closing(&self) -> bool

pub fn is_logging_out(&self) -> bool

pub fn is_ready(&self) -> bool

pub fn is_wait_code(&self) -> bool

pub fn is_wait_encryption_key(&self) -> bool

pub fn is_wait_other_device_confirmation(&self) -> bool

pub fn is_wait_password(&self) -> bool

pub fn is_wait_phone_number(&self) -> bool

pub fn is_wait_registration(&self) -> bool

pub fn is_wait_tdlib_parameters(&self) -> bool

pub fn is_get_authorization_state(&self) -> bool

pub fn on_closed<F: FnOnce(&AuthorizationStateClosed)>(&self, fnc: F) -> &Self

pub fn on_closing<F: FnOnce(&AuthorizationStateClosing)>(&self, fnc: F) -> &Self

pub fn on_logging_out<F: FnOnce(&AuthorizationStateLoggingOut)>(
    &self,
    fnc: F
) -> &Self

pub fn on_ready<F: FnOnce(&AuthorizationStateReady)>(&self, fnc: F) -> &Self

pub fn on_wait_code<F: FnOnce(&AuthorizationStateWaitCode)>(
    &self,
    fnc: F
) -> &Self

pub fn on_wait_encryption_key<F: FnOnce(&AuthorizationStateWaitEncryptionKey)>(
    &self,
    fnc: F
) -> &Self

pub fn on_wait_other_device_confirmation<F: FnOnce(&AuthorizationStateWaitOtherDeviceConfirmation)>(
    &self,
    fnc: F
) -> &Self

pub fn on_wait_password<F: FnOnce(&AuthorizationStateWaitPassword)>(
    &self,
    fnc: F
) -> &Self

pub fn on_wait_phone_number<F: FnOnce(&AuthorizationStateWaitPhoneNumber)>(
    &self,
    fnc: F
) -> &Self

pub fn on_wait_registration<F: FnOnce(&AuthorizationStateWaitRegistration)>(
    &self,
    fnc: F
) -> &Self

pub fn on_wait_tdlib_parameters<F: FnOnce(&AuthorizationStateWaitTdlibParameters)>(
    &self,
    fnc: F
) -> &Self

pub fn on_get_authorization_state<F: FnOnce(&GetAuthorizationState)>(
    &self,
    fnc: F
) -> &Self

pub fn as_closed(&self) -> Option<&AuthorizationStateClosed>

pub fn as_closing(&self) -> Option<&AuthorizationStateClosing>

pub fn as_logging_out(&self) -> Option<&AuthorizationStateLoggingOut>

pub fn as_ready(&self) -> Option<&AuthorizationStateReady>

pub fn as_wait_code(&self) -> Option<&AuthorizationStateWaitCode>

pub fn as_wait_encryption_key(
    &self
) -> Option<&AuthorizationStateWaitEncryptionKey>

pub fn as_wait_other_device_confirmation(
    &self
) -> Option<&AuthorizationStateWaitOtherDeviceConfirmation>

pub fn as_wait_password(&self) -> Option<&AuthorizationStateWaitPassword>

pub fn as_wait_phone_number(&self) -> Option<&AuthorizationStateWaitPhoneNumber>

pub fn as_wait_registration(
    &self
) -> Option<&AuthorizationStateWaitRegistration>

pub fn as_wait_tdlib_parameters(
    &self
) -> Option<&AuthorizationStateWaitTdlibParameters>

pub fn as_get_authorization_state(&self) -> Option<&GetAuthorizationState>

pub fn closed<T: AsRef<AuthorizationStateClosed>>(t: T) -> Self

pub fn closing<T: AsRef<AuthorizationStateClosing>>(t: T) -> Self

pub fn logging_out<T: AsRef<AuthorizationStateLoggingOut>>(t: T) -> Self

pub fn ready<T: AsRef<AuthorizationStateReady>>(t: T) -> Self

pub fn wait_code<T: AsRef<AuthorizationStateWaitCode>>(t: T) -> Self

pub fn wait_encryption_key<T: AsRef<AuthorizationStateWaitEncryptionKey>>(
    t: T
) -> Self

pub fn wait_other_device_confirmation<T: AsRef<AuthorizationStateWaitOtherDeviceConfirmation>>(
    t: T
) -> Self

pub fn wait_password<T: AsRef<AuthorizationStateWaitPassword>>(t: T) -> Self

pub fn wait_phone_number<T: AsRef<AuthorizationStateWaitPhoneNumber>>(
    t: T
) -> Self

pub fn wait_registration<T: AsRef<AuthorizationStateWaitRegistration>>(
    t: T
) -> Self

pub fn wait_tdlib_parameters<T: AsRef<AuthorizationStateWaitTdlibParameters>>(
    t: T
) -> Self

pub fn get_authorization_state<T: AsRef<GetAuthorizationState>>(t: T) -> Self

Trait Implementations

impl AsRef<AuthorizationState> for AuthorizationState

fn as_ref(&self) -> &AuthorizationState

Performs the conversion.

impl Clone for AuthorizationState

fn clone(&self) -> AuthorizationState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthorizationState

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

Formats the value using the given formatter.

impl Default for AuthorizationState

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for AuthorizationState

fn deserialize<D>(deserializer: D) -> Result<AuthorizationState, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl RObject for AuthorizationState

fn to_json(&self) -> RTDResult<String>

Return td type to json string

impl Serialize for AuthorizationState

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

Serialize this value into the given Serde serializer.