|  |  |  | Zapojit Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
#include <zpj/zpj.h> struct ZpjSkydrive; struct ZpjSkydriveClass; gboolean zpj_skydrive_create_folder (ZpjSkydrive *self,ZpjSkydriveFolder *folder,GCancellable *cancellable,GError **error); gboolean zpj_skydrive_create_folder_from_name (ZpjSkydrive *self,const gchar *name,const gchar *parent_id,GCancellable *cancellable,GError **error); gboolean zpj_skydrive_delete_entry_id (ZpjSkydrive *self,const gchar *entry_id,GCancellable *cancellable,GError **error); gboolean zpj_skydrive_download_file_id_to_path (ZpjSkydrive *self,const gchar *file_id,const gchar *path,GCancellable *cancellable,GError **error); GInputStream * zpj_skydrive_download_file_id_to_stream (ZpjSkydrive *self,const gchar *file_id,GCancellable *cancellable,GError **error); void zpj_skydrive_download_file_id_to_stream_async (ZpjSkydrive *self,const gchar *file_id,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); GInputStream * zpj_skydrive_download_file_id_to_stream_finish (ZpjSkydrive *self,GAsyncResult *res,GError **error); gboolean zpj_skydrive_download_file_to_path (ZpjSkydrive *self,ZpjSkydriveFile *file,const gchar *path,GCancellable *cancellable,GError **error); GInputStream * zpj_skydrive_download_file_to_stream (ZpjSkydrive *self,ZpjSkydriveFile *file,GCancellable *cancellable,GError **error); void zpj_skydrive_download_file_to_stream_async (ZpjSkydrive *self,ZpjSkydriveFile *file,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); GInputStream * zpj_skydrive_download_file_to_stream_finish (ZpjSkydrive *self,GAsyncResult *res,GError **error); ZpjAuthorizer * zpj_skydrive_get_authorizer (ZpjSkydrive *self); GList * zpj_skydrive_list_folder (ZpjSkydrive *self,ZpjSkydriveFolder *folder,GCancellable *cancellable,GError **error); GList * zpj_skydrive_list_folder_id (ZpjSkydrive *self,const gchar *folder_id,GCancellable *cancellable,GError **error); void zpj_skydrive_list_folder_id_async (ZpjSkydrive *self,const gchar *folder_id,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); GList * zpj_skydrive_list_folder_id_finish (ZpjSkydrive *self,GAsyncResult *res,GError **error); ZpjSkydrive * zpj_skydrive_new (ZpjAuthorizer *authorizer); ZpjSkydriveEntry * zpj_skydrive_query_info_from_id (ZpjSkydrive *self,const gchar *id,GCancellable *cancellable,GError **error); void zpj_skydrive_query_info_from_id_async (ZpjSkydrive *self,const gchar *id,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); ZpjSkydriveEntry * zpj_skydrive_query_info_from_id_finish (ZpjSkydrive *self,GAsyncResult *res,GError **error); void zpj_skydrive_set_authorizer (ZpjSkydrive *self,ZpjAuthorizer *authorizer); gboolean zpj_skydrive_upload_path_to_folder (ZpjSkydrive *self,const gchar *path,ZpjSkydriveFolder *folder,GCancellable *cancellable,GError **error); gboolean zpj_skydrive_upload_path_to_folder_id (ZpjSkydrive *self,const gchar *path,const gchar *folder_id,GCancellable *cancellable,GError **error);
ZpjSkydrive represents the Skydrive file hosting service. It has to be used with an implementation of ZpjAuthorizer.
Currently it supports the following operations:
Deleting a file, folder or photo.
Listing the contents of a folder.
Reading the properties of a file, folder or photo.
Uploading files and photos.
struct ZpjSkydrive;
The ZpjSkydrive structure contains only private data and should only be accessed using the provided API.
struct ZpjSkydriveClass {
  GObjectClass parent_class;
};
Class structure for ZpjSkydrive.
| GObjectClass  | The parent class. | 
gboolean zpj_skydrive_create_folder (ZpjSkydrive *self,ZpjSkydriveFolder *folder,GCancellable *cancellable,GError **error);
gboolean zpj_skydrive_create_folder_from_name (ZpjSkydrive *self,const gchar *name,const gchar *parent_id,GCancellable *cancellable,GError **error);
gboolean zpj_skydrive_delete_entry_id (ZpjSkydrive *self,const gchar *entry_id,GCancellable *cancellable,GError **error);
Synchronously deletes the entry corresponding to entry_id from
Skydrive.
| 
 | A ZpjSkydrive. | 
