|  |  |  | Tracker Miner Library Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Signals | ||||
#include <libtracker-miner/tracker-miner.h> #define TRACKER_MINER_MANAGER_ERROR enum TrackerMinerManagerError; GQuark tracker_miner_manager_error_quark (void); TrackerMinerManager; TrackerMinerManagerClass; TrackerMinerManager * tracker_miner_manager_new (void); GSList * tracker_miner_manager_get_running (TrackerMinerManager *manager); GSList * tracker_miner_manager_get_available (TrackerMinerManager *manager); gboolean tracker_miner_manager_pause (TrackerMinerManager *manager,const gchar *miner,const gchar *reason,guint32 *cookie); gboolean tracker_miner_manager_resume (TrackerMinerManager *manager,const gchar *miner,guint32 cookie); gboolean tracker_miner_manager_is_active (TrackerMinerManager *manager,const gchar *miner); gboolean tracker_miner_manager_is_paused (TrackerMinerManager *manager,const gchar *miner,GStrv *applications,GStrv *reasons); gboolean tracker_miner_manager_get_status (TrackerMinerManager *manager,const gchar *miner,gchar **status,gdouble *progress); const gchar * tracker_miner_manager_get_display_name (TrackerMinerManager *manager,const gchar *miner); const gchar * tracker_miner_manager_get_description (TrackerMinerManager *manager,const gchar *miner); gboolean tracker_miner_manager_index_file (TrackerMinerManager *manager,GFile *file,GError **error); gboolean tracker_miner_manager_ignore_next_update (TrackerMinerManager *manager,const gchar *miner,const gchar **urls); gboolean tracker_miner_manager_reindex_by_mimetype (TrackerMinerManager *manager,const GStrv mimetypes,GError **error);
"miner-activated" : Run Last "miner-deactivated" : Run Last "miner-paused" : Run Last "miner-progress" : Run Last "miner-resumed" : Run Last
TrackerMinerManager keeps track of available miners, their current progress/status, and also allows basic external control on them, such as pausing or resuming data processing.
#define TRACKER_MINER_MANAGER_ERROR tracker_miner_manager_error_quark ()
typedef enum {
	TRACKER_MINER_MANAGER_ERROR_NOT_AVAILABLE,
	TRACKER_MINER_MANAGER_ERROR_NOENT
} TrackerMinerManagerError;
Enumeration values used in errors returned by the TrackerMinerManager API.
GQuark              tracker_miner_manager_error_quark   (void);
| Returns : | the GQuark used to identify miner manager errors in GError structures. | 
typedef struct _TrackerMinerManager TrackerMinerManager;
Object to query and control miners.
typedef struct {
	GObjectClass parent_class;
	void (* miner_progress)    (TrackerMinerManager *manager,
	                            const gchar         *miner_name,
	                            const gchar         *status,
	                            gdouble              progress);
	void (* miner_paused)      (TrackerMinerManager *manager,
	                            const gchar         *miner_name);
	void (* miner_resumed)     (TrackerMinerManager *manager,
	                            const gchar         *miner_name);
	void (* miner_activated)   (TrackerMinerManager *manager,
	                            const gchar         *miner_name);
	void (* miner_deactivated) (TrackerMinerManager *manager,
	                            const gchar         *miner_name);
} TrackerMinerManagerClass;
| GObjectClass  | |
| The progress signal for all miners including name, status and progress as a percentage between 0 and 1. | |
| The paused signal for all miners known about. | |
| The resumed signal for all miners known about. | |
| The activated signal for all miners which indicates the miner is available on d-bus. | |
| The deactivate for all miners which indicates the miner is no longer available on d-bus. | 
TrackerMinerManager * tracker_miner_manager_new         (void);
Creates a new TrackerMinerManager instance.
| Returns : | a TrackerMinerManager. | 
GSList *            tracker_miner_manager_get_running   (TrackerMinerManager *manager);
Returns a list of references for all active miners. Active miners are miners which are running within a process.
| 
 | a trackerMinerManager | 
| Returns : | a GSList which must be freed with g_slist_free()and all
contained data withg_free(). OtherwiseNULLis returned if there
are no miners. | 
GSList *            tracker_miner_manager_get_available (TrackerMinerManager *manager);
Returns a list of references for all available miners. Available miners are miners which may or may not be running in a process at the current time.
| 
 | a TrackerMinerManager | 
| Returns : | a GSList which must be freed with g_slist_free()and all
contained data withg_free(). OtherwiseNULLis returned if there
are no miners. | 
gboolean tracker_miner_manager_pause (TrackerMinerManager *manager,const gchar *miner,const gchar *reason,guint32 *cookie);
Asks miner to pause. a miner could be paused by
several reasons, and its activity won't be resumed
until all pause requests have been resumed.
| 
 | a TrackerMinerManager. | 
| 
 | miner reference | 
| 
 | reason to pause | 
| 
 | return location for the pause cookie ID | 
| Returns : | TRUEif the miner was paused successfully, otherwiseFALSE. | 
gboolean tracker_miner_manager_resume (TrackerMinerManager *manager,const gchar *miner,guint32 cookie);
Tells miner to resume activity. The miner won't actually resume
operations until all pause requests have been resumed.
| 
 | a TrackerMinerManager | 
| 
 | miner reference | 
