Top | ![]() |
![]() |
![]() |
![]() |
const |
e_server_side_source_get_user_dir () |
|
e_server_side_source_new_user_file () |
|
e_server_side_source_uid_from_file () |
ESource * | e_server_side_source_new () |
ESource * | e_server_side_source_new_memory_only () |
|
e_server_side_source_load () |
|
e_server_side_source_get_file () |
|
e_server_side_source_get_node () |
ESourceRegistryServer * | e_server_side_source_get_server () |
|
e_server_side_source_get_exported () |
const |
e_server_side_source_get_write_directory () |
|
e_server_side_source_set_write_directory () |
|
e_server_side_source_set_removable () |
|
e_server_side_source_set_writable () |
|
e_server_side_source_set_remote_creatable () |
|
e_server_side_source_set_remote_deletable () |
EOAuth2Support * | e_server_side_source_ref_oauth2_support () |
|
e_server_side_source_set_oauth2_support () |
An EServerSideSource is an ESource with some additional capabilities exclusive to the registry D-Bus service.
constgchar * e_server_side_source_get_user_dir (void
);
Returns the directory where user-specific data source files are stored.
Since: 3.6
GFile * e_server_side_source_new_user_file (const
);gchar *uid
Generates a unique file name for a new user-specific data source.
If uid
is non-NULL
e_uid_new()
.
The returned e_server_side_source_new()
.
Unreference the g_object_unref()
Note the data source file itself is not created here, only its name.
Since: 3.6
gchar * e_server_side_source_uid_from_file (,
GFile *file);
GError **error
Extracts a unique identity string from the base name of file
.
If the base name of file
is missing a '.source' extension, the
function sets error
and returns NULL
Since: 3.6
ESource * e_server_side_source_new (ESourceRegistryServer *server
,,
GFile *file);
GError **error
Creates a new EServerSideSource which belongs to server
. If file
is non-NULL
error
and returns NULL
Since: 3.6
ESource * e_server_side_source_new_memory_only (ESourceRegistryServer *server
,const
,gchar *uid);
GError **error
Creates a memory-only EServerSideSource which belongs to server
.
No on-disk key file is created for this data source, so it will not
be remembered across sessions.
Data source collections are often populated with memory-only data
sources to serve as proxies for resources discovered on a remote server.
These data sources are usually neither
If an error occurs while instantiating the EServerSideSource, the
function sets error
and returns NULL
Since: 3.6
gboolean e_server_side_source_load (EServerSideSource *source
,,
GCancellable *cancellable);
GError **error
Reloads data source content from the file pointed to by the
If the NULL
TRUE
If a read error occurs or the file contains syntax errors, the function
sets error
and returns FALSE
source |
||
cancellable |
optional |
|
error |
return location for a |
Since: 3.6
GFile * e_server_side_source_get_file (EServerSideSource *source
);
Returns the source
may not have a
Since: 3.6
GNode * e_server_side_source_get_node (EServerSideSource *source
);
Returns the source
's hierarchical placement,
or NULL
source
has not been placed in the data source hierarchy.
The data member of the source
. This is an easy
way to traverse ancestor and descendant data sources.
Note that accessing other data sources this way is not thread-safe, and this therefore function may be replaced at some later date.
Since: 3.6
ESourceRegistryServer *
e_server_side_source_get_server (EServerSideSource *source
);
Returns the ESourceRegistryServer to which source
belongs.
Since: 3.6
gboolean e_server_side_source_get_exported (EServerSideSource *source
);
Returns whether source
has been exported over D-Bus.
The function returns FALSE
source
is initially created, TRUE
source
to e_source_registry_add_source()
source
's FALSE
source
to e_source_registry_remove_source()
Since: 3.6
constgchar * e_server_side_source_get_write_directory (EServerSideSource *source
);
Returns the local directory path where changes to source
are written.
By default, changes are written to the local directory path returned by
e_server_side_source_get_user_dir()
, but an ECollectionBackend may wish
to override this to use its own private cache directory for data sources
it creates automatically.
Since: 3.6
void e_server_side_source_set_write_directory (EServerSideSource *source
,const
);gchar *write_directory
Sets the local directory path where changes to source
are to be written.
By default, changes are written to the local directory path returned by
e_server_side_source_get_user_dir()
, but an ECollectionBackend may wish
to override this to use its own private cache directory for data sources
it creates automatically.
Since: 3.6
void e_server_side_source_set_removable (EServerSideSource *source
,);
gboolean removable
Sets whether to allow registry clients to remove source
and its
descendants. If TRUE
source
. If FALSE
source
, and any attempt by clients
to call e_source_remove()
will fail.
Note this is only enforced for clients of the registry D-Bus service. The service itself may remove any data source at any time.
Since: 3.6
void e_server_side_source_set_writable (EServerSideSource *source
,);
gboolean writable
Sets whether to allow registry clients to alter the content of source
.
If TRUE
source
. If FALSE
source
, and any attempt by clients to call
e_source_write()
will fail.
Note this is only enforced for clients of the registry D-Bus service. The service itself can write to any data source at any time.
Since: 3.6
void e_server_side_source_set_remote_creatable (EServerSideSource *source
,);
gboolean remote_creatable
Indicates whether source
can be used to create resources on a remote
server. Typically this is only set to TRUE
If TRUE
source
. If FALSE
source
, and any attempt by clients
to call e_source_remote_create()
will fail.
Unlike the
Since: 3.6
void e_server_side_source_set_remote_deletable (EServerSideSource *source
,);
gboolean remote_deletable
Indicates whether source
can be used to delete resources on a remote
server. Typically this is only set to TRUE
If TRUE
source
. If FALSE
source
, and any attempt by clients
to call e_source_remote_delete()
will fail.
Unlike the
Since: 3.6
EOAuth2Support *
e_server_side_source_ref_oauth2_support
(EServerSideSource *source
);
Returns the object implementing the EOAuth2SupportInterface,
or NULL
source
does not support OAuth 2.0 authentication.
The returned EOAuth2Support object is referenced for thread-safety.
Unreference the object with g_object_unref()
Since: 3.8
void e_server_side_source_set_oauth2_support (EServerSideSource *source
,EOAuth2Support *oauth2_support
);
Indicates whether source
supports OAuth 2.0 authentication.
If oauth2_support
is non-NULL
source
. If oauth2_support
is NULL
source
, and any attempt by clients to call
e_source_get_oauth2_access_token()
will fail.
Requests for OAuth 2.0 access tokens are forwarded to oauth2_support
,
which implements the EOAuth2SupportInterface.
Since: 3.8
struct EServerSideSource { };
Contains only private data that should be read and manipulated using the functions below.
Since: 3.6