Source

---

Object Hierarchy:

Description:

Content:

Properties:

• public SourceConnectionStatus connection_status { get; }
• public string display_name { get; set construct; }
• public bool enabled { get; set construct; }
• public MainContext main_context { owned get; construct; }
• public string parent { get; set; }
• public bool remote_creatable { get; }
• public bool remote_deletable { get; }
• public bool removable { get; }
• public string uid { get; construct; }
• public bool writable { get; }

Static methods:

• public static string parameter_to_key (string param_name)
  Converts a ParamSpec name (e.g. "foo-bar" or "foo_bar") to "CamelCase" for use as a KeyFile key (e.g. "FooBar").

Creation methods:

• public Source (DBusObject? dbus_object, MainContext? main_context) throws Error
  Creates a new Source instance.
• public Source.with_uid (string uid, MainContext? main_context) throws Error
  Creates a new "scratch" Source with a predetermined unique identifier.

Methods:

• public void camel_configure_service (Service service)
  This function essentially glues together this and serivce so their configuration settings stay synchronized.
• public int compare_by_display_name (Source source2)
  Compares two Source instances by their display names.
• public async bool delete_password (Cancellable? cancellable) throws Error
  Asynchronously deletes the password for this from either the default keyring or session keyring.
• public bool delete_password_sync (Cancellable? cancellable = null) throws Error
  Deletes the password for this from either the default keyring or session keyring.
• public string dup_display_name ()
  Thread-safe variation of get_display_name.
• public string? dup_parent ()
  Thread-safe variation of get_parent.
• public string dup_secret_label ()
  Creates a label string based on this's display_name for use with SecretItem.
• public string dup_uid ()
  Thread-safe variation of get_uid.
• public void emit_credentials_required (SourceCredentialsReason reason, string certificate_pem, TlsCertificateFlags certificate_errors, Error? op_error)
  Emits locally (in this process only) the ESource::credentials-required signal with given parameters.
• public bool equal (Source source2)
  Checks two Source instances for equality.
• public SourceConnectionStatus get_connection_status ()
  Obtain current connection status of the this .
• public unowned string get_display_name ()
  Returns the display name for this.
• public bool get_enabled ()
  Returns true if this is enabled.
• public unowned SourceExtension get_extension (string extension_name)
  Returns an instance of some SourceExtension subclass which registered itself under extension_name.
• public async bool get_last_credentials_required_arguments (Cancellable? cancellable, out SourceCredentialsReason out_reason, out string out_certificate_pem, out TlsCertificateFlags out_certificate_errors, out Error out_op_error) throws Error
  Asynchronously calls the GetLastCredentialsRequiredArguments method on the server side, to get the last values used for the 'credentials-required' signal.
• public bool get_last_credentials_required_arguments_sync (out SourceCredentialsReason out_reason, out string out_certificate_pem, out TlsCertificateFlags out_certificate_errors, out Error out_op_error, Cancellable? cancellable = null) throws Error
  Retrieves the last used arguments of the 'credentials-required' signal emission.
• public virtual async bool get_oauth2_access_token (Cancellable? cancellable, out string out_access_token, out int out_expires_in) throws Error
  Asynchronously obtains the OAuth 2.0 access token for this along with its expiry in seconds from the current time (or 0 if unknown).
• public virtual bool get_oauth2_access_token_sync (Cancellable? cancellable, out string out_access_token, out int out_expires_in) throws Error
  Obtains the OAuth 2.0 access token for this along with its expiry in seconds from the current time (or 0 if unknown).
• public unowned string? get_parent ()
  Returns the unique identifier string of the parent Source.
• public bool get_remote_creatable ()
  Returns whether new resources can be created on a remote server by calling remote_create on this .
• public bool get_remote_deletable ()
  Returns whether the resource represented by this can be deleted from a remote server by calling remote_delete.
• public bool get_removable ()
  Returns whether the D-Bus service will allow this to be removed.
• public unowned string get_uid ()
  Returns the unique identifier string for this .
• public bool get_writable ()
  Returns whether the D-Bus service will accept changes to this.
• public bool has_extension (string extension_name)
  Checks whether this has an SourceExtension with the given name.
• public uint hash ()
  Generates a hash value for this.
• public async bool invoke_authenticate (NamedParameters? credentials, Cancellable? cancellable) throws Error
  Asynchronously calls the InvokeAuthenticate method on the server side, thus the backend knows what credentials to use to connect to its (possibly remote) data store.
