libbeagle/docs/reference/beagle-sections.txt

   1 <SECTION>
   2 <FILE>beagle-daemon-information-request</FILE>
   3 <TITLE>BeagleDaemonInformationRequest</TITLE>
   4 beagle_daemon_information_request_new
   5 <SUBSECTION Standard>
   6 BEAGLE_DAEMON_INFORMATION_REQUEST
   7 BEAGLE_IS_DAEMON_INFORMATION_REQUEST
   8 BEAGLE_TYPE_DAEMON_INFORMATION_REQUEST
   9 beagle_daemon_information_request_get_type
  10 BEAGLE_DAEMON_INFORMATION_REQUEST_CLASS
  11 BEAGLE_IS_DAEMON_INFORMATION_REQUEST_CLASS
  12 BEAGLE_DAEMON_INFORMATION_REQUEST_GET_CLASS
  13 </SECTION>
  14
  15 <SECTION>
  16 <FILE>beagle-client</FILE>
  17 <TITLE>BeagleClient</TITLE>
  18 BeagleClient
  19 beagle_client_new
  20 beagle_client_send_request
  21 beagle_client_send_request_async
  22 <SUBSECTION Standard>
  23 BEAGLE_CLIENT
  24 BEAGLE_IS_CLIENT
  25 BEAGLE_TYPE_CLIENT
  26 BEAGLE_CLIENT_CLASS
  27 BEAGLE_IS_CLIENT_CLASS
  28 BEAGLE_CLIENT_GET_CLASS
  29 <SUBSECTION Private>
  30 beagle_client_get_type
  31 </SECTION>
  32
  33
  34 <SECTION>
  35 <FILE>beagle-request</FILE>
  36 <TITLE>BeagleRequest</TITLE>
  37 BeagleRequest
  38 BeagleRequestClass
  39 <SUBSECTION Standard>
  40 BEAGLE_REQUEST
  41 BEAGLE_IS_REQUEST
  42 BEAGLE_TYPE_REQUEST
  43 BEAGLE_REQUEST_CLASS
  44 BEAGLE_IS_REQUEST_CLASS
  45 BEAGLE_REQUEST_GET_CLASS
  46 <SUBSECTION Private>
  47 beagle_request_get_type
  48 </SECTION>
  49
  50 <SECTION>
  51 <FILE>beagle-daemon-information-response</FILE>
  52 <TITLE>BeagleDaemonInformationResponse</TITLE>
  53 BeagleDaemonInformationResponse
  54 beagle_daemon_information_response_get_version
  55 beagle_daemon_information_response_get_human_readable_status
  56 beagle_daemon_information_response_get_index_information
  57 <SUBSECTION Standard>
  58 BEAGLE_DAEMON_INFORMATION_RESPONSE
  59 BEAGLE_IS_DAEMON_INFORMATION_RESPONSE
  60 BEAGLE_TYPE_DAEMON_INFORMATION_RESPONSE
  61 BEAGLE_DAEMON_INFORMATION_RESPONSE_CLASS
  62 BEAGLE_IS_DAEMON_INFORMATION_RESPONSE_CLASS
  63 BEAGLE_DAEMON_INFORMATION_RESPONSE_GET_CLASS
  64 <SUBSECTION Private>
  65 beagle_daemon_information_response_get_type
  66 </SECTION>
  67
  68 <SECTION>
  69 <FILE>beagle-error-response</FILE>
  70 <TITLE>BeagleErrorResponse</TITLE>
  71 BeagleErrorResponse
  72 beagle_error_response_get_message
  73 <SUBSECTION Standard>
  74 BEAGLE_ERROR_RESPONSE
  75 BEAGLE_IS_ERROR_RESPONSE
  76 BEAGLE_TYPE_ERROR_RESPONSE
  77 BEAGLE_ERROR_RESPONSE_CLASS
  78 BEAGLE_IS_ERROR_RESPONSE_CLASS
  79 BEAGLE_ERROR_RESPONSE_GET_CLASS
  80 <SUBSECTION Private>
  81 beagle_error_response_get_type
  82 </SECTION>
  83
  84 <SECTION>
  85 <FILE>beagle-response</FILE>
  86 <TITLE>BeagleResponse</TITLE>
  87 BeagleResponse
  88 <SUBSECTION Standard>
  89 BEAGLE_RESPONSE
  90 BEAGLE_IS_RESPONSE
  91 BEAGLE_TYPE_RESPONSE
  92 BEAGLE_RESPONSE_CLASS
  93 BEAGLE_IS_RESPONSE_CLASS
  94 BEAGLE_RESPONSE_GET_CLASS
  95 <SUBSECTION Private>
  96 beagle_response_get_type
  97 </SECTION>
  98
  99 <SECTION>
 100 <FILE>beagle-shutdown-request</FILE>
 101 <TITLE>BeagleShutdownRequest</TITLE>
 102 BeagleShutdownRequest
 103 beagle_shutdown_request_new
 104 <SUBSECTION Standard>
 105 BEAGLE_SHUTDOWN_REQUEST
 106 BEAGLE_IS_SHUTDOWN_REQUEST
 107 BEAGLE_TYPE_SHUTDOWN_REQUEST
 108 BEAGLE_SHUTDOWN_REQUEST_CLASS
 109 BEAGLE_IS_SHUTDOWN_REQUEST_CLASS
 110 BEAGLE_SHUTDOWN_REQUEST_GET_CLASS
 111 <SUBSECTION Private>
 112 beagle_shutdown_request_get_type
 113 </SECTION>
 114
 115 <SECTION>
 116 <FILE>beagle-hits-added-response</FILE>
 117 <TITLE>BeagleHitsAddedResponse</TITLE>
 118 BeagleHitsAddedResponse
 119 beagle_hits_added_response_get_hits
 120 <SUBSECTION Standard>
 121 BEAGLE_HITS_ADDED_RESPONSE
 122 BEAGLE_IS_HITS_ADDED_RESPONSE
 123 BEAGLE_TYPE_HITS_ADDED_RESPONSE
 124 BEAGLE_HITS_ADDED_RESPONSE_CLASS
 125 BEAGLE_IS_HITS_ADDED_RESPONSE_CLASS
 126 BEAGLE_HITS_ADDED_RESPONSE_GET_CLASS
 127 <SUBSECTION Private>
 128 beagle_hits_added_response_get_type
 129 </SECTION>
 130
 131 <SECTION>
 132 <FILE>beagle-finished-response</FILE>
 133 <TITLE>BeagleFinishedResponse</TITLE>
 134 BeagleFinishedResponse
 135 <SUBSECTION Standard>
 136 BEAGLE_FINISHED_RESPONSE
 137 BEAGLE_IS_FINISHED_RESPONSE
 138 BEAGLE_TYPE_FINISHED_RESPONSE
 139 BEAGLE_FINISHED_RESPONSE_CLASS
 140 BEAGLE_IS_FINISHED_RESPONSE_CLASS
 141 BEAGLE_FINISHED_RESPONSE_GET_CLASS
 142 <SUBSECTION Private>
 143 beagle_finished_response_get_type
 144 </SECTION>
 145
 146 <SECTION>
 147 <FILE>beagle-hits-subtracted-response</FILE>
 148 <TITLE>BeagleHitsSubtractedResponse</TITLE>
 149 BeagleHitsSubtractedResponse
 150 beagle_hits_subtracted_response_get_uris
 151 <SUBSECTION Standard>
 152 BEAGLE_HITS_SUBTRACTED_RESPONSE
 153 BEAGLE_IS_HITS_SUBTRACTED_RESPONSE
 154 BEAGLE_TYPE_HITS_SUBTRACTED_RESPONSE
 155 beagle_hits_subtracted_response_get_type
 156 BEAGLE_HITS_SUBTRACTED_RESPONSE_CLASS
 157 BEAGLE_IS_HITS_SUBTRACTED_RESPONSE_CLASS
 158 BEAGLE_HITS_SUBTRACTED_RESPONSE_GET_CLASS
 159 </SECTION>
 160
 161 <SECTION>
 162 <FILE>beagle-query</FILE>
 163 <TITLE>BeagleQuery</TITLE>
 164 BeagleQuery
 165 beagle_query_new
 166 <SUBSECTION Standard>
 167 BEAGLE_QUERY
 168 BEAGLE_IS_QUERY
 169 BEAGLE_TYPE_QUERY
 170 BEAGLE_QUERY_CLASS
 171 BEAGLE_IS_QUERY_CLASS
 172 BEAGLE_QUERY_GET_CLASS
 173 <SUBSECTION Private>
 174 beagle_query_get_type
 175 </SECTION>
 176
 177 <SECTION>
 178 <FILE>beagle-snippet-response</FILE>
 179 <TITLE>BeagleSnippetResponse</TITLE>
 180 BeagleSnippetResponse
 181 beagle_snippet_response_get_snippet
 182 <SUBSECTION Standard>
 183 BEAGLE_SNIPPET_RESPONSE
 184 BEAGLE_IS_SNIPPET_RESPONSE
 185 BEAGLE_TYPE_SNIPPET_RESPONSE
 186 BEAGLE_SNIPPET_RESPONSE_CLASS
 187 BEAGLE_IS_SNIPPET_RESPONSE_CLASS
 188 BEAGLE_SNIPPET_RESPONSE_GET_CLASS
 189 <SUBSECTION Private>
 190 beagle_snippet_response_get_type
 191 </SECTION>
 192
 193 <SECTION>
 194 <FILE>beagle-empty-response</FILE>
 195 <TITLE>BeagleEmptyResponse</TITLE>
 196 BeagleEmptyResponse
 197 <SUBSECTION Standard>
 198 BEAGLE_EMPTY_RESPONSE
 199 BEAGLE_IS_EMPTY_RESPONSE
 200 BEAGLE_TYPE_EMPTY_RESPONSE
 201 BEAGLE_EMPTY_RESPONSE_CLASS
 202 BEAGLE_IS_EMPTY_RESPONSE_CLASS
 203 BEAGLE_EMPTY_RESPONSE_GET_CLASS
 204 <SUBSECTION Private>
 205 beagle_empty_response_get_type
 206 </SECTION>
 207
 208 <SECTION>
 209 <FILE>beagle-indexing-service-request</FILE>
 210 <TITLE>BeagleIndexingServiceRequest</TITLE>
 211 BeagleIndexingServiceRequest
 212 beagle_indexing_service_request_new
 213 beagle_indexing_service_request_add
 214 beagle_indexing_service_request_remove
 215 <SUBSECTION Standard>
 216 BEAGLE_INDEXING_SERVICE_REQUEST
 217 BEAGLE_IS_INDEXING_SERVICE_REQUEST
 218 BEAGLE_TYPE_INDEXING_SERVICE_REQUEST
 219 BEAGLE_INDEXING_SERVICE_REQUEST_CLASS
 220 BEAGLE_IS_INDEXING_SERVICE_REQUEST_CLASS
 221 BEAGLE_INDEXING_SERVICE_REQUEST_GET_CLASS
 222 <SUBSECTION Private>
 223 beagle_indexing_service_request_get_type
 224 </SECTION>
 225
 226 <SECTION>
 227 <FILE>beagle-snippet-request</FILE>
 228 <TITLE>BeagleSnippetRequest</TITLE>
 229 BeagleSnippetRequest
 230 beagle_snippet_request_new
 231 beagle_snippet_request_set_hit
 232 beagle_snippet_request_add_query_term
 233 beagle_snippet_request_set_query_terms_from_query
 234 <SUBSECTION Standard>
 235 BEAGLE_SNIPPET_REQUEST
 236 BEAGLE_IS_SNIPPET_REQUEST
 237 BEAGLE_TYPE_SNIPPET_REQUEST
 238 BEAGLE_SNIPPET_REQUEST_CLASS
 239 BEAGLE_IS_SNIPPET_REQUEST_CLASS
 240 BEAGLE_SNIPPET_REQUEST_GET_CLASS
 241 <SUBSECTION Private>
 242 beagle_snippet_request_get_type
 243 </SECTION>
 244
 245 <SECTION>
 246 <FILE>beagle-cancelled-response</FILE>
 247 <TITLE>BeagleCancelledResponse</TITLE>
 248 BeagleCancelledResponse
 249 <SUBSECTION Standard>
 250 BEAGLE_CANCELLED_RESPONSE
 251 BEAGLE_IS_CANCELLED_RESPONSE
 252 BEAGLE_TYPE_CANCELLED_RESPONSE
 253 BEAGLE_CANCELLED_RESPONSE_CLASS
 254 BEAGLE_IS_CANCELLED_RESPONSE_CLASS
 255 BEAGLE_CANCELLED_RESPONSE_GET_CLASS
 256 <SUBSECTION Private>
 257 beagle_cancelled_response_get_type
 258 </SECTION>
 259
 260 <SECTION>
 261 <TITLE>BeagleHit</TITLE>
 262 <FILE>beagle-hit</FILE>
 263 BeagleHit
 264 beagle_hit_ref
 265 beagle_hit_unref
 266 beagle_hit_get_uri
 267 beagle_hit_get_timestamp
 268 beagle_hit_get_type
 269 beagle_hit_get_mime_type
 270 beagle_hit_get_source
 271 beagle_hit_get_source_object_name
 272 beagle_hit_get_revision
 273 beagle_hit_get_id
 274 beagle_hit_get_score
 275 beagle_hit_get_score_multiplier
 276 beagle_hit_get_score_raw
 277 beagle_hit_get_property
 278 beagle_hit_lookup_property
 279 </SECTION>
 280
 281 <SECTION>
 282 <FILE>beagle-query-part</FILE>
 283 BEAGLE_QUERY_PART_TARGET_ALL
 284 BEAGLE_QUERY_PART_TARGET_TEXT
 285 BEAGLE_QUERY_PART_TARGET_PROPERTIES
 286 BeagleQueryPart
 287 beagle_query_part_new
 288 beagle_query_part_free
 289 beagle_query_part_set_target
 290 beagle_query_part_set_text
 291 beagle_query_part_set_keyword
 292 beagle_query_part_set_required
 293 beagle_query_part_set_prohibited
 294 </SECTION>
 295
 296 <SECTION>
 297 <FILE>beagle-property</FILE>
 298 BeagleProperty
 299 beagle_property_new
 300 beagle_property_free
 301 beagle_property_get_key
 302 beagle_property_set_key
 303 beagle_property_get_value
 304 beagle_property_set_value
 305 beagle_property_get_is_searched
 306 beagle_property_set_is_searched
 307 beagle_property_get_is_keyword
 308 beagle_property_set_is_keyword
 309 </SECTION>
 310
 311 <SECTION>
 312 <FILE>beagle-timestamp</FILE>
 313 BeageTimestamp
 314 beagle_timestamp_new_from_string
 315 beagle_timestamp_new_from_unix_time
 316 beagle_timestamp_free
 317 beagle_timestamp_to_unix_time
 318 </SECTION>
 319
 320 <SECTION>
 321 <FILE>beagle-indexable</FILE>
 322 BeagleIndexable
 323 BeagleIndexableFiltering
 324 beagle_indexable_new
 325 beagle_indexable_free
 326 beagle_indexable_add_property
 327 beagle_indexable_get_uri
 328 beagle_indexable_set_uri
 329 beagle_indexable_get_content_uri
 330 beagle_indexable_set_content_uri
 331 beagle_indexable_get_hot_content_uri
 332 beagle_indexable_set_hot_content_uri
 333 beagle_indexable_get_delete_content
 334 beagle_indexable_set_delete_content
 335 beagle_indexable_get_crawled
 336 beagle_indexable_set_crawled
 337 beagle_indexable_get_no_content
 338 beagle_indexable_set_no_content
 339 beagle_indexable_get_cache_content
 340 beagle_indexable_set_cache_content
 341 beagle_indexable_get_filtering
 342 beagle_indexable_set_filtering
 343 beagle_indexable_get_type
 344 beagle_indexable_set_type
 345 beagle_indexable_get_mime_type
 346 beagle_indexable_set_mime_type
 347 </SECTION>
 348