BeagleIndexingServiceRequest

BeagleIndexingServiceRequest

Synopsis

                    BeagleIndexingServiceRequest;
BeagleIndexingServiceRequest* beagle_indexing_service_request_new
                                                        (void);
void                beagle_indexing_service_request_add (BeagleIndexingServiceRequest *request,
                                                         BeagleIndexable *indexable);
void                beagle_indexing_service_request_remove
                                                        (BeagleIndexingServiceRequest *request,
                                                         const char *uri);
void                beagle_indexing_service_request_set_source
                                                        (BeagleIndexingServiceRequest *request,
                                                         const char *source);

Object Hierarchy

  GObject
   +----BeagleRequest
         +----BeagleIndexingServiceRequest

Description

Details

BeagleIndexingServiceRequest

typedef struct _BeagleIndexingServiceRequest BeagleIndexingServiceRequest;


beagle_indexing_service_request_new ()

BeagleIndexingServiceRequest* beagle_indexing_service_request_new
                                                        (void);

Creates a new BeagleIndexingServiceRequest.

Returns :

a newly created BeagleIndexingServiceRequest.

beagle_indexing_service_request_add ()

void                beagle_indexing_service_request_add (BeagleIndexingServiceRequest *request,
                                                         BeagleIndexable *indexable);

Adds a BeagleIndexable to the given BeagleIndexingServiceRequest.

request :

a BeagleIndexingServiceRequest

indexable :

a BeagleIndexable

beagle_indexing_service_request_remove ()

void                beagle_indexing_service_request_remove
                                                        (BeagleIndexingServiceRequest *request,
                                                         const char *uri);

Adds the given uri to the list of uris to be removed tothe given BeagleIndexingServiceRequest.

request :

a BeagleIndexingServiceRequest

uri :

a string

beagle_indexing_service_request_set_source ()

void                beagle_indexing_service_request_set_source
                                                        (BeagleIndexingServiceRequest *request,
                                                         const char *source);

Normally BeagleIndexables sent through the indexing service are stored in a dedicated index, the IndexingService index. Sometimes, however, you might want to send a BeagleIndexable to another running backend. A common use-case for this is if you wanted to add or change metadata on an already indexed document. To do this, you would create a BeagleIndexable with type BEAGLE_INDEXABLE_TYPE_PROPERTY_CHANGE and set the source to your backend of choice, like "Files". The daemon will route your indexable to that backend instead of the indexing service backend. If the backend doesn't exist, you will get a BeagleErrorResponse.

request :

a BeagleIndexingServiceRequest

source :

the backend to send the request to