org.freesmartphone.PIM/org.freesmartphone.PIM.Note.xml.in

   1 <?xml version="1.0"?>
   2 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd" doc:id="freesmartphone-note-interface">
   3
   4 <doc:doc>
   5   <doc:summary>freesmartphone.org PIM.Note Interface</doc:summary>
   6 </doc:doc>
   7
   8 <interface name="org.freesmartphone.PIM.Note">
   9
  10   <doc:doc>
  11     <doc:para>
  12       This interface provides access to one PIM note.
  13     </doc:para>
  14   </doc:doc>
  15
  16   <method name="GetContent">
  17     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  18     <doc:doc>
  19       <doc:description>
  20         Get the fields of one note.
  21       </doc:description>
  22     </doc:doc>
  23     <arg direction="out" type="a{sv}" name="note_data">
  24       <doc:doc>
  25         <doc:summary>
  26           The note's data.
  27         </doc:summary>
  28       </doc:doc>
  29     </arg>
  30   </method>
  31
  32   <method name="GetMultipleFields">
  33     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  34     <doc:doc>
  35       <doc:description>
  36         Get a specified field list of the note's data.
  37       </doc:description>
  38     </doc:doc>
  39     <arg direction="in" type="s" name="field_list">
  40       <doc:doc>
  41         <doc:summary>
  42           The list of fields to get, split by "," (coma) char.
  43         </doc:summary>
  44       </doc:doc>
  45     </arg>
  46     <arg direction="out" type="a{sv}" name="field_data">
  47       <doc:doc>
  48         <doc:summary>
  49           The data of the requested fields.
  50         </doc:summary>
  51       </doc:doc>
  52     </arg>
  53   </method>
  54
  55   <method name="GetUsedBackends">
  56     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  57     <doc:doc>
  58       <doc:description>
  59         Get used backends in note.
  60       </doc:description>
  61     </doc:doc>
  62     <arg direction="out" type="as" name="backends">
  63       <doc:doc>
  64         <doc:summary>
  65           The list of backends used in this note.
  66         </doc:summary>
  67       </doc:doc>
  68     </arg>
  69   </method>
  70
  71   <method name="Update">
  72     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  73     <doc:doc>
  74       <doc:description>
  75         Update one or more fields of this note.
  76       </doc:description>
  77     </doc:doc>
  78     <arg direction="in" type="a{sv}" name="note_data">
  79       <doc:doc>
  80         <doc:summary>
  81           The list of fields/values to update for this note.
  82         </doc:summary>
  83       </doc:doc>
  84     </arg>
  85   </method>
  86
  87   <method name="Delete">
  88     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  89     <doc:doc>
  90       <doc:description>
  91         Delete this note.
  92       </doc:description>
  93     </doc:doc>
  94   </method>
  95
  96   <signal name="NoteDeleted">
  97     <doc:doc>
  98       <doc:description>
  99         Sent when note is deleted.
 100       </doc:description>
 101     </doc:doc>
 102   </signal>
 103
 104   <signal name="NoteUpdated">
 105     <doc:doc>
 106       <doc:description>
 107         Sent when note is updated.
 108       </doc:description>
 109     </doc:doc>
 110     <arg type="a{sv}" name="data">
 111       <doc:doc>
 112         <doc:summary>
 113           Data used to update note.
 114         </doc:summary>
 115       </doc:doc>
 116     </arg>
 117   </signal>
 118
 119 </interface>
 120
 121 </node>
 122