Telepathy D-Bus Interface Specification — v0.26.0

# Telepathy D-Bus Interface Specification

Interfaces (Compact) | Generic Types | Errors | Full Index

### Version 0.26.0

- Copyright © 2005-2012 Collabora Limited
- Copyright © 2005-2011 Nokia Corporation
- Copyright © 2006 INdT

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

### Interfaces

- Connection Managers (Permalink)

A Connection Manager is a factory for connections.

- org.freedesktop.Telepathy.ConnectionManager
- org.freedesktop.Telepathy.ConnectionManager.Interface.AccountStorage.DRAFT (unstable)
- org.freedesktop.Telepathy.Protocol
- org.freedesktop.Telepathy.Protocol.Interface.Addressing
- org.freedesktop.Telepathy.Protocol.Interface.Avatars
- org.freedesktop.Telepathy.Protocol.Interface.Presence
- Connection Object (Permalink)

Connections represent active protocol sessions. There are a number of core interfaces which all connections should implement, and a number of optional interfaces which provide various functionality related to contacts and to the connection itself.

- org.freedesktop.Telepathy.Connection
- org.freedesktop.Telepathy.Connection.FUTURE (unstable)
- org.freedesktop.Telepathy.Connection.Interface.Contacts
- org.freedesktop.Telepathy.Connection.Interface.Requests
- Contact list interfaces (Permalink)

On protocols that support contact lists, these interface expose the user's contact lists, along with presence subscription information, contact list groups (if supported), and the ability to block and unblock contacts (if supported).

- org.freedesktop.Telepathy.Connection.Interface.ContactList
- org.freedesktop.Telepathy.Connection.Interface.ContactGroups
- org.freedesktop.Telepathy.Connection.Interface.ContactBlocking

- Contact metadata interfaces (Permalink)

These optional Connection interfaces expose metadata about contacts on this connection—from their current presence through to the type of client they're connected with—and allow the local user to publish such metadata back to their contacts.

- org.freedesktop.Telepathy.Connection.Interface.Aliasing
- org.freedesktop.Telepathy.Connection.Interface.Avatars
- org.freedesktop.Telepathy.Connection.Interface.Capabilities (deprecated)
- org.freedesktop.Telepathy.Connection.Interface.ClientTypes
- org.freedesktop.Telepathy.Connection.Interface.ContactCapabilities
- org.freedesktop.Telepathy.Connection.Interface.ContactInfo
- org.freedesktop.Telepathy.Connection.Interface.Location
- org.freedesktop.Telepathy.Connection.Interface.Presence (deprecated)
- org.freedesktop.Telepathy.Connection.Interface.Renaming (unstable)
- org.freedesktop.Telepathy.Connection.Interface.Resources.DRAFT (unstable)
- org.freedesktop.Telepathy.Connection.Interface.SimplePresence

- Connection feature interfaces (Permalink)

These optional Connection interfaces expose protocol-specific features, and allow configuring the running connection.

- org.freedesktop.Telepathy.Connection.Interface.Addressing1
- org.freedesktop.Telepathy.Connection.Interface.Anonymity
- org.freedesktop.Telepathy.Connection.Interface.Balance
- org.freedesktop.Telepathy.Connection.Interface.Cellular
- org.freedesktop.Telepathy.Connection.Interface.CommunicationPolicy.DRAFT (unstable)
- org.freedesktop.Telepathy.Connection.Interface.Forwarding.DRAFT (unstable)
- org.freedesktop.Telepathy.Connection.Interface.Keepalive.DRAFT (unstable)
- org.freedesktop.Telepathy.Connection.Interface.MailNotification
- org.freedesktop.Telepathy.Connection.Interface.PowerSaving
- org.freedesktop.Telepathy.Connection.Interface.ServicePoint

- org.freedesktop.Telepathy.ChannelBundle.DRAFT (unstable)
- Channel Object (Permalink)

