org.freesmartphone.PIM/org.freesmartphone.PIM.DateQuery.xml.in

   1 <?xml version="1.0"?>
   2 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd" doc:id="freesmartphone-pim-datequery-interface">
   3
   4 <doc:doc>
   5   <doc:summary>freesmartphone.org PIM.DateQuery Interface</doc:summary>
   6 </doc:doc>
   7
   8 <interface name="org.freesmartphone.PIM.DateQuery">
   9
  10   <doc:doc>
  11     <doc:para>
  12       This interface gives access to a date query.
  13     </doc:para>
  14   </doc:doc>
  15
  16   <method name="GetResultCount">
  17     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  18     <doc:doc>
  19       <doc:description>Return the number of items in the query result</doc:description>
  20     </doc:doc>
  21     <arg direction="out" type="i" name="count">
  22       <doc:doc>
  23         <doc:summary>
  24           Amount of dates in the query result.
  25         </doc:summary>
  26       </doc:doc>
  27     </arg>
  28   </method>
  29
  30   <method name="Rewind">
  31     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  32     <doc:doc>
  33       <doc:description>
  34         Rewind the result cursor to the first date (for this dbus client only).
  35       </doc:description>
  36     </doc:doc>
  37   </method>
  38
  39   <method name="Skip">
  40     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  41     <doc:doc>
  42       <doc:description>
  43         Skip n dates in the result cursor (for this dbus client only).
  44       </doc:description>
  45     </doc:doc>
  46     <arg direction="in" type="i" name="count">
  47       <doc:doc>
  48         <doc:summary>
  49           Amount of dates to skip.
  50         </doc:summary>
  51       </doc:doc>
  52     </arg>
  53   </method>
  54
  55   <method name="GetDatePath">
  56     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  57     <doc:doc>
  58       <doc:description>
  59         Path for the date the result cursor points to.
  60       </doc:description>
  61     </doc:doc>
  62     <arg direction="out" type="s" name="date_path">
  63       <doc:doc>
  64         <doc:summary>
  65           The path to the date.
  66         </doc:summary>
  67       </doc:doc>
  68     </arg>
  69   </method>
  70
  71   <method name="GetResult">
  72     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  73     <doc:doc>
  74       <doc:description>
  75         Return the next date in the query result, and move the query to the next date.
  76       </doc:description>
  77     </doc:doc>
  78     <arg type="a{sv}" name="item" direction="out">
  79       <doc:doc>
  80         <doc:summary>
  81           fields of the result.
  82         </doc:summary>
  83       </doc:doc>
  84     </arg>
  85   </method>
  86
  87   <method name="GetMultipleResults">
  88     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  89     <doc:doc>
  90       <doc:description>
  91         Get multiple dates from the result set at once.
  92       </doc:description>
  93     </doc:doc>
  94     <arg direction="in" type="i" name="count">
  95       <doc:doc>
  96         <doc:summary>
  97           The number of dates to get from the result set. A negative value means all.
  98         </doc:summary>
  99       </doc:doc>
 100     </arg>
 101     <arg direction="out" type="aa{sv}" name="resultset">
 102       <doc:doc>
 103         <doc:summary>
 104           The list of the returned dates data.
 105         </doc:summary>
 106       </doc:doc>
 107     </arg>
 108   </method>
 109
 110   <method name="Dispose">
 111     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
 112     <doc:doc>
 113       <doc:description>
 114         Delete the query result object.
 115       </doc:description>
 116     </doc:doc>
 117   </method>
 118
 119   <signal name="DateAdded">
 120     <doc:doc>
 121       <doc:description>
 122         Sent when a new date which matches this query is loaded.
 123       </doc:description>
 124     </doc:doc>
 125     <arg type="s" name="date_path">
 126       <doc:doc>
 127         <doc:summary>
 128           The path of the newly loaded date.
 129         </doc:summary>
 130       </doc:doc>
 131     </arg>
 132   </signal>
 133
 134 </interface>
 135
 136 </node>