| 
 | The ID of the ZpjSkydriveEntry to be deleted. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | An optional GErrororNULL. [allow-none] | 
| Returns : | TRUEif the ZpjSkydriveEntry was deleted successfully. | 
gboolean zpj_skydrive_download_file_id_to_path (ZpjSkydrive *self,const gchar *file_id,const gchar *path,GCancellable *cancellable,GError **error);
Synchronously downloads the file corresponding to file_id from
Skydrive and saves it in path. The file is temporarily
saved in the preferred directory for temporary files (as returned
by g_get_tmp_dir()) while the download is going on, and then moved
to path.
| 
 | A ZpjSkydrive. | 
| 
 | The ID of the ZpjSkydriveFile to be downloaded. | 
| 
 | The destination. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | An optional GErrororNULL. [allow-none] | 
| Returns : | TRUEif the ZpjSkydriveFile was downloaded successfully. | 
GInputStream * zpj_skydrive_download_file_id_to_stream (ZpjSkydrive *self,const gchar *file_id,GCancellable *cancellable,GError **error);
Synchronously returns a stream for downloading the file
corresponding to file_id from
Skydrive. See
zpj_skydrive_download_file_id_to_stream_async() for the asynchronous
version of this call.
| 
 | A ZpjSkydrive. | 
| 
 | The ID of the ZpjSkydriveFile to be downloaded. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | An optional GErrororNULL. [allow-none] | 
