e-book-auth-util

e-book-auth-util

Synopsis

EBook *		           e_load_book_source                  (ESource *source,
                                                         EBookCallback open_func,
                                                         gpointer user_data);
void                e_load_book_source_async            (ESource *source,
                                                         GtkWindow *parent,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
EBook *		           e_load_book_source_finish           (ESource *source,
                                                         GAsyncResult *result,
                                                         GError **error);

Description

Details

e_load_book_source ()

EBook *		           e_load_book_source                  (ESource *source,
                                                         EBookCallback open_func,
                                                         gpointer user_data);

Warning

e_load_book_source has been deprecated since version 3.0 and should not be used in newly-written code. Use e_load_book_source_async() instead.

Creates a new EBook specified by source, and starts a non-blocking open operation on it. If the book requires authorization, presents a window asking the user for such.

When the operation finishes, calls the callback function indicating if it succeeded or not. If you don't care, you can pass NULL for open_func, and no action will be taken on completion.

source :

an ESource

open_func :

a function to call when the operation finishes, or NULL

user_data :

data to pass to callback function

Returns :

A new EBook that is being opened.

e_load_book_source_async ()

void                e_load_book_source_async            (ESource *source,
                                                         GtkWindow *parent,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Warning

e_load_book_source_async has been deprecated since version 3.2 and should not be used in newly-written code. Use e_client_utils_open_new(), e_client_utils_open_new_finish() instead.

Creates a new EBook specified by source and opens it, prompting the user for authentication if necessary.

When the operation is finished, callback will be called. You can then call e_load_book_source_finish() to obtain the resulting EBook.

source :

an ESource

parent :

parent window for password dialogs, or NULL

cancellable :

optional GCancellable object, NULL to ignore

callback :

a GAsyncReadyCallback to call when the request is satisfied

user_data :

the data to pass to callback

Since 2.32


e_load_book_source_finish ()

EBook *		           e_load_book_source_finish           (ESource *source,
                                                         GAsyncResult *result,
                                                         GError **error);

Warning

e_load_book_source_finish has been deprecated since version 3.2 and should not be used in newly-written code. Use e_client_utils_open_new(), e_client_utils_open_new_finish() instead.

Finishes an asynchronous EBook open operation started with e_load_book_source_async(). If an error occurred, or the user declined to authenticate, the function will return NULL and set error.

source :

an ESource

result :

a GAsyncResult

error :

return location for a GError, or NULL

Returns :

a ready-to-use EBook, or NULL or error

Since 2.32