org.freedesktop.ModemManager1.Modem.Contacts

org.freedesktop.ModemManager1.Modem.Contacts — The ModemManager Contacts interface.

Methods

Add      (IN  a{sv}  properties,
          OUT u      index);
Delete   (IN  u      index);
Get      (IN  u      index,
          OUT a{sv}  properties);
List     (OUT aa{sv} results);
Find     (IN  s      pattern,
          OUT aa{sv} results);
GetCount (OUT u      count);

Signals

Added   (u     index,
         a{sv} properties);
Deleted (u     index);

Description

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 indexes of SIM cards or the device. Indexes may not be contiguous.

Method Details

The Add() method

Add (IN  a{sv} properties,
     OUT u     index);

Add a new contact.

If any of the property in properties exceeds the modem's size limit, that property will be truncated to fit.

Known properties are:

`"name"`	Full name of the contact, given as a string value (signature `"s"`).
`"number"`	Telephone number, given as a string value (signature `"s"`).
`"email"`	Email address, given as a string value (signature `"s"`).
`"group"`	Group this contact belongs to, given as a string value (signature `"s"`).
`"name2"`	Additional contact name, given as a string value (signature `"s"`).
`"number2"`	Additional contact telephone number, given as a string value (signature `"s"`).
`"hidden"`	Boolean flag to specify whether this entry is hidden or not, (signature `"b"`).
`"storage"`	Phonebook in which the contact is stored, given as a MMModemContactsStorage, (signature `"u"`).

The index number is an internal private number to ModemManager and does not correspond to the index of the contact in the modem or SIM itself.

`IN a{sv} properties`:	Dictionary of properties describing the contact.
`OUT u index`:	The index number of the new contact

The Delete() method

Delete (IN  u index);

Delete a contact.

IN u index:

The index of the contact to delete.

The Get() method

Get (IN  u     index,
     OUT a{sv} properties);

Retrieve a contact.

`IN u index`:	The index of the contact.
`OUT a{sv} properties`:	The properties of the contact.

The List() method

List (OUT aa{sv} results);

List all contacts.

OUT aa{sv} results:

An array of dictionaries, each dictionary representing a contact.

The Find() method

Find (IN  s      pattern,
      OUT aa{sv} results);

Find a contact.

`IN s pattern`:	The pattern to search for.
`OUT aa{sv} results`:	An array of dictionaries, each dictionary representing a contact.

The GetCount() method

GetCount (OUT u count);

Get the number of contacts.

OUT u count:

The number of contacts.

Signal Details

The "Added" signal

Added (u     index,
       a{sv} properties);

Emitted when a new contact is added.

`u index`:	The index number of the new contact.
`a{sv} properties`:	The properties of the contact.

The "Deleted" signal

Deleted (u index);

Emitted when a new contact has been deleted.

u index:

The index number of the now deleted contact.

			ModemManager Reference Manual
Top \| Description \| Signals