Warning, /frameworks/modemmanager-qt/src/dbus/introspection/wip-org.freedesktop.ModemManager1.Modem.Contacts.xml is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" encoding="UTF-8" ?>
0002 
0003 <!--
0004  ModemManager 1.0 Interface Specification
0005 
0006    Copyright (C) 2008 Novell, Inc.
0007    Copyright (C) 2008-2013 Red Hat, Inc.
0008    Copyright (C) 2011-2013 Google, Inc.
0009    Copyright (C) 2011-2013 Lanedo GmbH
0010 -->
0011 
0012 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
0013 
0014   <!--
0015       org.freedesktop.ModemManager1.Modem.Contacts:
0016       @short_description: The ModemManager Contacts interface.
0017 
0018       This interface provides access to contacts stored in various locations,
0019       including SIM cards, device storage, and other locations. Operations
0020       generally operate on all contacts regardless of their actual storage
0021       location.
0022 
0023       Contacts are referred to by index numbers, which are internal to
0024       ModemManager and do not represent indexes of SIM cards or the device.
0025       Indexes may not be contiguous.
0026   -->
0027   <interface name="org.freedesktop.ModemManager1.Modem.Contacts">
0028 
0029     <!--
0030         Add:
0031         @properties: Dictionary of properties describing the contact.
0032         @index: The index number of the new contact
0033 
0034         Add a new contact.
0035 
0036         If any of the property in @properties exceeds the modem's size limit,
0037         that property will be truncated to fit.
0038 
0039         Known properties are:
0040         <variablelist>
0041           <varlistentry><term><literal>"name"</literal></term>
0042             <listitem>
0043               Full name of the contact, given as a string value
0044               (signature <literal>"s"</literal>).
0045             </listitem>
0046           </varlistentry>
0047           <varlistentry><term><literal>"number"</literal></term>
0048             <listitem>
0049               Telephone number, given as a string value
0050               (signature <literal>"s"</literal>).
0051             </listitem>
0052           </varlistentry>
0053           <varlistentry><term><literal>"email"</literal></term>
0054             <listitem>
0055               Email address, given as a string value
0056               (signature <literal>"s"</literal>).
0057             </listitem>
0058           </varlistentry>
0059           <varlistentry><term><literal>"group"</literal></term>
0060             <listitem>
0061               Group this contact belongs to, given as a string value
0062               (signature <literal>"s"</literal>).
0063             </listitem>
0064           </varlistentry>
0065           <varlistentry><term><literal>"name2"</literal></term>
0066             <listitem>
0067               Additional contact name, given as a string value
0068               (signature <literal>"s"</literal>).
0069             </listitem>
0070           </varlistentry>
0071           <varlistentry><term><literal>"number2"</literal></term>
0072             <listitem>
0073               Additional contact telephone number, given as a string value
0074               (signature <literal>"s"</literal>).
0075             </listitem>
0076           </varlistentry>
0077           <varlistentry><term><literal>"hidden"</literal></term>
0078             <listitem>
0079               Boolean flag to specify whether this entry is hidden or not,
0080               (signature <literal>"b"</literal>).
0081             </listitem>
0082           </varlistentry>
0083           <varlistentry><term><literal>"storage"</literal></term>
0084             <listitem>
0085               Phonebook in which the contact is stored, given as a
0086               <link linkend="MMModemContactsStorage">MMModemContactsStorage</link>,
0087               (signature <literal>"u"</literal>).
0088             </listitem>
0089           </varlistentry>
0090         </variablelist>
0091 
0092         The @index number is an internal private number to ModemManager and does
0093         not correspond to the index of the contact in the modem or SIM itself.
0094     -->
0095     <method name="Add">
0096       <arg name="properties" type="a{sv}" direction="in">
0097         <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
0098       </arg>
0099       <arg name="index"      type="u"     direction="out" />
0100     </method>
0101 
0102     <!--
0103         Delete:
0104         @index: The index of the contact to delete.
0105 
0106         Delete a contact.
0107     -->
0108     <method name="Delete">
0109       <arg name="index" type="u" direction="in" />
0110     </method>
0111 
0112     <!--
0113         Get:
0114         @index: The index of the contact.
0115         @properties: The properties of the contact.
0116 
0117         Retrieve a contact.
0118     -->
0119     <method name="Get">
0120       <arg name="index"      type="u"     direction="in"  />
0121       <arg name="properties" type="a{sv}" direction="out">
0122         <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap"/>
0123       </arg>
0124     </method>
0125 
0126     <!--
0127         List:
0128         @results: An array of dictionaries, each dictionary representing a contact.
0129 
0130         List all contacts.
0131     -->
0132     <method name="List">
0133       <arg name="results" type="aa{sv}" direction="out">
0134         <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMapList"/>
0135       </arg>
0136     </method>
0137 
0138     <!--
0139         Find:
0140         @pattern: The pattern to search for.
0141         @results: An array of dictionaries, each dictionary representing a contact.
0142 
0143         Find a contact.
0144     -->
0145     <method name="Find">
0146       <arg name="pattern" type="s"      direction="in"  />
0147       <arg name="results" type="aa{sv}" direction="out">
0148         <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMapList"/>
0149       </arg>
0150     </method>
0151 
0152     <!--
0153         GetCount:
0154         @count: The number of contacts.
0155 
0156         Get the number of contacts.
0157     -->
0158     <method name="GetCount">
0159       <arg name="count" type="u" direction="out" />
0160     </method>
0161 
0162     <!--
0163         Added:
0164         @index: The index number of the new contact.
0165         @properties: The properties of the contact.
0166 
0167         Emitted when a new contact is added.
0168     -->
0169     <signal name="Added">
0170       <arg name="index"      type="u"     />
0171       <arg name="properties" type="a{sv}">
0172         <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap"/>
0173       </arg>
0174     </signal>
0175 
0176     <!--
0177         Deleted:
0178         @index: The index number of the now deleted contact.
0179 
0180         Emitted when a new contact has been deleted.
0181     -->
0182     <signal name="Deleted">
0183       <arg name="index" type="u" />
0184     </signal>
0185 
0186   </interface>
0187 </node>