api: refine new API based on suggestions from Eric Shienbrood
This commit is contained in:
@@ -3,6 +3,15 @@
|
||||
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
|
||||
<interface name="org.freedesktop.ModemManager1.Modem.Contacts">
|
||||
|
||||
<tp:docstring>
|
||||
This interface provides access to contacts stored in various locations,
|
||||
including SIM cards, device storage, and other locations. Operations
|
||||
generally operate on all contacts regardless of their actual storage
|
||||
location. Contacts are referred to by index numbers, which are internal
|
||||
to ModemManager and do not represent indexs of SIM cards or the device.
|
||||
Indexes may not be contiguous.
|
||||
</tp:docstring>
|
||||
|
||||
<method name="Add">
|
||||
<tp:docstring>
|
||||
Add a new contact.
|
||||
@@ -50,7 +59,7 @@
|
||||
|
||||
<method name="Get">
|
||||
<tp:docstring>
|
||||
Retrieve a contact from the SIM card.
|
||||
Retrieve a contact.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_contacts_get"/>
|
||||
@@ -82,7 +91,7 @@
|
||||
|
||||
<method name="Find">
|
||||
<tp:docstring>
|
||||
Find a contact from the SIM card.
|
||||
Find a contact.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_contacts_find"/>
|
||||
@@ -101,7 +110,7 @@
|
||||
|
||||
<method name="GetCount">
|
||||
<tp:docstring>
|
||||
Get the number of contacts stored on the SIM card.
|
||||
Get the number of contacts.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_contacts_count"/>
|
||||
@@ -112,6 +121,36 @@
|
||||
</arg>
|
||||
</method>
|
||||
|
||||
<!-- SIGNALS -->
|
||||
|
||||
<signal name="Added">
|
||||
<tp:docstring>
|
||||
Emitted when a new contact is added.
|
||||
</tp:docstring>
|
||||
<arg name="index" type="u">
|
||||
<tp:docstring>
|
||||
The index number of the new contact.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
<arg name="properties" type="a{sv}">
|
||||
<tp:docstring>
|
||||
The properties of the contact including those properties defined by
|
||||
the Add method.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</signal>
|
||||
|
||||
<signal name="Deleted">
|
||||
<tp:docstring>
|
||||
Emitted when a contact has been deleted.
|
||||
</tp:docstring>
|
||||
<arg name="index" type="u">
|
||||
<tp:docstring>
|
||||
Index number of the now deleted contact.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</signal>
|
||||
|
||||
<!-- ENUMS -->
|
||||
|
||||
<tp:enum name="MM_MODEM_CONTACTS_STORAGE" type="u">
|
||||
|
||||
Reference in New Issue
Block a user