A Channel is used by Telepathy to exchange data between local applications and remote servers. A given connection will have many channels, each one represented by a D-Bus object.

Each Channel has a type, represented by a D-Bus interface, and may implement one or more additional interfaces from the list of channel interfaces below.

- org.freedesktop.Telepathy.Channel
- org.freedesktop.Telepathy.Channel.FUTURE (unstable)
- Channel Types (Permalink)

Each Channel implements one of the following types:

- org.freedesktop.Telepathy.Channel.Type.Call1
- org.freedesktop.Telepathy.Channel.Type.ContactList (deprecated)
- org.freedesktop.Telepathy.Channel.Type.ContactSearch
- org.freedesktop.Telepathy.Channel.Type.DBusTube
- org.freedesktop.Telepathy.Channel.Type.FileTransfer
- org.freedesktop.Telepathy.Channel.Type.RoomList
- org.freedesktop.Telepathy.Channel.Type.ServerAuthentication
- org.freedesktop.Telepathy.Channel.Type.ServerTLSConnection
- org.freedesktop.Telepathy.Channel.Type.StreamTube
- org.freedesktop.Telepathy.Channel.Type.StreamedMedia
- org.freedesktop.Telepathy.Channel.Type.Text
- org.freedesktop.Telepathy.Channel.Type.Tubes (deprecated)

- Channel interfaces (Permalink)

A Channel may also implement one or more of the following interfaces, depending on its type. Some interfaces are only applicable to particular channel types, while others may (in principle) appear on any type of channel.

- org.freedesktop.Telepathy.Channel.Interface.Addressing1 (unstable)
- org.freedesktop.Telepathy.Channel.Interface.Anonymity
- org.freedesktop.Telepathy.Channel.Interface.Destroyable
- org.freedesktop.Telepathy.Channel.Interface.FileTransfer.Metadata
- org.freedesktop.Telepathy.Channel.Interface.Group
- org.freedesktop.Telepathy.Channel.Interface.Password
- org.freedesktop.Telepathy.Channel.Interface.Room2
- org.freedesktop.Telepathy.Channel.Interface.RoomConfig1
- org.freedesktop.Telepathy.Channel.Interface.SASLAuthentication
- org.freedesktop.Telepathy.Channel.Interface.CaptchaAuthentication1
- org.freedesktop.Telepathy.Channel.Interface.CredentialsStorage.DRAFT (unstable)
- org.freedesktop.Telepathy.Channel.Interface.Securable
- org.freedesktop.Telepathy.Channel.Interface.ServicePoint
- org.freedesktop.Telepathy.Channel.Interface.Subject2
- org.freedesktop.Telepathy.Channel.Interface.Picture1 (unstable)
- org.freedesktop.Telepathy.Channel.Interface.Tube
- Text-specific interfaces (Permalink)

These interfaces may only appear on channels of type Text.

- org.freedesktop.Telepathy.Channel.Interface.ChatState
- org.freedesktop.Telepathy.Channel.Interface.HTML.DRAFT (unstable)
- org.freedesktop.Telepathy.Channel.Interface.Messages
- org.freedesktop.Telepathy.Channel.Interface.SMS

- Streamed Media/Call-related interfaces (Permalink)

These interfaces are only applicable to channels of type StreamedMedia, with the exception of the Hold and DTMF interfaces, which may also appear on Call1 channels.

- org.freedesktop.Telepathy.Channel.Interface.CallState
- org.freedesktop.Telepathy.Channel.Interface.DTMF
- org.freedesktop.Telepathy.Channel.Interface.Hold
- org.freedesktop.Telepathy.Channel.Interface.MediaSignalling

- Conference-related interfaces (Permalink)

These interfaces provide functionality for ad-hoc conference calls and chat rooms. They are primarily intended for Text, StreamedMedia and Call1 channels, but may also appear on other types of channel.