• public virtual bool invoke_authenticate_impl (void* dbus_source, string arg_credentials, Cancellable? cancellable = null) throws Error
• public bool invoke_authenticate_sync (NamedParameters? credentials, Cancellable? cancellable = null) throws Error
  Calls the InvokeAuthenticate method on the server side, thus the backend knows what credentials to use to connect to its (possibly remote) data store.
• public async bool invoke_credentials_required (SourceCredentialsReason reason, string certificate_pem, TlsCertificateFlags certificate_errors, Error? op_error, Cancellable? cancellable) throws Error
  Asynchronously calls the InvokeCredentialsRequired method on the server side, to inform clients that credentials are required.
• public virtual bool invoke_credentials_required_impl (void* dbus_source, string arg_reason, string arg_certificate_pem, string arg_certificate_errors, string arg_dbus_error_name, string arg_dbus_error_message, Cancellable? cancellable = null) throws Error
• public bool invoke_credentials_required_sync (SourceCredentialsReason reason, string certificate_pem, TlsCertificateFlags certificate_errors, Error? op_error, Cancellable? cancellable = null) throws Error
  Let's the client-side know that credentials are required.
• public async bool lookup_password (Cancellable? cancellable, out string? out_password) throws Error
  Asynchronously looks up a password for this .
• public bool lookup_password_sync (Cancellable? cancellable, out string? out_password) throws Error
  Looks up a password for this.
• public async bool mail_signature_load (int io_priority, Cancellable? cancellable, out string contents, out size_t length) throws Error
  Asynchronously loads a signature from the signature file for this, which is given by get_file.
• public bool mail_signature_load_sync (out string contents, out size_t length, Cancellable? cancellable = null) throws Error
  Loads a signature from the signature file for this, which is given by get_file.
• public async bool mail_signature_replace (string contents, size_t length, int io_priority, Cancellable? cancellable) throws Error
  Asynchrously replaces the signature file for this with the given contents of length bytes.
• public bool mail_signature_replace_sync (string contents, size_t length, Cancellable? cancellable = null) throws Error
  Replaces the signature file for this with the given contents of length bytes.
• public async bool mail_signature_symlink (string symlink_target, int io_priority, Cancellable? cancellable) throws Error
  Asynchronously replaces the signature file for this with a symbolic link to symlink_target, which should be an executable file that prints a mail signature to standard output.
• public bool mail_signature_symlink_sync (string symlink_target, Cancellable? cancellable = null) throws Error
  Replaces the signature file for this with a symbolic link to symlink_target, which should be an executable file that prints a mail signature to standard output.
• public async string[]? proxy_lookup (string uri, Cancellable? cancellable) throws Error
  Asynchronously determines what proxy, if any, to use to connect to uri .
• public string[]? proxy_lookup_sync (string uri, Cancellable? cancellable = null) throws Error
  Looks into this's SourceProxy extension to determine what proxy, if any, to use to connect to uri.
• public DBusObject? ref_dbus_object ()
  Returns the DBusObject that was passed to Source.
• public MainContext ref_main_context ()
  Returns the MainContext on which event sources for this are to be attached.
• public uint refresh_add_timeout (MainContext? context, owned SourceRefreshFunc callback)
  This is a simple way to schedule a periodic data source refresh.
• public void refresh_force_timeout ()
  For all timeouts added with refresh_add_timeout, invokes the SourceRefreshFunc callback immediately and then, if the refresh enabled state is TRUE, reschedules the timeout.
• public bool refresh_remove_timeout (uint refresh_timeout_id)
  Removes a timeout SocketSource added by refresh_add_timeout.
• public uint refresh_remove_timeouts_by_data (void* user_data)
  Removes all timeout SocketSource's added by refresh_add_timeout whose callback data pointer matches user_data.
• public virtual async bool remote_create (Source scratch_source, Cancellable? cancellable) throws Error
  Asynchronously creates a new remote resource by picking out relevant details from scratch_source.
• public virtual bool remote_create_sync (Source scratch_source, Cancellable? cancellable = null) throws Error
  Creates a new remote resource by picking out relevant details from scratch_source.
• public virtual async bool remote_delete (Cancellable? cancellable) throws Error
  Asynchronously deletes the resource represented by this from a remote server.
• public virtual bool remote_delete_sync (Cancellable? cancellable = null) throws Error
  Deletes the resource represented by this from a remote server.
