af7a34521f
Document and enforce that a meta ID corresponds to the result ID that we've passed in. This does not break any existing search providers as far as I'm aware. https://bugzilla.gnome.org/show_bug.cgi?id=693836
74 lines
3.5 KiB
XML
74 lines
3.5 KiB
XML
<!DOCTYPE node PUBLIC
|
|
'-//freedesktop//DTD D-BUS Object Introspection 1.0//EN'
|
|
'http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd'>
|
|
<node>
|
|
|
|
<!--
|
|
org.gnome.Shell.SearchProvider:
|
|
@short_description: Search provider interface
|
|
|
|
The interface used for integrating into GNOME Shell's search
|
|
interface. This interface is deprecated, and org.gnome.Shell.SearchProvider2 should be used instead.
|
|
-->
|
|
<interface name="org.gnome.Shell.SearchProvider">
|
|
|
|
<!--
|
|
GetInitialResultSet:
|
|
@terms: Array of search terms, which the provider should treat as logical AND.
|
|
@results: An array of result identifier strings representing items which match the given search terms. Identifiers must be unique within the provider's domain, but other than that may be chosen freely by the provider.
|
|
|
|
Called when the user first begins a search.
|
|
-->
|
|
<method name="GetInitialResultSet">
|
|
<arg type="as" name="terms" direction="in" />
|
|
<arg type="as" name="results" direction="out" />
|
|
</method>
|
|
|
|
<!--
|
|
GetSubsearchResultSet:
|
|
@previous_results: Array of results previously returned by GetInitialResultSet().
|
|
@terms: Array of updated search terms, which the provider should treat as logical AND.
|
|
@results: An array of result identifier strings representing items which match the given search terms. Identifiers must be unique within the provider's domain, but other than that may be chosen freely by the provider.
|
|
|
|
Called when a search is performed which is a "subsearch" of
|
|
the previous search, e.g. the method may return less results, but
|
|
not more or different results.
|
|
|
|
This allows search providers to only search through the previous
|
|
result set, rather than possibly performing a full re-query.
|
|
-->
|
|
<method name="GetSubsearchResultSet">
|
|
<arg type="as" name="previous_results" direction="in" />
|
|
<arg type="as" name="terms" direction="in" />
|
|
<arg type="as" name="results" direction="out" />
|
|
</method>
|
|
|
|
<!--
|
|
GetResultMetas:
|
|
@identifiers: An array of result identifiers as returned by GetInitialResultSet() or GetSubsearchResultSet()
|
|
@metas: A dictionary describing the given search result, containing a human-readable 'name' (string), along with the result identifier this meta is for, 'id' (string). Optionally, either 'gicon' (a serialized GIcon) or 'icon-data' (raw image data as (iiibiiay) - width, height, rowstride, has-alpha, bits per sample, channels, data) can be specified if the result can be better served with a thumbnail of the content (such as with images). A 'description' field (string) may also be specified if more context would help the user find the desired result.
|
|
|
|
Return an array of meta data used to display each given result
|
|
-->
|
|
<method name="GetResultMetas">
|
|
<arg type="as" name="identifiers" direction="in" />
|
|
<arg type="aa{sv}" name="metas" direction="out" />
|
|
</method>
|
|
|
|
<!--
|
|
ActivateResult:
|
|
@identifier: A result identifier as returned by GetInitialResultSet() or GetSubsearchResultSet()
|
|
|
|
Called when the users chooses a given result. The result should
|
|
be displayed in the application associated with the corresponding
|
|
provider.
|
|
|
|
This method is deprecated, and providers should implement ActivateResult2()
|
|
instead.
|
|
-->
|
|
<method name="ActivateResult">
|
|
<arg type="s" name="identifier" direction="in" />
|
|
</method>
|
|
</interface>
|
|
</node>
|