Struct AuthDialog 

pub struct AuthDialog {
    stack: TemplateChild<Stack>,
    session: WeakRef<Session>,
    is_presented: Cell<bool>,
    state: RefCell<Option<AuthState>>,
    current_page: RefCell<Option<Widget>>,
    notifier: OnceCell<OneshotNotifier<Option<()>>>,
    abort_handle: RefCell<Option<AbortHandle>>,
}

Fields

stack: TemplateChild<Stack>

session: WeakRef<Session>

The parent session.

is_presented: Cell<bool>

Whether this dialog is presented.

state: RefCell<Option<AuthState>>

The current state of the authentication.

None means that the authentication has not started yet.

current_page: RefCell<Option<Widget>>

The page for the current stage.

notifier: OnceCell<OneshotNotifier<Option<()>>>

The notifier to signal to perform the current stage.

abort_handle: RefCell<Option<AbortHandle>>

The handle to abort the current future.

Implementations

impl AuthDialog

fn register_type()

Registers the type only once.

impl AuthDialog

pub fn downgrade(&self) -> <Self as Downgrade>::Weak

impl AuthDialog

fn notifier(&self) -> &OneshotNotifier<Option<()>>

The notifier to signal to perform the current stage.

pub(super) async fn authenticate<Response, Fut, FN>( &self, parent: &Widget, callback: FN, ) -> Result<Response, AuthError>

where Response: Send + 'static, Fut: Future<Output = Result<Response, Error>> + Send + 'static, FN: Fn(Client, Option<AuthData>) -> Fut + Send + Sync + 'static + Clone,

Authenticate the user to the server via an interactive authentication flow.

The type of flow and the required stages are negotiated during the authentication. Returns the last server response on success.

pub(super) async fn reset_cross_signing( &self, parent: &Widget, ) -> Result<(), AuthError>

Reset the cross-signing keys while handling the interactive authentication flow.

The type of flow and the required stages are negotiated during the authentication.

Note that due to the implementation of the underlying SDK API, this will not work if there are several stages in the flow.

Returns the last server response on success.

async fn await_tokio_task<Response>( &self, handle: JoinHandle<Result<Response, Error>>, ) -> Result<Response, AuthError>

where Response: Send + 'static,

Await the given tokio task, handling if it is aborted.

async fn perform_uiaa<Response, Fut, FN>( &self, uiaa_info: UiaaInfo, parent: &Widget, callback: FN, ) -> Result<Response, AuthError>

where Response: Send + 'static, Fut: Future<Output = Result<Response, Error>> + Send + 'static, FN: Fn(AuthData) -> Fut + Send + Sync + 'static + Clone,

Perform UIAA for the given callback, starting with the given UIAA info.

async fn perform_next_stage( &self, uiaa_info: &UiaaInfo, parent: &Widget, ) -> Result<AuthData, AuthError>

Perform the preferred next stage in the given UIAA info.

Stages that are actually supported are preferred. If no stages are supported, we use the web-based fallback.

When this function returns, the next stage is ready to be performed.

fn retry_current_stage(&self, stage: &AuthType, uiaa_info: &UiaaInfo)

fn show_page(&self, page: Widget, default_widget: &Widget, parent: &Widget)

Show the given page.

async fn page(&self, state: &AuthState) -> Result<(Widget, Widget), AuthError>

Get the page for the given state.

Returns a (page, default_widget) tuple.

async fn fallback_url(&self, state: &AuthState) -> Result<String, AuthError>

Get the fallback URL for the given state.

fn current_stage_auth_data(&self) -> Result<AuthData, AuthError>

Get the authentication data for the current stage.

fn close(&self)

Trait Implementations

impl AdwDialogImpl for AuthDialog

fn close_attempt(&self)

fn closed(&self)

impl CompositeTemplate for AuthDialog

fn bind_template(klass: &mut Self::Class)

fn check_template_children(widget: &<Self as ObjectSubclass>::Type)