- org.freedesktop.Telepathy.Channel.Interface.Conference
- org.freedesktop.Telepathy.Channel.Interface.Splittable.DRAFT (unstable)
- org.freedesktop.Telepathy.Channel.Interface.MergeableConference.DRAFT (unstable)

- Authentication Objects (Permalink)

A set of objects to be used for authentication purposes, such as TLS certificates or handshakes for negotiating end-to-end security.

- org.freedesktop.Telepathy.Authentication.TLSCertificate

- Media (Permalink)

- org.freedesktop.Telepathy.Media.SessionHandler
- org.freedesktop.Telepathy.Media.StreamHandler

- Calls (Permalink)

- org.freedesktop.Telepathy.Call1.Content
- org.freedesktop.Telepathy.Call1.Content.Interface.DTMF
- org.freedesktop.Telepathy.Call1.Stream
- org.freedesktop.Telepathy.Call1.Interface.Mute (unstable)

- Call media interfaces (Permalink)

These interfaces are used when a Call1 channel doesn't have HardwareStreaming to implement the media streaming aspects of a call.

- org.freedesktop.Telepathy.Call1.Content.Interface.Media
- org.freedesktop.Telepathy.Call1.Content.Interface.VideoControl
- org.freedesktop.Telepathy.Call1.Content.Interface.AudioControl
- org.freedesktop.Telepathy.Call1.Content.MediaDescription
- org.freedesktop.Telepathy.Call1.Content.MediaDescription.Interface.RTPHeaderExtensions
- org.freedesktop.Telepathy.Call1.Content.MediaDescription.Interface.RTCPFeedback
- org.freedesktop.Telepathy.Call1.Content.MediaDescription.Interface.RTCPExtendedReports
- org.freedesktop.Telepathy.Call1.Stream.Interface.Media
- org.freedesktop.Telepathy.Call1.Stream.Endpoint

- Debugging (Permalink)

- org.freedesktop.Telepathy.Debug

- The Account Manager (Permalink)

The Account Manager is a desktop service that provides account configuration and can manage the connection managers. In general, clients will use the account manager to find out about instant messaging accounts and their associated connections.

- org.freedesktop.Telepathy.AccountManager
- org.freedesktop.Telepathy.AccountManager.Interface.Hidden.DRAFT1 (unstable)
- org.freedesktop.Telepathy.Account
- org.freedesktop.Telepathy.Account.Interface.Addressing
- org.freedesktop.Telepathy.Account.Interface.Avatar
- org.freedesktop.Telepathy.Account.Interface.Hidden.DRAFT1 (unstable)
- org.freedesktop.Telepathy.Account.Interface.Storage
- org.freedesktop.Telepathy.Account.Interface.ExternalPasswordStorage.DRAFT (unstable)

- The Channel Dispatcher (Permalink)

The Channel Dispatcher is a desktop service whose purpose is to dispatch incoming Telepathy Channels to the appropriate client (e.g. incoming text chat, file transfer, tubes, etc.).

- org.freedesktop.Telepathy.ChannelDispatcher
- org.freedesktop.Telepathy.ChannelDispatcher.Interface.OperationList
- org.freedesktop.Telepathy.ChannelDispatchOperation
- org.freedesktop.Telepathy.ChannelRequest

- Clients (Permalink)

Clients should implement one or more of these interfaces to be able to handle channels coming in from the Channel Dispatcher.

- org.freedesktop.Telepathy.Client
- org.freedesktop.Telepathy.Client.Observer
- org.freedesktop.Telepathy.Client.Approver
- org.freedesktop.Telepathy.Client.Handler
- org.freedesktop.Telepathy.Client.Handler.FUTURE (unstable)
- org.freedesktop.Telepathy.Client.Interface.Requests
- org.freedesktop.Telepathy.ChannelHandler (deprecated)

- org.freedesktop.Telepathy.Properties (deprecated)

### Other

- Generic Types
- Errors