![]() |
![]() |
![]() |
libsyncdaemon Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Signals |
SyncdaemonDaemon; SyncdaemonDaemonClass; gboolean syncdaemon_daemon_connect (SyncdaemonDaemon *daemon
); void syncdaemon_daemon_create_folder (SyncdaemonDaemon *daemon
,const gchar *path
); void syncdaemon_daemon_create_share (SyncdaemonDaemon *daemon
,const gchar *path
,GSList *usernames
,const gchar *name
,gboolean allow_modifications
); void syncdaemon_daemon_delete_folder (SyncdaemonDaemon *daemon
,const gchar *path
); void syncdaemon_daemon_delete_share (SyncdaemonDaemon *daemon
,const gchar *path
); gboolean syncdaemon_daemon_disconnect (SyncdaemonDaemon *daemon
); SyncdaemonAuthentication * syncdaemon_daemon_get_authentication (SyncdaemonDaemon *daemon
); gboolean syncdaemon_daemon_get_bandwidth_throttling (SyncdaemonDaemon *daemon
); SyncdaemonInterface * syncdaemon_daemon_get_config_interface (SyncdaemonDaemon *daemon
); GSList * syncdaemon_daemon_get_current_downloads (SyncdaemonDaemon *daemon
); SyncdaemonStatusInfo * syncdaemon_daemon_get_current_status (SyncdaemonDaemon *daemon
); GSList * syncdaemon_daemon_get_current_uploads (SyncdaemonDaemon *daemon
); SyncdaemonInterface * syncdaemon_daemon_get_events_interface (SyncdaemonDaemon *daemon
); gboolean syncdaemon_daemon_get_files_sync (SyncdaemonDaemon *daemon
); SyncdaemonInterface * syncdaemon_daemon_get_filesystem_interface (SyncdaemonDaemon *daemon
); SyncdaemonFolderInfo * syncdaemon_daemon_get_folder_info (SyncdaemonDaemon *daemon
,const gchar *path
); GSList * syncdaemon_daemon_get_folders (SyncdaemonDaemon *daemon
); SyncdaemonInterface * syncdaemon_daemon_get_folders_interface (SyncdaemonDaemon *daemon
); SyncdaemonMetadata * syncdaemon_daemon_get_metadata (SyncdaemonDaemon *daemon
,const gchar *path
,gboolean with_subtree_sync_check
); GSList * syncdaemon_daemon_get_public_files (SyncdaemonDaemon *daemon
); SyncdaemonInterface * syncdaemon_daemon_get_publicfiles_interface (SyncdaemonDaemon *daemon
); const gchar * syncdaemon_daemon_get_root_dir (SyncdaemonDaemon *daemon
); GSList * syncdaemon_daemon_get_shared_folders (SyncdaemonDaemon *daemon
); GSList * syncdaemon_daemon_get_shares (SyncdaemonDaemon *daemon
); SyncdaemonInterface * syncdaemon_daemon_get_shares_interface (SyncdaemonDaemon *daemon
); SyncdaemonInterface * syncdaemon_daemon_get_status_interface (SyncdaemonDaemon *daemon
); void syncdaemon_daemon_get_throttling_limits (SyncdaemonDaemon *daemon
,gint *download
,gint *upload
); gboolean syncdaemon_daemon_get_udf_autosubscribe (SyncdaemonDaemon *daemon
); gboolean syncdaemon_daemon_has_network (SyncdaemonDaemon *daemon
); gboolean syncdaemon_daemon_is_folder_enabled (SyncdaemonDaemon *daemon
,const gchar *path
,gboolean *is_root
); gboolean syncdaemon_daemon_is_ready (SyncdaemonDaemon *daemon
); SyncdaemonDaemon * syncdaemon_daemon_new (void
); gboolean syncdaemon_daemon_publish_file (SyncdaemonDaemon *daemon
,const gchar *path
); gboolean syncdaemon_daemon_quit (SyncdaemonDaemon *daemon
); void syncdaemon_daemon_set_bandwidth_throttling (SyncdaemonDaemon *daemon
,gboolean enabled
); void syncdaemon_daemon_set_files_sync (SyncdaemonDaemon *daemon
,gboolean enabled
); void syncdaemon_daemon_set_throttling_limits (SyncdaemonDaemon *daemon
,gint download
,gint upload
); void syncdaemon_daemon_set_udf_autosubscribe (SyncdaemonDaemon *daemon
,gboolean enabled
); void syncdaemon_daemon_subscribe_folder (SyncdaemonDaemon *daemon
,const gchar *path
); gboolean syncdaemon_daemon_unpublish_file (SyncdaemonDaemon *daemon
,const gchar *path
); void syncdaemon_daemon_unsubscribe_folder (SyncdaemonDaemon *daemon
,const gchar *path
);
"connected" :Run Last
"disconnected" :Run Last
"download-file-progress" :Run Last
"download-finished" :Run Last
"download-started" :Run Last
"error" :Run Last
"event" :Run Last
"file-published" :Run Last
"file-unpublished" :Run Last
"folder-created" :Run Last
"folder-deleted" :Run Last
"folder-subscribed" :Run Last
"folder-unsubscribed" :Run Last
"quota-exceeded" :Run Last
"ready" :Run Last
"share-created" :Run Last
"share-deleted" :Run Last
"status-changed" :Run Last
"upload-file-progress" :Run Last
"upload-finished" :Run Last
"upload-started" :Run Last
typedef struct { GObjectClass parent_class; /* Signals */ void (* ready) (SyncdaemonDaemon *daemon); void (* connected) (SyncdaemonDaemon *daemon); void (* disconnected) (SyncdaemonDaemon *daemon); void (* status_changed) (SyncdaemonDaemon *daemon, SyncdaemonStatusInfo *status_info); void (* event) (SyncdaemonDaemon *daemon, GHashTable *event_dict); void (* error) (SyncdaemonDaemon *daemon, const gchar *signal, GHashTable *extra_args); void (* folder_created) (SyncdaemonDaemon *daemon, gboolean success, SyncdaemonFolderInfo *folder_info); void (* folder_deleted) (SyncdaemonDaemon *daemon, gboolean success, SyncdaemonFolderInfo *folder_info); void (* folder_subscribed) (SyncdaemonDaemon *daemon, gboolean success, SyncdaemonFolderInfo *folder_info); void (* folder_unsubscribed) (SyncdaemonDaemon *daemon, gboolean success, SyncdaemonFolderInfo *folder_info); void (* file_published) (SyncdaemonDaemon *daemon, gboolean success, SyncdaemonFileInfo *file_info); void (* file_unpublished) (SyncdaemonDaemon *daemon, gboolean success, SyncdaemonFileInfo *file_info); void (* share_created) (SyncdaemonDaemon *daemon, gboolean success, SyncdaemonShareInfo *share_info); void (* share_deleted) (SyncdaemonDaemon *daemon, gboolean success, SyncdaemonShareInfo *share_info); void (* download_started) (SyncdaemonDaemon *daemon, const gchar *path); void (* download_file_progress) (SyncdaemonDaemon *daemon, const gchar *path, SyncdaemonTransferInfo *tinfo); void (* download_finished) (SyncdaemonDaemon *daemon, const gchar *path, SyncdaemonTransferInfo *tinfo); void (* upload_started) (SyncdaemonDaemon *daemon, const gchar *path); void (* upload_file_progress) (SyncdaemonDaemon *daemon, const gchar *path, SyncdaemonTransferInfo *tinfo); void (* upload_finished) (SyncdaemonDaemon *daemon, const gchar *path, SyncdaemonTransferInfo *tinfo); void (* quota_exceeded) (SyncdaemonDaemon *daemon, GHashTable *volume_info); } SyncdaemonDaemonClass;
void syncdaemon_daemon_create_folder (SyncdaemonDaemon *daemon
,const gchar *path
);
Enable a folder for Ubuntu One synchronization.
The result of the operation can be retrieved by connecting to the "folder_created" signal of the SyncdaemonDaemon object.
|
A SyncdaemonDaemon object |
|
The full path of the folder to create |
void syncdaemon_daemon_create_share (SyncdaemonDaemon *daemon
,const gchar *path
,GSList *usernames
,const gchar *name
,gboolean allow_modifications
);
Share a Ubuntu One folder with a list of users.
The result of the operation can be retrieved by connecting to the "share_created" signal of the SyncdaemonDaemon object.
|
A SyncdaemonDaemon object |
|
Full path of the folder to be shared |
|
List of users with whom to share the folder |
|
Name to be used for the share |
|
Whether to allow modifications to the list of users |
void syncdaemon_daemon_delete_folder (SyncdaemonDaemon *daemon
,const gchar *path
);
Disable a folder for Ubuntu One synchronization.
The result of the operation can be retrieved by connecting to the "folder_deleted" signal of the SyncdaemonDaemon object.
|
A SyncdaemonDaemon object |
|
The full path of the folder to delete |
void syncdaemon_daemon_delete_share (SyncdaemonDaemon *daemon
,const gchar *path
);
Stop sharing a Ubuntu One folder.
The result of the operation can be retrieved by connecting to the "share_deleted" signal of the SyncdaemonDaemon object.
|
A SyncdaemonDaemon object |
|
Full path of the folder to be shared |
SyncdaemonAuthentication * syncdaemon_daemon_get_authentication
(SyncdaemonDaemon *daemon
);
gboolean syncdaemon_daemon_get_bandwidth_throttling
(SyncdaemonDaemon *daemon
);
Get whether bandwidth throttling is enabled or not.
|
A SyncdaemonDaemon object |
Returns : |
TRUE if enabled, FALSE if disabled. |
SyncdaemonInterface * syncdaemon_daemon_get_config_interface
(SyncdaemonDaemon *daemon
);
GSList * syncdaemon_daemon_get_current_downloads
(SyncdaemonDaemon *daemon
);
Retrieve the list of downloads in progress.
|
A SyncdaemonDaemon object |
Returns : |
A GSList of SyncdaemonTransferInfo objects, each of which contains information about a file download in progress. The data in the list belongs to the library, so when no longer needed, the list should be freed by just calling g_slist_free. |
SyncdaemonStatusInfo * syncdaemon_daemon_get_current_status
(SyncdaemonDaemon *daemon
);
Retrieve the current status of SyncDaemon.
|
A SyncdaemonDaemon object |
Returns : |
A SyncdaemonStatusInfo object containing information about Syncdaemon's current status. When no longer needed, it should be freed by calling g_object_unref. |
GSList * syncdaemon_daemon_get_current_uploads
(SyncdaemonDaemon *daemon
);
Retrieve the list of uploads in progress.
|
A SyncdaemonDaemon object |
Returns : |
A GSList of SyncdaemonTransferInfo objects, each of which contains information about a file upload in progress. The data in the list belongs to the library, so when no longer needed, the list should be freed by just calling g_slist_free. |
SyncdaemonInterface * syncdaemon_daemon_get_events_interface
(SyncdaemonDaemon *daemon
);
gboolean syncdaemon_daemon_get_files_sync (SyncdaemonDaemon *daemon
);
Get whether file syncing is enabled or not.
|
A SyncdaemonDaemon object |
Returns : |
TRUE if enabled, FALSE if disabled. |
SyncdaemonInterface * syncdaemon_daemon_get_filesystem_interface
(SyncdaemonDaemon *daemon
);
SyncdaemonFolderInfo * syncdaemon_daemon_get_folder_info (SyncdaemonDaemon *daemon
,const gchar *path
);
Get information about a folder under Ubuntu One.
|
A SyncdaemonDaemon object |
|
Full path of the folder for which to retrieve information. |
Returns : |
A SyncdaemonFolderInfo object containing all the information for the node. When no longer needed, it should be freed by calling g_object_unref. |
GSList * syncdaemon_daemon_get_folders (SyncdaemonDaemon *daemon
);
Retrieve the list of folders setup for synchronization with Ubuntu One.
|
A SyncdaemonDaemon object |
Returns : |
A list of SyncdaemonFolderInfo containing all the folders being synchronized by the user. When no longer needed, the list should be freed by calling g_slist_free. |
SyncdaemonInterface * syncdaemon_daemon_get_folders_interface
(SyncdaemonDaemon *daemon
);
SyncdaemonMetadata * syncdaemon_daemon_get_metadata (SyncdaemonDaemon *daemon
,const gchar *path
,gboolean with_subtree_sync_check
);
Retrieve metadata for a file or folder inside a Ubuntu One directory.
|
A SyncdaemonDaemon object |
|
Path to check metadata for |
|
For folders, whether to check the status of all its children |
Returns : |
Metadata for the specified path. |
GSList * syncdaemon_daemon_get_public_files (SyncdaemonDaemon *daemon
);
Retrieve the list of public files.
|
A SyncdaemonDaemon object |
Returns : |
A GSList of SyncdaemonFileInfo objects, each of which describes a published file for the user. When no longer needed, this list should be freed by calling g_slist_free, but the data within the list should never be freed, as it belongs to the library. |
SyncdaemonInterface * syncdaemon_daemon_get_publicfiles_interface
(SyncdaemonDaemon *daemon
);
const gchar * syncdaemon_daemon_get_root_dir (SyncdaemonDaemon *daemon
);
GSList * syncdaemon_daemon_get_shared_folders
(SyncdaemonDaemon *daemon
);
Get the list of folders shared by the user with other users.
|
A SyncdaemonDaemon object |
Returns : |
A GSList of SyncdaemonShareInfo objects. When no longer needed, the list should be freed by calling g_slist_free. |
GSList * syncdaemon_daemon_get_shares (SyncdaemonDaemon *daemon
);
Get the list of folders shared by other users with the current user.
|
A SyncdaemonDaemon object |
Returns : |
A GSList of SyncdaemonShareInfo objects. When no longer needed, the list should be freed by calling g_slist_free. |
SyncdaemonInterface * syncdaemon_daemon_get_shares_interface
(SyncdaemonDaemon *daemon
);
SyncdaemonInterface * syncdaemon_daemon_get_status_interface
(SyncdaemonDaemon *daemon
);
void syncdaemon_daemon_get_throttling_limits (SyncdaemonDaemon *daemon
,gint *download
,gint *upload
);
Retrieve download and upload throttling limits.
|
A SyncdaemonDaemon object |
|
Placeholder for download limits |
|
Placeholder for upload limits |
gboolean syncdaemon_daemon_get_udf_autosubscribe
(SyncdaemonDaemon *daemon
);
Get whether autosubscription for UDFs is enabled or not.
|
A SyncdaemonDaemon object |
Returns : |
TRUE if enabled, FALSE if disabled. |
gboolean syncdaemon_daemon_is_folder_enabled (SyncdaemonDaemon *daemon
,const gchar *path
,gboolean *is_root
);
Check whether a given path is a folder enabled for synchronization to U1.
|
A SyncdaemonDaemon object |
|
The folder path to check |
|
Placeholder for returning whether the given path is a U1 root folder |
Returns : |
TRUE if the folder is enabled, FALSE otherwise. |
SyncdaemonDaemon * syncdaemon_daemon_new (void
);
Create a new SyncdaemonDaemon object, which provides access to the Syncdaemon daemon.
Returns : |
A new SyncdaemonDaemon object. |
gboolean syncdaemon_daemon_publish_file (SyncdaemonDaemon *daemon
,const gchar *path
);
Publish a file on Ubuntu One. When the file is successfully published, the "file_published" signal will be emitted.
|
A SyncdaemonDaemon object |
|
Full path of the file to be published |
Returns : |
TRUE if successful, FALSE otherwise. |
void syncdaemon_daemon_set_bandwidth_throttling (SyncdaemonDaemon *daemon
,gboolean enabled
);
Enable or disable bandwidth throttling.
|
A SyncdaemonDaemon object |
|
Whether to enable bandwidth throttling or not. |
void syncdaemon_daemon_set_files_sync (SyncdaemonDaemon *daemon
,gboolean enabled
);
Enable or disable file syncing.
|
A SyncdaemonDaemon object |
|
Whether to enable file syncing or not. |
void syncdaemon_daemon_set_throttling_limits (SyncdaemonDaemon *daemon
,gint download
,gint upload
);
Set download and upload throttling limits.
|
A SyncdaemonDaemon object |
|
Download limit |
|
Upload limit |
void syncdaemon_daemon_set_udf_autosubscribe (SyncdaemonDaemon *daemon
,gboolean enabled
);
Enable or disable UDF autosubscription.
|
A SyncdaemonDaemon object |
|
Whether to enable UDF autosubscription or not. |
void syncdaemon_daemon_subscribe_folder (SyncdaemonDaemon *daemon
,const gchar *path
);
Subscribe a folder for Ubuntu One synchronization.
The result of the operation can be retrieved by connecting to the "folder_subscribed" signal of the SyncdaemonDaemon object.
|
A SyncdaemonDaemon object |
|
The full path of the folder to subscribe |
gboolean syncdaemon_daemon_unpublish_file (SyncdaemonDaemon *daemon
,const gchar *path
);
Unpublish a file from Ubuntu One. When the file is successfully unpublished, the "file_unpublished" signal will be emitted.
|
A SyncdaemonDaemon object |
|
Full path of the file to be unpublished |
Returns : |
TRUE if successful, FALSE otherwise. |
void syncdaemon_daemon_unsubscribe_folder (SyncdaemonDaemon *daemon
,const gchar *path
);
Unsubscribe a folder from Ubuntu One synchronization.
The result of the operation can be retrieved by connecting to the "folder_unsubscribed" signal of the SyncdaemonDaemon object.
|
A SyncdaemonDaemon object |
|
The full path of the folder to unsubscribe |
"connected"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"disconnected"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"download-file-progress"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gchar *arg1,
GObject *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"download-finished"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gchar *arg1,
GObject *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"download-started"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gchar *arg1,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"error"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gchar *arg1,
gpointer arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"event"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gpointer arg1,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"file-published"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gboolean arg1,
GObject *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"file-unpublished"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gboolean arg1,
GObject *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"folder-created"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gboolean arg1,
GObject *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"folder-deleted"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gboolean arg1,
GObject *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"folder-subscribed"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gboolean arg1,
GObject *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"folder-unsubscribed"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gboolean arg1,
GObject *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"quota-exceeded"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gpointer arg1,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"ready"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"share-created"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gboolean arg1,
GObject *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"share-deleted"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gboolean arg1,
GObject *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"status-changed"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
GObject *arg1,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"upload-file-progress"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gchar *arg1,
GObject *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"upload-finished"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gchar *arg1,
GObject *arg2,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"upload-started"
signalvoid user_function (SyncdaemonDaemon *syncdaemondaemon,
gchar *arg1,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |