Methods
| UpdateCapabilities | (a(saa{sv}as): Handler_Capabilities) | → | nothing | |
| GetContactCapabilities | (au: handles) | → | a{ua(a{sv}as)}: Contact_Capabilities |
Signals
| ContactCapabilitiesChanged | (a{ua(a{sv}as)}: caps) |
Contact Attributes
| org.freedesktop.Telepathy.Connection.Interface.ContactCapabilities/capabilities | a(a{sv}as) (Requestable_Channel_Class_List) |
Types
| Contact_Capabilities_Map | Mapping | a{ua(a{sv}as)} | |
| Handler_Capabilities | Struct | (saa{sv}as) |
Description
Contact capabilities describe the channel classes which may be created with a given contact in advance of attempting to create a channel. Each capability represents a commitment by the connection manager that it will ordinarily be able to create a channel with a contact when given a request with the properties defined by the channel class.
Capabilities pertain to particular contact handles, and represent activities such as having a text chat, a voice call with the user or a stream tube of a defined type.
This interface also enables user interfaces to notify the connection manager what capabilities to advertise for the user to other contacts. This is done by using the UpdateCapabilities method.
XMPP is a major user of this interface: XMPP contacts will not, in general, be callable using VoIP unless they advertise suitable Jingle capabilities.
Many other protocols also have some concept of capability flags, which this interface exposes in a protocol-independent way.
Methods
UpdateCapabilities (a(saa{sv}as): Handler_Capabilities) → nothing
Parameters
- Handler_Capabilities — a(saa{sv}as) (Handler_Capabilities_List)
The capabilities of one or more clients.
For each client in the given list, any capabilities previously advertised for the same client name are discarded, then replaced by the capabilities indicated.
As a result, if a client becomes unavailable, this method SHOULD be called with a Handler_Capabilities structure containing its name, an empty list of channel classes, and an empty list of capabilities. When this is done, the connection manager SHOULD free all memory associated with that client name.
This method takes a list of clients so that when the channel dispatcher first calls it (with a list of all the Handlers that are initially available), the changes can be made atomically, with only one transmission of updated capabilities to the network. Afterwards, the channel dispatcher will call this method with a single-element list every time a Handler becomes available or unavailable.
The connection manager MUST ignore any channel classes and client capabilities for which there is no representation in the protocol or no support in the connection manager.
Alter the connection's advertised capabilities to include the intersection of the given clients' capabilities with what the connection manager is able to implement.
On connections managed by the ChannelDispatcher, processes other than the ChannelDispatcher SHOULD NOT call this method, and the ChannelDispatcher SHOULD use this method to advertise the capabilities of all the registered Client.Handler implementations.On connections not managed by the ChannelDispatcher, clients MAY use this method directly, to indicate the channels they will handle and the extra capabilities they have.
Upon a successful invocation of this method, the connection manager will only emit the ContactCapabilitiesChanged signal for the user's SelfHandle if, in the underlying protocol, the new capabilities are distinct from the previous state.
The connection manager will essentially intersect the provided capabilities and the channel classes it implements. Therefore, certain properties which are never fixed for a channel class (such as the target handle, or the Parameters property of a tube channel) will almost certainly not be advertised.
This method MAY be called on a newly-created connection while it is still in the DISCONNECTED state, to request that when the connection connects, it will do so with the appropriate capabilities. Doing so MUST NOT fail.
Possible Errors
- Network Error
GetContactCapabilities (au: handles) → a{ua(a{sv}as)}: Contact_Capabilities
Parameters
- handles — au (Contact_Handle_List)
An array of contact handles for this connection.
The handle zero MUST NOT be included in the request.
Returns
- Contact_Capabilities — a{ua(a{sv}as)} (Contact_Capabilities_Map)
- a dictionary mapping the channel properties to their values.
- an array of additional allowed properties
Possible Errors
- Disconnected
- Invalid Handle
Signals
ContactCapabilitiesChanged (a{ua(a{sv}as)}: caps)
Parameters
- caps — a{ua(a{sv}as)} (Contact_Capabilities_Map)
Announce that there has been a change of capabilities on the given handles. A single signal can be emitted for several contacts.
The underlying protocol can get several contacts' capabilities at the same time.
Contact Attributes
org.freedesktop.Telepathy.Connection.Interface.ContactCapabilities/capabilities — a(a{sv}as) (Requestable_Channel_Class_List)
The same structs that would be returned by GetContactCapabilities. Omitted from the result if the contact's capabilities are not known; present in the result as an empty array if the contact is known to have no capabilities at all.
Types
Contact_Capabilities_Map — a{ua(a{sv}as)}
- Key — u (Contact_Handle)
- Value — a(a{sv}as) (Requestable_Channel_Class_List)
Handler_Capabilities — (saa{sv}as)
- Well_Known_Name — s (DBus_Well_Known_Name)
- Channel_Classes — aa{sv} (String_Variant_Map_List)
- Capabilities — as (Handler_Capability_Token_List)