impl Debug for AuthDialog

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

Formats the value using the given formatter.

impl Default for AuthDialog

fn default() -> AuthDialog

Returns the “default value” for a type.

impl DerivedObjectProperties for AuthDialog

fn derived_properties() -> &'static [ParamSpec]

Properties installed for this type.

fn derived_property(&self, id: usize, pspec: &ParamSpec) -> Value

Similar to ObjectImpl but auto-generated by the Properties macro to allow handling more complex use-cases.

fn derived_set_property(&self, id: usize, value: &Value, pspec: &ParamSpec)

Similar to ObjectImpl but auto-generated by the Properties macro to allow handling more complex use-cases.

impl ObjectImpl for AuthDialog

fn dispose(&self)

Disposes of the object.

fn properties() -> &'static [ParamSpec]

Properties installed for this type.

fn set_property(&self, id: usize, value: &Value, pspec: &ParamSpec)

Property setter.

fn property(&self, id: usize, pspec: &ParamSpec) -> Value

Property getter.

fn signals() -> &'static [Signal]

Signals installed for this type.

fn constructed(&self)

Constructed.

fn notify(&self, pspec: &ParamSpec)

Function to be called when property change is notified for with self.notify("property").

fn dispatch_properties_changed(&self, pspecs: &[ParamSpec])

impl ObjectSubclass for AuthDialog

const NAME: &'static str = "AuthDialog"

GObject type name.

type Interfaces = ()

List of interfaces implemented by this type.

type Class = ClassStruct<AuthDialog>

The C class struct.

type Instance = InstanceStruct<AuthDialog>

The C instance struct.

type Type = AuthDialog

Wrapper around this subclass defined with wrapper!

type ParentType = ToastableDialog

Parent Rust type to inherit from.

fn new() -> Self

Constructor.

fn class_init(klass: &mut Self::Class)

Class initialization.

fn instance_init(obj: &InitializingObject<Self>)

Performs additional instance initialization.

const ABSTRACT: bool = false

If this subclass is an abstract class or not.

const ALLOW_NAME_CONFLICT: bool = false

Allow name conflicts for this class.

fn type_init(_type_: &mut InitializingType<Self>)

Additional type initialization.

fn with_class(_klass: &Self::Class) -> Self

Constructor.

impl ObjectSubclassType for AuthDialog

fn type_data() -> NonNull<TypeData>

Storage for the type-specific data used during registration.

fn type_() -> Type

Returns the glib::Type ID of the subclass.

impl WidgetImpl for AuthDialog

fn compute_expand(&self, hexpand: &mut bool, vexpand: &mut bool)

fn contains(&self, x: f64, y: f64) -> bool

fn direction_changed(&self, previous_direction: TextDirection)

fn focus(&self, direction_type: DirectionType) -> bool

fn request_mode(&self) -> SizeRequestMode

fn grab_focus(&self) -> bool

fn hide(&self)

👎Deprecated:

Since 4.10

fn keynav_failed(&self, direction_type: DirectionType) -> bool

fn map(&self)

fn measure( &self, orientation: Orientation, for_size: i32, ) -> (i32, i32, i32, i32)

fn mnemonic_activate(&self, group_cycling: bool) -> bool

fn move_focus(&self, direction_type: DirectionType)

fn query_tooltip( &self, x: i32, y: i32, keyboard_tooltip: bool, tooltip: &Tooltip, ) -> bool

fn realize(&self)

fn root(&self)

fn set_focus_child(&self, child: Option<&Widget>)

fn show(&self)

👎Deprecated:

Since 4.10

fn size_allocate(&self, width: i32, height: i32, baseline: i32)

fn snapshot(&self, snapshot: &Snapshot)

fn state_flags_changed(&self, state_flags: &StateFlags)

fn system_setting_changed(&self, settings: &SystemSetting)

fn unmap(&self)

fn unrealize(&self)

fn unroot(&self)

impl ToastableDialogImpl for AuthDialog