EDataServer.SourceAuthentication
Description: Reference for EDataServer.SourceAuthentication

### Class

# EDataServerSourceAuthentication

since: 3.6

#### Description [src]

    class EDataServer.SourceAuthentication : EDataServer.SourceExtension
    {
      /* No available fields */
    }

Contains only private data that should be read and manipulated using the functions below.

Available since: 3.6

#### Hierarchy

#### Ancestors

- ESourceExtension
- GObject

#### Instance methods

###### e_source_authentication_dup_credential_name

Thread-safe variation of e_source_authentication_get_credential_name(). Use this function when accessing `extension` from multiple threads.

since: 3.16

###### e_source_authentication_dup_host

Thread-safe variation of e_source_authentication_get_host(). Use this function when accessing `extension` from multiple threads.

since: 3.6

###### e_source_authentication_dup_method

Thread-safe variation of e_source_authentication_get_method(). Use this function when accessing `extension` from multiple threads.

since: 3.6

###### e_source_authentication_dup_proxy_uid

Thread-safe variation of e_source_authentication_get_proxy_uid(). Use this function when accessing `extension` from multiple threads.

since: 3.12

###### e_source_authentication_dup_user

Thread-safe variation of e_source_authentication_get_user(). Use this function when accessing `extension` from multiple threads.

since: 3.6

###### e_source_authentication_get_credential_name

Returns the credential name used to pass the stored or gathered credential (like password) into the e_source_invoke_authenticate(). This is a counterpart of the authentication method. The `NULL` means to use the default name, which is #E_SOURCE_CREDENTIAL_PASSWORD.

since: 3.16

###### e_source_authentication_get_host

Returns the host name used to authenticate to a remote account.

since: 3.6

###### e_source_authentication_get_is_external

Get if the authentication is done by an external application such as a Single Sign On application (e.g. GNOME Online Accounts).

since: 3.36

###### e_source_authentication_get_method

Returns the authentication method for a remote account. There are no pre-defined method names; backends are free to set this however they wish. If authentication is not required for a remote account, the convention is to set `ESourceAuthentication:method` to “none”.

since: 3.6

###### e_source_authentication_get_port

Returns the port number used to authenticate to a remote account.

since: 3.6

###### e_source_authentication_get_proxy_uid

Returns the `ESource:uid` of the `ESource` that holds network proxy settings for use when connecting to a remote account.

since: 3.12

###### e_source_authentication_get_remember_password

Returns whether to offer to remember the provided password by default in password prompts. This way, if the user unchecks the option it will be unchecked by default in future password prompts.

since: 3.10

###### e_source_authentication_get_user

Returns the user name used to authenticate to a remote account.

since: 3.6

###### e_source_authentication_ref_connectable

Returns a `GSocketConnectable` instance constructed from `extension`‘s `ESourceAuthentication:host` and `ESourceAuthentication:port` properties, or `NULL` if the `ESourceAuthentication:host` is not set.

since: 3.8

###### e_source_authentication_required

This is a convenience function which returns whether authentication is required at all, regardless of the method used. This relies on the convention of setting `ESourceAuthentication:method` to “none” when authentication is not required.

since: 3.6

###### e_source_authentication_set_credential_name

Sets the credential name used to pass the stored or gathered credential (like password) into the e_source_invoke_authenticate(). This is a counterpart of the authentication method. The `NULL` means to use the default name, which is #E_SOURCE_CREDENTIAL_PASSWORD.

since: 3.16

###### e_source_authentication_set_host

Sets the host name used to authenticate to a remote account.

since: 3.6

###### e_source_authentication_set_is_external

Set if the authentication is done by an external application such as a Single Sign On application (e.g. GNOME Online Accounts).

since: 3.36

###### e_source_authentication_set_method

Sets the authentication method for a remote account. There are no pre-defined method names; backends are free to set this however they wish. If authentication is not required for a remote account, the convention is to set the method to “none”. In keeping with that convention, `ESourceAuthentication:method` will be set to “none” if `method` is `NULL` or an empty string.

since: 3.6

###### e_source_authentication_set_port

Sets the port number used to authenticate to a remote account.

since: 3.6

###### e_source_authentication_set_proxy_uid

Sets the `ESource:uid` of the `ESource` that holds network proxy settings for use when connecting to a remote account.

since: 3.12

###### e_source_authentication_set_remember_password

Sets whether to offer to remember the provided password by default in password prompts. This way, if the user unchecks the option it will be unchecked by default in future password prompts.

since: 3.10

###### e_source_authentication_set_user

Sets the user name used to authenticate to a remote account.

since: 3.6

##### Methods inherited from ESourceExtension (4)

###### e_source_extension_get_source

Returns the `ESource` instance to which `extension` belongs.

deprecated: 3.8 since: 3.6

###### e_source_extension_property_lock

Acquires a property lock, thus no other thread can change properties of the `extension` until the lock is released.

since: 3.18

###### e_source_extension_property_unlock

Releases a property lock, previously acquired with e_source_extension_property_lock(), thus other threads can change properties of the `extension`.

since: 3.18

###### e_source_extension_ref_source

Returns the `ESource` instance to which the `extension` belongs.

since: 3.8

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

#### Properties

###### EDataServer.SourceAuthentication:connectable

A `GSocketConnectable` constructed from the host and port properties.

###### EDataServer.SourceAuthentication:credential-name

What name to use for the authentication method in credentials for authentication.

###### EDataServer.SourceAuthentication:host

Host name for the remote account.

###### EDataServer.SourceAuthentication:is-external

Whether the authentication is done by another authentication manager (like any Single Sign On daemon).

###### EDataServer.SourceAuthentication:method

Authentication method.

###### EDataServer.SourceAuthentication:port

Port number for the remote account.

###### EDataServer.SourceAuthentication:proxy-uid

ESource UID of a proxy profile.

###### EDataServer.SourceAuthentication:remember-password

Whether to offer to remember the password by default when prompted.

###### EDataServer.SourceAuthentication:user

User name for the remote account.

##### Properties inherited from ESourceExtension (1)

###### EDataServer.SourceExtension:source

The `ESource` being extended.

#### Signals

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct EDataServerSourceAuthenticationClass {
      ESourceExtensionClass parent_class;

    }

No description available.

###### Class members

`parent_class: ESourceExtensionClass`

  No description available.