struct EPhotoCache

struct EPhotoCache;

Contains only private data that should be read and manipulated using the functions below.

e_photo_cache_new ()

EPhotoCache *       e_photo_cache_new                   (EClientCache *client_cache);

Creates a new EPhotoCache instance.

e_photo_cache_ref_client_cache ()

EClientCache *      e_photo_cache_ref_client_cache      (EPhotoCache *photo_cache);

Returns the EClientCache passed to e_photo_cache_new().

The returned EClientCache is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.

e_photo_cache_get_local_only ()

gboolean            e_photo_cache_get_local_only        (EPhotoCache *photo_cache);

Returns whether to limit photo searches to the built-in ("local") address book returned by e_source_registry_ref_builtin_address_book().

If this property is FALSE then all enabled address books are searched.

e_photo_cache_set_local_only ()

void                e_photo_cache_set_local_only        (EPhotoCache *photo_cache,
                                                         gboolean local_only);

Sets whether to limit photo searches to the built-in ("local") address book returned by e_source_registry_ref_builtin_address_book().

If this property is FALSE then all enabled address books are searched.

e_photo_cache_get_photo_sync ()

gboolean            e_photo_cache_get_photo_sync        (EPhotoCache *photo_cache,
                                                         const gchar *email_address,
                                                         GCancellable *cancellable,
                                                         GInputStream **out_stream,
                                                         GError **error);

Searches enabled address books (subject to the "local-only" preference) for a contact photo or logo associated with email_address.

If a match is found, a GInputStream from which to read image data is returned through the out_stream return location. If no match is found, the out_stream return location is set to NULL.

The return value indicates whether the search completed successfully, not whether a match was found. If an error occurs, the function will set error and return FALSE.

e_photo_cache_get_photo ()

void                e_photo_cache_get_photo             (EPhotoCache *photo_cache,
                                                         const gchar *email_address,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously searches enabled address books (subject to the "local-only" preference) for a contact photo or logo associated with email_address.

When the operation is finished, callback will be called. You can then call e_photo_cache_get_photo_finish() to get the result of the operation.

e_photo_cache_get_photo_finish ()

gboolean            e_photo_cache_get_photo_finish      (EPhotoCache *photo_cache,
                                                         GAsyncResult *result,
                                                         GInputStream **out_stream,
                                                         GError **error);

Finishes the operation started with e_photo_cache_get_photo().

If a match was found, a GInputStream from which to read image data is returned through the out_stream return location. If no match was found, the out_stream return location is set to NULL.

The return value indicates whether the search completed successfully, not whether a match was found. If an error occurred, the function will set error and return FALSE.

e_photo_cache_remove ()

gboolean            e_photo_cache_remove                (EPhotoCache *photo_cache,
                                                         const gchar *email_address);

Removes the cache entry for email_address, if such an entry exists.

The "client-cache" property

  "client-cache"             EClientCache*         : Read / Write / Construct Only

Cache of shared EClient instances.

The "local-only" property

  "local-only"               gboolean              : Read / Write

Whether to restrict searches to the built-in address book.

Default value: FALSE