• public virtual async bool remove (Cancellable? cancellable) throws Error
  Asynchronously requests the D-Bus service to delete the key files for this and all of its descendants and broadcast their removal to all clients.
• public virtual bool remove_sync (Cancellable? cancellable = null) throws Error
  Requests the D-Bus service to delete the key files for this and all of its descendants and broadcast their removal to all clients.
• public void set_connection_status (SourceConnectionStatus connection_status)
  Set's current connection status of the this .
• public void set_display_name (string display_name)
  Sets the display name for this.
• public void set_enabled (bool enabled)
  Enables or disables this.
• public void set_parent (string? parent)
  Identifies the parent of this by its unique identifier string.
• public async bool store_password (string password, bool permanently, Cancellable? cancellable) throws Error
  Asynchronously stores a password for this.
• public bool store_password_sync (string password, bool permanently, Cancellable? cancellable = null) throws Error
  Stores a password for this.
• public string to_string (out size_t length)
  Outputs the current contents of this as a key file string.
• public async bool unset_last_credentials_required_arguments (Cancellable? cancellable) throws Error
  Asynchronously calls the UnsetLastCredentialsRequiredArguments method on the server side, to unset the last values used for the 'credentials-required' signal.
• public virtual bool unset_last_credentials_required_arguments_impl (Cancellable? cancellable = null) throws Error
• public bool unset_last_credentials_required_arguments_sync (Cancellable? cancellable = null) throws Error
  Unsets the last used arguments of the 'credentials-required' signal emission.
• public async bool webdav_discover_sources (string? url_use_path, uint32 only_supports, NamedParameters? credentials, Cancellable? cancellable, out string out_certificate_pem, out TlsCertificateFlags out_certificate_errors, out SList<WebDAVDiscoveredSource> out_discovered_sources, out SList<string> out_calendar_user_addresses) throws Error
  Asynchronously runs discovery of the WebDAV sources (CalDAV and CardDAV), eventually limited by the only_supports filter, which can be NONE to search all types.
• public async bool webdav_discover_sources_full (string? url_use_path, uint32 only_supports, NamedParameters? credentials, WebDAVDiscoverRefSourceFunc? ref_source_func, Cancellable? cancellable, out string out_certificate_pem, out TlsCertificateFlags out_certificate_errors, out SList<WebDAVDiscoveredSource> out_discovered_sources, out SList<string> out_calendar_user_addresses) throws Error
  This is the same as webdav_discover_sources, it only allows to provide a callback function (with its user_data), to reference an additional Source.
• public bool webdav_discover_sources_full_sync (string? url_use_path, uint32 only_supports, NamedParameters? credentials, WebDAVDiscoverRefSourceFunc? ref_source_func, out string out_certificate_pem, out TlsCertificateFlags out_certificate_errors, out SList<WebDAVDiscoveredSource> out_discovered_sources, out SList<string> out_calendar_user_addresses, Cancellable? cancellable = null) throws Error
  This is the same as webdav_discover_sources_sync, it only allows to provide a callback function (with its user_data), to reference an additional Source.
• public bool webdav_discover_sources_sync (string? url_use_path, uint32 only_supports, NamedParameters? credentials, out string out_certificate_pem, out TlsCertificateFlags out_certificate_errors, out SList<WebDAVDiscoveredSource> out_discovered_sources, out SList<string> out_calendar_user_addresses, Cancellable? cancellable = null) throws Error
  Synchronously runs discovery of the WebDAV sources (CalDAV and CardDAV), eventually limited by the only_supports filter, which can be NONE to search all types.
• public virtual async bool write (Cancellable? cancellable) throws Error
  Asynchronously submits the current contents of this to the D-Bus service to be written to disk and broadcast to other clients.
• public virtual bool write_sync (Cancellable? cancellable = null) throws Error
  Submits the current contents of this to the D-Bus service to be written to disk and broadcast to other clients.

Signals:

• public virtual signal void authenticate (NamedParameters credentials)
  Let's the backend know provided credentials to use to login to (possibly remote) data store.
• public virtual signal void changed ()
  The changed signal is emitted when a property in source or one of its extension objects changes.
• public virtual signal void credentials_required (SourceCredentialsReason reason, string certificate_pem, TlsCertificateFlags certificate_errors, Error op_error)
  The credentials_required signal is emitted when the source requires credentials to connect to (possibly remote) data store.

Inherited Members: