Struct webkit6::AuthenticationRequest

pub struct AuthenticationRequest { /* private fields */ }

Represents an authentication request.

Whenever a client attempts to load a page protected by HTTP authentication, credentials will need to be provided to authorize access. To allow the client to decide how it wishes to handle authentication, WebKit will fire a #WebKitWebView::authenticate signal with a WebKitAuthenticationRequest object to provide client side authentication support. Credentials are exposed through the #WebKitCredential object.

In case the client application does not wish to handle this signal WebKit will provide a default handler. To handle authentication asynchronously, simply increase the reference count of the WebKitAuthenticationRequest object.

Signals

authenticated

This signal is emitted when the user authentication request succeeded. Applications handling their own credential storage should connect to this signal to save the credentials.

cancelled

This signal is emitted when the user authentication request is cancelled. It allows the application to dismiss its authentication dialog in case of page load failure for example.

GLib type: GObject with reference counted clone semantics.

Implementations

impl AuthenticationRequest

pub fn authenticate(&self, credential: Option<&Credential>)

Authenticate the #WebKitAuthenticationRequest.

Authenticate the #WebKitAuthenticationRequest using the #WebKitCredential supplied. To continue without credentials, pass None as @credential.

credential

A #WebKitCredential, or None

pub fn can_save_credentials(&self) -> bool

Determine whether this #WebKitAuthenticationRequest should allow the storage of credentials.

Determine whether the authentication method associated with this #WebKitAuthenticationRequest should allow the storage of credentials. This will return false if WebKit doesn’t support credential storing, if private browsing is enabled, or if persistent credential storage has been disabled in #WebKitWebsiteDataManager, unless credentials saving has been explicitly enabled with webkit_authentication_request_set_can_save_credentials().

Returns

true if WebKit can store credentials or false otherwise.

pub fn cancel(&self)

Cancel the authentication challenge.

This will also cancel the page loading and result in a #WebKitWebView::load-failed signal with a #WebKitNetworkError of type NetworkError::Cancelled being emitted.

pub fn certificate_pin_flags(&self) -> TlsPasswordFlags

Get the #GTlsPasswordFlags of the AuthenticationScheme::ClientCertificatePinRequested authentication challenge.

Returns

a #GTlsPasswordFlags

pub fn host(&self) -> Option<GString>

Get the host that this authentication challenge is applicable to.

Returns

The host of @self.

pub fn port(&self) -> u32

Get the port that this authentication challenge is applicable to.

Returns

The port of @self.

pub fn proposed_credential(&self) -> Option<Credential>

Get the #WebKitCredential of the proposed authentication challenge.

Get the #WebKitCredential of the proposed authentication challenge that was stored from a previous session. The client can use this directly for authentication or construct their own #WebKitCredential.

Returns

A #WebKitCredential encapsulating credential details or None if there is no stored credential.

pub fn realm(&self) -> Option<GString>

Get the realm that this authentication challenge is applicable to.

Returns

The realm of @self.

pub fn scheme(&self) -> AuthenticationScheme

Get the authentication scheme of the authentication challenge.

Returns

The #WebKitAuthenticationScheme of @self.

pub fn security_origin(&self) -> Option<SecurityOrigin>

Get the #WebKitSecurityOrigin that this authentication challenge is applicable to.

Returns

a newly created #WebKitSecurityOrigin.

pub fn is_for_proxy(&self) -> bool

Determine whether the authentication challenge is associated with a proxy server.

Determine whether the authentication challenge is associated with a proxy server rather than an “origin” server.

Returns

true if authentication is for a proxy or false otherwise.

pub fn is_retry(&self) -> bool

Determine whether this this is a first attempt or a retry for this authentication challenge.

Returns

true if authentication attempt is a retry or false otherwise.

pub fn set_can_save_credentials(&self, enabled: bool)

Set whether the authentication method associated with @self should allow the storage of credentials.

Set whether the authentication method associated with @self should allow the storage of credentials. This should be used by applications handling their own credentials storage to indicate that it should be supported even when internal credential storage is disabled or unsupported. Note that storing of credentials will not be allowed on ephemeral sessions in any case.

enabled

value to set

pub fn set_proposed_credential(&self, credential: &mut Credential)

Set the #WebKitCredential of the proposed authentication challenge.

Set the #WebKitCredential of the proposed authentication challenge that was stored from a previous session. This should only be used by applications handling their own credential storage. (When using the default WebKit credential storage, webkit_authentication_request_get_proposed_credential() already contains previously-stored credentials.) Passing a None @credential will clear the proposed credential.

credential

a #WebKitCredential, or None

pub fn connect_authenticated<F: Fn(&Self, &Credential) + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted when the user authentication request succeeded. Applications handling their own credential storage should connect to this signal to save the credentials.

credential

the #WebKitCredential accepted

pub fn connect_cancelled<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

This signal is emitted when the user authentication request is cancelled. It allows the application to dismiss its authentication dialog in case of page load failure for example.

Trait Implementations

impl Clone for AuthenticationRequest

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for AuthenticationRequest

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

Formats the value using the given formatter.

impl HasParamSpec for AuthenticationRequest

type ParamSpec = ParamSpecObject

type SetValue = AuthenticationRequest

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, AuthenticationRequest>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for AuthenticationRequest

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

where H: Hasher,

Hashes the memory address of this object.

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 Ord for AuthenticationRequest

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 ParentClassIs for AuthenticationRequest

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for AuthenticationRequest

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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<OT: ObjectType> PartialOrd<OT> for AuthenticationRequest

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 StaticType for AuthenticationRequest

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AuthenticationRequest