1
<?xml version="1.0" encoding="UTF-8" ?>
4
ModemManager 0.6 Interface Specification
6
Copyright (C) 2008 Novell, Inc.
7
Copyright (C) 2008-2011 Red Hat, Inc.
8
Copyright (C) 2011 The Chromium OS Authors
9
Copyright (C) 2011 Google, Inc.
12
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
15
org.freedesktop.ModemManager1.Modem.Contacts:
16
@short_description: The ModemManager Contacts interface.
18
This interface provides access to contacts stored in various locations,
19
including SIM cards, device storage, and other locations. Operations
20
generally operate on all contacts regardless of their actual storage
23
Contacts are referred to by index numbers, which are internal to
24
ModemManager and do not represent indexes of SIM cards or the device.
25
Indexes may not be contiguous.
27
<interface name="org.freedesktop.ModemManager1.Modem.Contacts">
31
@properties: Dictionary of properties describing the contact.
32
@index: The index number of the new contact
36
If any of the property in @properties exceeds the modem's size limit,
37
that property will be truncated to fit.
41
<varlistentry><term><literal>"name"</literal></term>
43
Full name of the contact, given as a string value
44
(signature <literal>"s"</literal>).
47
<varlistentry><term><literal>"number"</literal></term>
49
Telephone number, given as a string value
50
(signature <literal>"s"</literal>).
53
<varlistentry><term><literal>"email"</literal></term>
55
Email address, given as a string value
56
(signature <literal>"s"</literal>).
59
<varlistentry><term><literal>"group"</literal></term>
61
Group this contact belongs to, given as a string value
62
(signature <literal>"s"</literal>).
65
<varlistentry><term><literal>"name2"</literal></term>
67
Additional contact name, given as a string value
68
(signature <literal>"s"</literal>).
71
<varlistentry><term><literal>"number2"</literal></term>
73
Additional contact telephone number, given as a string value
74
(signature <literal>"s"</literal>).
77
<varlistentry><term><literal>"hidden"</literal></term>
79
Boolean flag to specify whether this entry is hidden or not,
80
(signature <literal>"b"</literal>).
83
<varlistentry><term><literal>"storage"</literal></term>
85
Phonebook in which the contact is stored, given as a
86
<link linkend="MMModemContactsStorage">MMModemContactsStorage</link>,
87
(signature <literal>"u"</literal>).
92
The @index number is an internal private number to ModemManager and does
93
not correspond to the index of the contact in the modem or SIM itself.
96
<arg name="properties" type="a{sv}" direction="in" />
97
<arg name="index" type="u" direction="out" />
102
@index: The index of the contact to delete.
106
<method name="Delete">
107
<arg name="index" type="u" direction="in" />
112
@index: The index of the contact.
113
@properties: The properties of the contact.
118
<arg name="index" type="u" direction="in" />
119
<arg name="properties" type="a{sv}" direction="out" />
124
@results: An array of dictionaries, each dictionary representing a contact.
129
<arg name="results" type="aa{sv}" direction="out" />
134
@pattern: The pattern to search for.
135
@results: An array of dictionaries, each dictionary representing a contact.
140
<arg name="pattern" type="s" direction="in" />
141
<arg name="results" type="aa{sv}" direction="out" />
146
@count: The number of contacts.
148
Get the number of contacts.
150
<method name="GetCount">
151
<arg name="count" type="u" direction="out" />
156
@index: The index number of the new contact.
157
@properties: The properties of the contact.
159
Emitted when a new contact is added.
161
<signal name="Added">
162
<arg name="index" type="u" />
163
<arg name="properties" type="a{sv}" />
168
@index: The index number of the now deleted contact.
170
Emitted when a new contact has been deleted.
172
<signal name="Deleted">
173
<arg name="index" type="u" />