org.freesmartphone.PIM/org.freesmartphone.PIM.Notes.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-notes-interface">
   3
   4 <doc:doc>
   5   <doc:summary>freesmartphone.org PIM.Notes Interface</doc:summary>
   6 </doc:doc>
   7
   8 <interface name="org.freesmartphone.PIM.Notes">
   9
  10   <doc:doc>
  11     <doc:para>
  12       This interface provides access to the collection of PIM notes.
  13     </doc:para>
  14   </doc:doc>
  15
  16   <method name="Add">
  17     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  18     <doc:doc>
  19       <doc:description>
  20         Add a new note to the default backend for notes.
  21       </doc:description>
  22     </doc:doc>
  23     <arg direction="in" type="a{sv}" name="note_data">
  24       <doc:doc>
  25         <doc:summary>
  26           The new notes data.
  27         </doc:summary>
  28       </doc:doc>
  29     </arg>
  30     <arg direction="out" type="s" name="note_path">
  31       <doc:doc>
  32         <doc:summary>
  33           The path of the added note.
  34         </doc:summary>
  35       </doc:doc>
  36     </arg>
  37   </method>
  38
  39   <method name="GetUsedTags">
  40     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  41     <doc:doc>
  42       <doc:description>
  43         Returns list of all tags used in loaded notes.
  44       </doc:description>
  45     </doc:doc>
  46     <arg direction="out" type="as" name="used_tags">
  47       <doc:doc>
  48         <doc:summary>
  49           List of tags.
  50         </doc:summary>
  51       </doc:doc>
  52     </arg>
  53   </method>
  54
  55   <method name="GetSingleEntrySingleField">
  56     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  57     <doc:doc>
  58       <doc:description>
  59         Query the content of one field of one note.
  60       </doc:description>
  61     </doc:doc>
  62     <arg direction="in" type="a{sv}" name="query">
  63       <doc:doc>
  64         <doc:summary>
  65           The query.
  66         </doc:summary>
  67       </doc:doc>
  68     </arg>
  69     <arg direction="in" type="s" name="field">
  70       <doc:doc>
  71         <doc:summary>
  72           The name of the field to query.
  73         </doc:summary>
  74       </doc:doc>
  75     </arg>
  76     <arg direction="out" type="s" name="value">
  77       <doc:doc>
  78         <doc:summary>
  79           The content of the queried field.
  80         </doc:summary>
  81       </doc:doc>
  82     </arg>
  83   </method>
  84
  85   <method name="Query">
  86     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  87     <doc:doc>
  88       <doc:description>
  89         Start a query for notes.
  90       </doc:description>
  91     </doc:doc>
  92     <arg direction="in" type="a{sv}" name="query">
  93       <doc:doc>
  94         <doc:summary>
  95           The query.
  96         </doc:summary>
  97       </doc:doc>
  98     </arg>
  99     <arg direction="out" type="s" name="query_path">
 100       <doc:doc>
 101         <doc:summary>
 102           The path for the started query.
 103         </doc:summary>
 104       </doc:doc>
 105     </arg>
 106   </method>
 107
 108   <signal name="NewNote">
 109     <doc:doc>
 110       <doc:description>
 111         Sent when a new note is loaded.
 112       </doc:description>
 113     </doc:doc>
 114     <arg type="s" name="note_path">
 115       <doc:doc>
 116         <doc:summary>
 117           The path of the newly loaded note.
 118         </doc:summary>
 119       </doc:doc>
 120     </arg>
 121   </signal>
 122
 123   <signal name="NewTag">
 124     <doc:doc>
 125       <doc:description>
 126         Sent when a newly loaded or updated note has some unused before tag.
 127       </doc:description>
 128     </doc:doc>
 129     <arg type="s" name="tag">
 130       <doc:doc>
 131         <doc:summary>
 132           The name of new tag.
 133         </doc:summary>
 134       </doc:doc>
 135     </arg>
 136   </signal>
 137
 138   <signal name="TagRemoved">
 139     <doc:doc>
 140       <doc:description>
 141         Sent when last instance of tag in notes is removed.
 142       </doc:description>
 143     </doc:doc>
 144     <arg type="s" name="tag">
 145       <doc:doc>
 146         <doc:summary>
 147           The name of removed tag.
 148         </doc:summary>
 149       </doc:doc>
 150     </arg>
 151   </signal>
 152
 153 </interface>
 154
 155 </node>
 156