| 
 | pause cookie | 
| Returns : | TRUEif the miner was successfully resumed, otherwiseFALSE. | 
gboolean tracker_miner_manager_is_active (TrackerMinerManager *manager,const gchar *miner);
Returns the miner's current activity.
| 
 | a TrackerMinerManager | 
| 
 | miner reference | 
| Returns : | TRUEif themineris active, otherwiseFALSE. | 
gboolean tracker_miner_manager_is_paused (TrackerMinerManager *manager,const gchar *miner,GStrv *applications,GStrv *reasons);
This function either returns FALSE if the miner is not paused,
or returns TRUE and fills in applications and reasons with
the pause reasons and the applications that asked for it. Both
arrays will have the same lengh, and will be sorted so the
application/pause reason pairs have the same index.
| 
 | a TrackerMinerManager | 
| 
 | miner reference | 
| 
 | return location for application names. | 
| 
 | return location for pause reasons. | 
| Returns : | TRUEifmineris paused, otherwiseFALSE. | 
gboolean tracker_miner_manager_get_status (TrackerMinerManager *manager,const gchar *miner,gchar **status,gdouble *progress);
Returns the current status and progress for miner.
| 
 | a TrackerMinerManager | 
| 
 | miner reference | 
| 
 | return location for status | 
| 
 | return location for progress | 
| Returns : | TRUEif the status could be retrieved successfully,
otherwiseFALSE | 
const gchar * tracker_miner_manager_get_display_name (TrackerMinerManager *manager,const gchar *miner);
Returns a translated display name for miner.
| 
 | a TrackerMinerManager | 
| 
 | miner reference | 
| Returns : | A string which should not be freed or NULL. | 
const gchar * tracker_miner_manager_get_description (TrackerMinerManager *manager,const gchar *miner);
Returns the description for the given miner.
| 
 | a TrackerMinerManager | 
| 
 | miner reference | 
| Returns : | A string which should not be freed or NULLif none is specified. | 
gboolean tracker_miner_manager_index_file (TrackerMinerManager *manager,GFile *file,GError **error);
Tells the filesystem miner to index the file.
On failure error will be set.
| 
 | a TrackerMinerManager | 
| 
 | a URL valid in GIO of a file to give to the miner for processing | 
| 
 | return location for errors | 
| Returns : | TRUEon success, otherwiseFALSE. | 
gboolean tracker_miner_manager_ignore_next_update (TrackerMinerManager *manager,const gchar *miner,const gchar **urls);
Tells the miner to ignore any events for the next urls. This is
used for cases where a file is updated by Tracker by the
tracker-writeback service. This API is used to avoid signalling up
the stack the changes to urls.
| 
 | a TrackerMinerManager | 
| 
 | miner reference | 
| 
 | the subjects to ignore the next updates of | 
| Returns : | TRUEon success, otherwiseFALSE. | 
gboolean tracker_miner_manager_reindex_by_mimetype (TrackerMinerManager *manager,const GStrv mimetypes,GError **error);
Tells the filesystem miner to reindex any file with a mimetype in
the mimetypes list.
On failure error will be set.
| 
 | a TrackerMinerManager | 
| 
 | an array of mimetypes (E.G. "text/plain"). All items with a mimetype in that list will be reindexed. | 
| 
 | return location for errors | 
| Returns : | TRUEon success, otherwiseFALSE. | 
"miner-activated" signalvoid user_function (TrackerMinerManager *manager, gchar *miner, gpointer user_data) : Run Last
The ::miner-activated signal will be emitted whenever a miner
(referenced by miner) is activated (technically, this means
the miner has appeared in the session bus).
| 
 | the TrackerMinerManager | 
| 
 | miner reference | 
| 
 | user data set when the signal handler was connected. | 
"miner-deactivated" signalvoid user_function (TrackerMinerManager *manager, gchar *miner, gpointer user_data) : Run Last
The ::miner-deactivated signal will be emitted whenever a miner
(referenced by miner) is deactivated (technically, this means
the miner has disappeared from the session bus).
| 
 | the TrackerMinerManager | 
| 
 | miner reference | 
| 
 | user data set when the signal handler was connected. | 
"miner-paused" signalvoid user_function (TrackerMinerManager *manager, gchar *miner, gpointer user_data) : Run Last
The ::miner-paused signal will be emitted whenever a miner
(referenced by miner) is paused.
| 
 | the TrackerMinerManager | 
| 
 | miner reference | 
| 
 | user data set when the signal handler was connected. | 
"miner-progress" signalvoid user_function (TrackerMinerManager *manager, gchar *miner, gchar *status, gdouble progress, gpointer user_data) : Run Last
The ::miner-progress signal is meant to report status/progress changes in any tracked miner.
| 
 | the TrackerMinerManager | 
| 
 | miner reference | 
| 
 | miner status | 
| 
 | miner progress, from 0 to 1 | 
| 
 | user data set when the signal handler was connected. | 
"miner-resumed" signalvoid user_function (TrackerMinerManager *manager, gchar *miner, gpointer user_data) : Run Last
The ::miner-resumed signal will be emitted whenever a miner
(referenced by miner) is resumed.
| 
 | the TrackerMinerManager | 
| 
 | miner reference | 
| 
 | user data set when the signal handler was connected. |