| Returns : | A GInputStream to read the file data
from. Free the returned object with g_object_unref(). [transfer full] | 
void zpj_skydrive_download_file_id_to_stream_async (ZpjSkydrive *self,const gchar *file_id,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously returns a stream for downloading the file
corresponding to file_id from
Skydrive. See zpj_skydrive_download_file_id_to_stream() for
the synchronous version of this call.
When the operation is finished, callback will be called. You can
then call zpj_skydrive_download_file_id_to_stream_finish() to get
the result of the operation.
| 
 | A ZpjSkydrive. | 
| 
 | The ID of the ZpjSkydriveFile to be downloaded. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied. [scope async] | 
| 
 | The data to pass to callback. [closure] | 
GInputStream * zpj_skydrive_download_file_id_to_stream_finish (ZpjSkydrive *self,GAsyncResult *res,GError **error);
Finishes an asynchronous operation started with
zpj_skydrive_download_file_id_to_stream_async().
| 
 | A ZpjSkydrive. | 
| 
 | A GAsyncResult. | 
| 
 | An optional GError, or NULL. [allow-none] | 
| Returns : | A GInputStream to read the file data
from. Free the returned object with g_object_unref(). [transfer full] | 
gboolean zpj_skydrive_download_file_to_path (ZpjSkydrive *self,ZpjSkydriveFile *file,const gchar *path,GCancellable *cancellable,GError **error);
Synchronously downloads file from
Skydrive and saves it in path. The file is temporarily
saved in the preferred directory for temporary files (as returned
by g_get_tmp_dir()) while the download is going on, and then moved
to path.
| 
 | A ZpjSkydrive. | 
| 
 | The ZpjSkydriveFile to be downloaded. | 
| 
 | The destination. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | An optional GErrororNULL. [allow-none] | 
| Returns : | TRUEif the ZpjSkydriveFile was downloaded successfully. | 
GInputStream * zpj_skydrive_download_file_to_stream (ZpjSkydrive *self,ZpjSkydriveFile *file,GCancellable *cancellable,GError **error);
Synchronously returns a stream for downloading file from
Skydrive. See zpj_skydrive_download_file_to_stream_async()
for the asynchronous version of this call.
| 
 | A ZpjSkydrive. | 
| 
 | The ZpjSkydriveFile to be downloaded. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | An optional GErrororNULL. [allow-none] | 
| Returns : | A GInputStream to read the file data
from. Free the returned object with g_object_unref(). [transfer full] | 
void zpj_skydrive_download_file_to_stream_async (ZpjSkydrive *self,ZpjSkydriveFile *file,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously returns a stream for downloading file from
Skydrive. See zpj_skydrive_download_file_to_stream() for the
synchronous version of this call.
When the operation is finished, callback will be called. You can
then call zpj_skydrive_download_file_to_stream_finish() to get the
result of the operation.
| 
 | A ZpjSkydrive. | 
| 
 | The ZpjSkydriveFile to be downloaded. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied. [scope async] | 
| 
 | The data to pass to callback. [closure] | 
GInputStream * zpj_skydrive_download_file_to_stream_finish (ZpjSkydrive *self,GAsyncResult *res,GError **error);
Finishes an asynchronous operation started with
zpj_skydrive_download_file_to_stream_async().
| 
 | A ZpjSkydrive. | 
| 
 | A GAsyncResult. | 
| 
 | An optional GError, or NULL. [allow-none] | 
| Returns : | A GInputStream to read the file data
from. Free the returned object with g_object_unref(). [transfer full] | 
ZpjAuthorizer *     zpj_skydrive_get_authorizer         (ZpjSkydrive *self);
Gets the authorizer used to authorize requests to self.
| 
 | A ZpjSkydrive. | 
| Returns : | A ZpjAuthorizer. The returned object is owned by ZpjSkydrive and should not be modified or freed. [transfer none] | 
GList * zpj_skydrive_list_folder (ZpjSkydrive *self,ZpjSkydriveFolder *folder,GCancellable *cancellable,GError **error);
Synchronously lists the contents of folder_id from
Skydrive.
| 
 | A ZpjSkydrive. | 
| 
 | The ZpjSkydriveFolder to be listed. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | An optional GErrororNULL. [allow-none] | 
| Returns : | A
list of the ZpjSkydrive entries within the ZpjSkydriveFolder.
Free the returned list with g_list_free()after each element has
been freed withg_object_unref(). [transfer full][element-type ZpjSkydriveEntry] | 
GList * zpj_skydrive_list_folder_id (ZpjSkydrive *self,const gchar *folder_id,GCancellable *cancellable,GError **error);
Synchronously lists the contents of the folder corresponding to
folder_id from
Skydrive.
| 
 | A ZpjSkydrive. | 
| 
 | The ID of the ZpjSkydriveFolder to be listed. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | An optional GErrororNULL. [allow-none] | 
| Returns : | A
list of the ZpjSkydrive entries within the ZpjSkydriveFolder, or NULLon error. Free the returned list withg_list_free()after
each element has been freed withg_object_unref(). [transfer full][element-type ZpjSkydriveEntry] | 
void zpj_skydrive_list_folder_id_async (ZpjSkydrive *self,const gchar *folder_id,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously lists the contents of the folder corresponding to
folder_id from
Skydrive. See zpj_skydrive_list_folder_id() for the
synchronous version of this call.
When the operation is finished, callback will be called. You can
then call zpj_skydrive_list_folder_id_finish() to get the result
of the operation.
| 
 | A ZpjSkydrive. | 
| 
 | The ID of the ZpjSkydriveFolder to be listed. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied. [scope async] | 
| 
 | The data to pass to callback. [closure] | 
GList * zpj_skydrive_list_folder_id_finish (ZpjSkydrive *self,GAsyncResult *res,GError **error);
Finishes an asynchronous operation started with
zpj_skydrive_list_folder_id_async().
| 
 | A ZpjSkydrive. | 
| 
 | A GAsyncResult. | 
| 
 | An optional GError, or NULL. [allow-none] | 
| Returns : | A
list of the ZpjSkydrive entries within the ZpjSkydriveFolder, or NULLon error. Free the returned list withg_list_free()after
each element has been freed withg_object_unref(). [transfer full][element-type ZpjSkydriveEntry] | 
ZpjSkydrive *       zpj_skydrive_new                    (ZpjAuthorizer *authorizer);
Creates a new ZpjSkydrive using the given authorizer.
| 
 | A ZpjAuthorizer to authorize the service's requests. | 
| Returns : | A new ZpjSkydrive. Free the returned
object with g_object_unref(). [transfer full] | 
ZpjSkydriveEntry * zpj_skydrive_query_info_from_id (ZpjSkydrive *self,const gchar *id,GCancellable *cancellable,GError **error);
Synchronously reads the properties of the entry corresponding to
id from
Skydrive. See zpj_skydrive_query_info_from_id_async() for
the asynchronous version of this call.
| 
 | A ZpjSkydrive. | 
| 
 | An ID to be queried. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | An optional GErrororNULL. [allow-none] | 
| Returns : | A new ZpjSkydriveEntry. Free the
returned object with g_object_unref(). [transfer full] | 
void zpj_skydrive_query_info_from_id_async (ZpjSkydrive *self,const gchar *id,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously reads the properties of the entry corresponding to
id from
Skydrive. See zpj_skydrive_query_info_from_id() for the
synchronous version of this call.
When the operation is finished, callback will be called. You can
then call zpj_skydrive_query_info_from_id_finish() to get the result
of the operation.
| 
 | A ZpjSkydrive. | 
| 
 | The ID to be queried. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied. [scope async] | 
| 
 | The data to pass to callback. [closure] | 
ZpjSkydriveEntry * zpj_skydrive_query_info_from_id_finish (ZpjSkydrive *self,GAsyncResult *res,GError **error);
Finishes an asynchronous operation started with
zpj_skydrive_query_info_from_id_async().
| 
 | A ZpjSkydrive. | 
| 
 | A GAsyncResult. | 
| 
 | An optional GError, or NULL. [allow-none] | 
| Returns : | A new ZpjSkydriveEntry. Free the returned
object with g_object_unref(). [transfer full] | 
void zpj_skydrive_set_authorizer (ZpjSkydrive *self,ZpjAuthorizer *authorizer);
Uses the new authorizer to replace the old one that was used to
authorize requests to self.
| 
 | A ZpjSkydrive. | 
| 
 | A new ZpjAuthorizer. | 
gboolean zpj_skydrive_upload_path_to_folder (ZpjSkydrive *self,const gchar *path,ZpjSkydriveFolder *folder,GCancellable *cancellable,GError **error);
Synchronously uploads the file at path to
Skydrive and places it under folder.
| 
 | A ZpjSkydrive. | 
| 
 | The source. | 
| 
 | The destination ZpjSkydriveFolder. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | An optional GErrororNULL. [allow-none] | 
| Returns : | TRUEif the file was uploaded successfully. | 
gboolean zpj_skydrive_upload_path_to_folder_id (ZpjSkydrive *self,const gchar *path,const gchar *folder_id,GCancellable *cancellable,GError **error);
Synchronously uploads the file at path to
Skydrive and places it under the folder corresponding to
folder_id.
| 
 | A ZpjSkydrive. | 
| 
 | The source. | 
| 
 | The ID of the destination ZpjSkydriveFolder. | 
| 
 | An optional GCancellable object, or NULL. [allow-none] | 
| 
 | An optional GErrororNULL. [allow-none] | 
| Returns : | TRUEif the file was uploaded successfully. |