Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.WebKit2.Structs.Credential

Contents

Exported types
Methods

Description

Groups information used for user authentication.

Since: 2.2

Synopsis

newtype Credential = Credential (ManagedPtr Credential)
credentialCopy :: (HasCallStack, MonadIO m) => Credential -> m Credential
credentialFree :: (HasCallStack, MonadIO m) => Credential -> m ()
credentialGetCertificate :: (HasCallStack, MonadIO m) => Credential -> m TlsCertificate
credentialGetPassword :: (HasCallStack, MonadIO m) => Credential -> m Text
credentialGetPersistence :: (HasCallStack, MonadIO m) => Credential -> m CredentialPersistence
credentialGetUsername :: (HasCallStack, MonadIO m) => Credential -> m Text
credentialHasPassword :: (HasCallStack, MonadIO m) => Credential -> m Bool
credentialNew :: (HasCallStack, MonadIO m) => Text -> Text -> CredentialPersistence -> m Credential
credentialNewForCertificate :: (HasCallStack, MonadIO m, IsTlsCertificate a) => Maybe a -> CredentialPersistence -> m Credential
credentialNewForCertificatePin :: (HasCallStack, MonadIO m) => Text -> CredentialPersistence -> m Credential

Exported types

newtype Credential Source #

Memory-managed wrapper type.

Constructors

Credential (ManagedPtr Credential)

Instances

Instances details

Eq Credential Source #
Instance details Defined in GI.WebKit2.Structs.Credential Methods (==) :: Credential -> Credential -> Bool # (/=) :: Credential -> Credential -> Bool #
GBoxed Credential Source #
Instance details Defined in GI.WebKit2.Structs.Credential
ManagedPtrNewtype Credential Source #
Instance details Defined in GI.WebKit2.Structs.Credential Methods toManagedPtr :: Credential -> ManagedPtr Credential
TypedObject Credential Source #
Instance details Defined in GI.WebKit2.Structs.Credential Methods glibType :: IO GType
HasParentTypes Credential Source #
Instance details Defined in GI.WebKit2.Structs.Credential
IsGValue (Maybe Credential) Source #	Convert `Credential` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.WebKit2.Structs.Credential Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Credential -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Credential)
type ParentTypes Credential Source #
Instance details Defined in GI.WebKit2.Structs.Credential type ParentTypes Credential = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

copy, free, hasPassword.

Getters

getCertificate, getPassword, getPersistence, getUsername.

Setters

None.

copy

credentialCopy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Credential	`credential`: a `Credential`
-> m Credential	Returns: A copy of passed in `Credential`

Make a copy of the Credential.

Since: 2.2

free

credentialFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Credential	`credential`: A `Credential`
-> m ()

Free the Credential.

Since: 2.2

getCertificate

credentialGetCertificate Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Credential	`credential`: a `Credential`
-> m TlsCertificate	Returns: a `TlsCertificate`, or `Nothing`

Get the certificate currently held by this Credential.

Since: 2.34

getPassword

credentialGetPassword Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Credential	`credential`: a `Credential`
-> m Text	Returns: The password stored in the `Credential`.

Get the password currently held by this Credential.

Since: 2.2

getPersistence

credentialGetPersistence Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Credential	`credential`: a `Credential`
-> m CredentialPersistence	Returns: The `CredentialPersistence` stored in the `Credential`.

Get the persistence mode currently held by this Credential.

Since: 2.2

getUsername

credentialGetUsername Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Credential	`credential`: a `Credential`
-> m Text	Returns: The username stored in the `Credential`.

Get the username currently held by this Credential.

Since: 2.2

hasPassword

credentialHasPassword Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Credential	`credential`: a `Credential`
-> m Bool	Returns: `True` if the credential has a password or `False` otherwise.

Determine whether this credential has a password stored.

Since: 2.2

new

credentialNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`username`: The username for the new credential
-> Text	`password`: The password for the new credential
-> CredentialPersistence	`persistence`: The `CredentialPersistence` of the new credential
-> m Credential	Returns: A `Credential`.

Create a new credential from the provided username, password and persistence mode.

Since: 2.2

newForCertificate

credentialNewForCertificate Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsCertificate a)
=> Maybe a	`certificate`: The `TlsCertificate`, or `Nothing`
-> CredentialPersistence	`persistence`: The `CredentialPersistence` of the new credential
-> m Credential	Returns: A `Credential`.

Create a new credential from the certificate and persistence mode.

Note that CredentialPersistencePermanent is not supported for certificate credentials.

Since: 2.34

newForCertificatePin

credentialNewForCertificatePin Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`pin`: The PIN for the new credential
-> CredentialPersistence	`persistence`: The `CredentialPersistence` of the new credential
-> m Credential	Returns: A `Credential`.

Create a new credential from the provided PIN and persistence mode.

Note that CredentialPersistencePermanent is not supported for certificate pin credentials.

Since: 2.34