Methods
| GetContactsByVCardField | (s: Field, as: Addresses, as: Interfaces) | → | a{ua{sv}}: Requested_Contacts | |
| GetContactsByURI | (as: URIs, as: Interfaces) | → | a{ua{sv}}: Requested_Contacts |
Contact Attributes
Types
| VCard_Field_Address_Map | Mapping | a{ss} | |
| Requested_Address | Struct | (ss) |
Description
This interface deals with the multiple address types that can refer to the same contact, such as vCard fields and URIs.
It can be used to retrieve contacts with a specific addresses through GetContactsByVCardField and GetContactsByURI, as well as defining the various addressing methods for a given contact through this interface's contact attributes.
Methods
GetContactsByVCardField (s: Field, as: Addresses, as: Interfaces) → a{ua{sv}}: Requested_Contacts
Parameters
- Field — s
- Addresses — as
- Interfaces — as (DBus_Interface_List)
The vCard field of the addresses we are requesting. The field name SHOULD be in lower case. Supported fields can be found in AddressableVCardFields.
The url vCard field MUST NOT appear here; see
GetContactsByURI instead.
Rationale:
In practice, protocols have a limited set of URI schemes that make sense to resolve as a contact.
A list of strings indicating which D-Bus interfaces the calling process is interested in. All supported attributes from these interfaces, whose values can be obtained without additional network activity, will be in the reply.
Attributes from this interface and from org.freedesktop.Telepathy.Connection are always returned, and need not be requested explicitly.
The behavior of this parameter is similar to the same parameter in Contacts.GetContactAttributes.
Returns
- Requested_Contacts — a{ua{sv}} (Contact_Attributes_Map)
A dictionary mapping the contact handles to contact attributes. If any of the requested addresses are in fact invalid, they are simply omitted from this mapping. If contact attributes are not immediately known, the behaviour is defined by the interface; the attribute should either be omitted from the result or replaced with a default value.
Requested addresses that cannot be satisfied MUST be ommitted from the mapping.
Each contact's attributes will always include at least the
identifier that would be obtained by inspecting the handle
(org.freedesktop.Telepathy.Connection/contact-id),
and the vCard field used for requesting the contact in
org.freedesktop.Telepathy.Connection.Interface.ContactInfo/info.
Request contacts and retrieve their attributes using a given field in their vCards.
The connection manager should record that these handles are in use by the client who invokes this method, and must not deallocate the handles until the client disconnects from the bus or calls the Connection.ReleaseHandles method.
Possible Errors
- Disconnected
Rationale:
GetContactsByURI (as: URIs, as: Interfaces) → a{ua{sv}}: Requested_Contacts
Parameters
- URIs — as
- Interfaces — as (DBus_Interface_List)
A list of strings indicating which D-Bus interfaces the calling process is interested in. All supported attributes from these interfaces, whose values can be obtained without additional network activity, will be in the reply.
Attributes from this interface and from org.freedesktop.Telepathy.Connection are always returned, and need not be requested explicitly.
The behavior of this parameter is similar to the same parameter in Contacts.GetContactAttributes.
Returns
- Requested_Contacts — a{ua{sv}} (Contact_Attributes_Map)
A dictionary mapping the contact handles to contact attributes. If any of the requested addresses are in fact invalid, they are simply omitted from this mapping. If contact attributes are not immediately known, the behaviour is defined by the interface; the attribute should either be omitted from the result or replaced with a default value.
Requested URIs that cannot be satisfied MUST be ommitted from the mapping.
Each contact's attributes will always include at least the
identifier that would be obtained by inspecting the handle
(org.freedesktop.Telepathy.Connection/contact-id).
Request contacts and retrieve their attributes using URI addresses.
The connection manager should record that these handles are in use by the client who invokes this method, and must not deallocate the handles until the client disconnects from the bus or calls the Connection.ReleaseHandles method.
Possible Errors
- Disconnected
Rationale:
Contact Attributes
org.freedesktop.Telepathy.Connection.Interface.Addressing.DRAFT/addresses — a{ss} (VCard_Field_Address_Map)
org.freedesktop.Telepathy.Connection.Interface.Addressing.DRAFT/uris — as
org.freedesktop.Telepathy.Connection.Interface.Addressing.DRAFT/requested-address — (ss) (Requested_Address)
The contact's address, as it was requested through GetContactsByVCardField. This attribute MUST be ommitted if the contact was not retrieved through GetContactsByVCardField.
Rationale:
When retrieving more than one contact through GetContactsByVCardField, there needs to be a way to map the given contact back o the original request.
org.freedesktop.Telepathy.Connection.Interface.Addressing.DRAFT/requested-uri — s
The contact's URI, as it was requested through GetContactsByURI. This attribute MUST be ommitted if the contact was not retrieved through GetContactsByURI.
Rationale:
When retrieving more than one contact through GetContactsByURI, there needs to be a way to map the given contact back o the original request.
Types
VCard_Field_Address_Map — a{ss}
A mapping of vCard fields and addresses that repreent the given contact.
- VCard_Field — s
- Address — s
Requested_Address — (ss)
- Field — s
- Address — s