org.freesmartphone.PIM/org.freesmartphone.PIM.Contacts.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-contacts-interface">
   3
   4 <doc:doc>
   5   <doc:summary>freesmartphone.org PIM.Contacts Interface</doc:summary>
   6 </doc:doc>
   7
   8 <interface name="org.freesmartphone.PIM.Contacts">
   9
  10   <doc:doc>
  11     <doc:para>
  12       This interface provides access to the collection of PIM contacts.
  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 contact to the default backend for contacts.
  21       </doc:description>
  22     </doc:doc>
  23     <arg direction="in" type="a{sv}" name="contact_data">
  24       <doc:doc>
  25         <doc:summary>
  26           The new contacts data.
  27         </doc:summary>
  28       </doc:doc>
  29     </arg>
  30     <arg direction="out" type="s" name="contact_path">
  31       <doc:doc>
  32         <doc:summary>
  33           The contact path of the added contact.
  34         </doc:summary>
  35       </doc:doc>
  36     </arg>
  37   </method>
  38
  39   <method name="GetSingleEntrySingleField">
  40     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  41     <doc:doc>
  42       <doc:description>
  43         Query the content of one field of one contact.
  44       </doc:description>
  45     </doc:doc>
  46     <arg direction="in" type="a{sv}" name="query">
  47       <doc:doc>
  48         <doc:summary>
  49           The query.
  50         </doc:summary>
  51       </doc:doc>
  52     </arg>
  53     <arg direction="in" type="s" name="field">
  54       <doc:doc>
  55         <doc:summary>
  56           The name of the field to query.
  57         </doc:summary>
  58       </doc:doc>
  59     </arg>
  60     <arg direction="out" type="s" name="value">
  61       <doc:doc>
  62         <doc:summary>
  63           The content of the queried field.
  64         </doc:summary>
  65       </doc:doc>
  66     </arg>
  67   </method>
  68
  69   <method name="Query">
  70     <annotation name="org.freedesktop.DBus.GLib.Async" value="true" />
  71     <doc:doc>
  72       <doc:description>
  73         Start a query for contacts.
  74       </doc:description>
  75     </doc:doc>
  76     <arg direction="in" type="a{sv}" name="query">
  77       <doc:doc>
  78         <doc:summary>
  79           The query.
  80         </doc:summary>
  81       </doc:doc>
  82     </arg>
  83     <arg direction="out" type="s" name="query_path">
  84       <doc:doc>
  85         <doc:summary>
  86           The path for the started query.
  87         </doc:summary>
  88       </doc:doc>
  89     </arg>
  90   </method>
  91
  92   <signal name="NewContact">
  93     <doc:doc>
  94       <doc:description>
  95         Sent when a new contact is loaded.
  96       </doc:description>
  97     </doc:doc>
  98     <arg type="s" name="contact_path">
  99       <doc:doc>
 100         <doc:summary>
 101           The path of the newly loaded contact.
 102         </doc:summary>
 103       </doc:doc>
 104     </arg>
 105   </signal>
 106   <signal name="UpdatedContact">
 107     <doc:doc>
 108       <doc:description>
 109         Sent when an existing contact got updated.
 110       </doc:description>
 111     </doc:doc>
 112     <arg type="s" name="contact_path">
 113       <doc:doc>
 114         <doc:summary>
 115           The path of the updated contact.
 116         </doc:summary>
 117       </doc:doc>
 118     </arg>
 119     <arg type="a{sv}" name="contact_data">
 120       <doc:doc>
 121         <doc:summary>
 122           The part of the contacts data that got changed.
 123         </doc:summary>
 124       </doc:doc>
 125     </arg>
 126   </signal>
 127   <signal name="DeletedContact">
 128     <doc:doc>
 129       <doc:description>
 130         Sent when a contact got deleted.
 131       </doc:description>
 132     </doc:doc>
 133     <arg type="s" name="contact_path">
 134       <doc:doc>
 135         <doc:summary>
 136           The path of that deleted contact.
 137         </doc:summary>
 138       </doc:doc>
 139     </arg>
 140   </signal>
 141
 142 </interface>
 143
 144 </node>
 145