Telepathy D-Bus Interface Specification

Version 0.17.9

Copyright (C) 2005-2008 Collabora Limited
Copyright (C) 2005-2008 Nokia Corporation
Copyright (C) 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

org.freedesktop.Telepathy.ConnectionManager

A D-Bus service which allows connections to be created. The manager processes are intended to be started by D-Bus service activation.

For service discovery, each Telepathy connection manager must have a connection manager name (see Connection_Manager_Name for syntax).

The connection manager must then provide a well-known bus name of org.freedesktop.Telepathy.ConnectionManager.cmname where cmname is its connection manager name. If it makes sense to start the connection manager using D-Bus service activation, it must register that well-known name for service activation by installing a .service file.

Clients can list the running connection managers by calling the ListNames method on the D-Bus daemon's org.freedesktop.DBus interface and looking for names matching the above pattern; they can list the activatable connection managers by calling ListActivatableNames, and they should usually combine the two lists to get a complete list of running or activatable connection managers.

When the connection manager is running, it must have an object implementing the ConnectionManager interface at the object path /org/freedesktop/Telepathy/ConnectionManager/cmname.

Connection managers' capabilities can be determined dynamically by calling their ListProtocols method, then for each protocol of interest, calling GetParameters to discover the required and optional parameters. However, since it is inefficient to activate all possible connection managers on the system just to find out what they can do, there is a standard mechanism to store static information about CMs in ".manager files".

To look up a connection manager's supported protocols, clients should search the data directories specified by the freedesktop.org XDG Base Directory Specification ($XDG_DATA_HOME, defaulting to $HOME/.local/share if unset, followed by colon-separated paths from $XDG_DATA_DIRS, defaulting to /usr/local/share:/usr/share if unset) for the first file named telepathy/managers/cmname.manager that can be read without error. This file has the same syntax as a freedesktop.org Desktop Entry file.

Clients must still support connection managers for which no .manager file can be found, which they can do by activating the connection manager and calling its methods; the .manager file is merely an optimization. Connection managers whose list of protocols can change at any time (for instance, via a plugin architecture) should not install a .manager file.

For each protocol name proto that would be returned by ListProtocols, the .manager file contains a group headed [Protocol proto]. For each parameter p that would be returned by GetParameters(proto), the .manager file contains a key param-p with a value consisting of a D-Bus signature (a single complete type), optionally followed by a space and a space-separated list of flags. The supported flags are:

The group may also contain a key default-p whose value is a string form of the default value for the parameter. If this key exists, it sets the default, and also sets the flag Conn_Mgr_Param_Flag_Has_Default. The default value is formatted according to the D-Bus signature as follows:

s (string)
The UTF-8 string
o (object path)
The object path as an ASCII string
b (boolean)
"true" (case-insensitively) or "1" means True, "false" (case-insensitively) or "0" means False
q, u, t (16-, 32-, 64-bit unsigned integer)
ASCII decimal integer
n, i, x (16-, 32-, 64-bit signed integer)
ASCII decimal integer, optionally prefixed with "-"
d (double-precision floating point)
ASCII decimal number

Currently, no other D-Bus signatures are allowed to have default values, but clients parsing the .manager file MUST ignore defaults that they cannot parse, and treat them as if the default-p key was not present at all.

It is not required that a connection manager be able to support multiple protocols, or even multiple connections. When a connection is made, a service name where the connection object can be found is returned. A manager which can only make one connection may then remove itself from its well-known bus name, causing a new connection manager to be activated when somebody attempts to make a new connection.

Changed in version 0.17.2: Prior to version 0.17.2, support for CMs with no .manager file was not explicitly required.

Methods:

GetParameters ( s: proto ) → a(susv)

Get a list of the parameters which must or may be provided to the RequestConnection method when connecting to the given protocol, or registering (the boolean "register" parameter is available, and set to true).

Parameters

protos (Protocol)
The required protocol name

Returns

a(susv) (Param_Spec[])
An array of structs representing possible parameters.

Possible errors

org.freedesktop.Telepathy.Error.NotImplemented
Raised when the requested method, channel, etc is not available on this connection. (generic description)

ListProtocols ( ) → as

Get a list of protocol identifiers that are implemented by this connection manager.

Returns

as (Protocol[])
A array of string protocol identifiers supported by this manager

RequestConnection ( s: proto, a{sv}: parameters ) → s, o

Request a Connection object representing a given account on a given protocol with the given parameters. The method returns the bus name and the object path where the new Connection object can be found, which should have the status of Connection_Status_Disconnected, to allow signal handlers to be attached before connecting is started with the Connect method.

In order to allow Connection objects to be discovered by new clients, the object path and well-known bus name must be of the form /org/freedesktop/Telepathy/Connection/cmname/proto/account and org.freedesktop.Telepathy.Connection.cmname.proto.account where:

Clients MUST NOT attempt to parse the account part of the bus name. Connection managers MAY use any unique string for this part.

The parameters which must and may be provided in the parameters dictionary can be discovered with the GetParameters method. These parameters, their types, and their default values may be cached in files so that all available connection managers do not need to be started to discover which protocols are available.

To request values for these parameters from the user, a client must have prior knowledge of the meaning of the parameter names, so the following well-known names and types should be used where appropriate:

s:account
The identifier for the user's account on the server
s:server
A fully qualified domain name or numeric IPv4 or IPv6 address. Using the fully-qualified domain name form is recommended whenever possible. If this parameter is specified and the account for that protocol also specifies a server, this parameter should override that in the user id.
q:port
A TCP or UDP port number. If this parameter is specified and the account for that protocol also specifies a port, this parameter should override that in the account.
s:password
A password associated with the account.
b:require-encryption
Require encryption for this connection. A connection should fail to connect if require-encryption is set and an encrypted connection is not possible.
b:register
This account should be created on the server if it does not already exist.
s:ident
The local username to report to the server if necessary, such as in IRC.
s:fullname
The user's full name if the service requires this when authenticating or registering.
s:stun-server
The IP address or FQDN of a STUN server to use for NAT traversal, without any ":port" suffix.
q:stun-port
The UDP port number on the stun-server to use for STUN. Only significant if the stun-server is also supplied.

Every successful RequestConnection call will cause the emission of a NewConnection signal for the same newly created connection. The requester can use the returned object path and service name independently of the emission of that signal. In that case this signal emission is most useful for, e.g. other processes that are monitoring the creation of new connections.

Parameters

protos (Protocol)
The protocol identifier
parametersa{sv} (String_Variant_Map)
A dictionary mapping parameter name to the variant boxed value

Returns

s (DBus_Bus_Name)
A D-Bus service name where the new Connection object can be found
o
The D-Bus object path to the Connection on this service

Possible errors

org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotImplemented
Raised when the requested method, channel, etc is not available on this connection. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)

Signals:

NewConnection ( s: bus_name, o: object_path, s: proto )

Emitted when a new Connection object is created.

Parameters

bus_names (DBus_Bus_Name)
The D-Bus service where the connection object can be found
object_patho
The object path of the Connection object on this service
protos (Protocol)
The identifier for the protocol this connection uses

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

Interfacesas, read-only

A list of the extra interfaces provided by this connection manager (i.e. extra functionality that can be provided even before a connection has been created).

No interfaces suitable for listing in this property are currently defined; it's provided as a hook for possible future functionality.

To be compatible with older connection managers, if retrieving this property fails, clients SHOULD assume that its value is an empty list.

Added in version 0.17.8.

Simple types

Connection_Manager_Name − s

The name of a connection manager, found in its well-known bus name and object path. This must be a non-empty string of ASCII letters, digits and underscores, starting with a letter. This is typically the name of the executable with any "telepathy-" prefix removed, and any hyphen/minus signs replaced by underscores.

Connection manager names SHOULD NOT be the same as the name of the protocol they implement.

This is likely to lead to conflicts between different implementations of the same protocol (or indeed inability to distinguish between the different implementations!). The Telepathy project traditionally uses some sort of pun (Haze is based on libpurple, Salut implements a protocol often called Bonjour, and Wilde implements the OSCAR protocol).

Connection manager names SHOULD NOT be the same as the name of a library on which they are based.

We often abbreviate, for instance, telepathy-haze as "Haze", but abbreviating telepathy-sofiasip to "Sofia-SIP" would cause confusion between the connection manager and the library it uses. Please don't repeat that mistake.

Changed in version 0.17.1: Prior to version 0.17.1, the allowed characters were not specified

Protocol − s

An instant messaging protocol. It must consist only of ASCII letters, digits and hyphen/minus signs (U+002D "-"), and must start with a letter. Where possible, this SHOULD be chosen from the following well-known values:

Changed in version 0.17.1: Prior to version 0.17.1, the allowed characters were not specified

Sets of flags:

Conn_Mgr_Param_Flags

Conn_Mgr_Param_Flag_Required = 1
This parameter is required for connecting to the server.
Conn_Mgr_Param_Flag_Register = 2
This parameter is required for registering an account on the server.
Conn_Mgr_Param_Flag_Has_Default = 4
This parameter has a default value, which is returned in GetParameters; not providing this parameter is equivalent to providing the default.
Conn_Mgr_Param_Flag_Secret = 8

This parameter should be considered private or secret; for instance, clients should store it in a "password safe" like gnome-keyring or kwallet, omit it from debug logs, and use a text input widget that hides the value of the parameter.

(Clients that support older connection managers may also treat any parameter whose name contains "password" as though it had this flag.)

Added in version 0.17.2.

Structure types

Param_Spec − ( s: Name, u: Flags, s: Signature, v: Default_Value )

A struct representing an allowed parameter, as returned by GetParameters on the ConnectionManager interface.

In bindings that need a separate name, arrays of Param_Spec should be called Param_Spec_List.

Members

Names
A string parameter name
Flagsu (Conn_Mgr_Param_Flags)
A bitwise OR of the parameter flags
Signatures (DBus_Signature)
A string containing the D-Bus type signature for this parameter
Default_Valuev
The default value (if the Has_Default flag is not present, there is no default and this takes some dummy value, which SHOULD be of the appropriate D-Bus type)

org.freedesktop.Telepathy.Connection

This models a connection to a single user account on a communication service. Its basic capability is to provide the facility to request and receive channels of differing types (such as text channels or streaming media channels) which are used to carry out further communication.

As well as the methods and signatures below, arbitrary interfaces may be provided by the Connection object to represent extra connection-wide functionality, such as the Connection.Interface.Presence for receiving and reporting presence information, and Connection.Interface.Aliasing for connections where contacts may set and change an alias for themselves. These interfaces can be discovered using the GetInterfaces method.

Contacts, rooms, and server-stored lists (such as subscribed contacts, block lists, or allow lists) on a service are all represented by immutable handles, which are unsigned non-zero integers which are valid only for the lifetime of the connection object, and are used throughout the protocol where these entities are represented, allowing simple testing of equality within clients.

Zero as a handle value is sometimes used as a "null" value to mean the absence of a contact, room, etc.

Handles have per-type uniqueness, meaning that every (handle type, handle number) tuple is guaranteed to be unique within a connection and that a handle alone (without its type) is meaningless or ambiguous. Connection manager implementations should reference count these handles to determine if they are in use either by any active clients or any open channels, and may deallocate them when this ceases to be true. Clients may request handles of a given type and name with the RequestHandles method, inspect the entity name of handles with the InspectHandles method, keep handles from being released with HoldHandles, and notify that they are no longer storing handles with ReleaseHandles.

Methods:

Connect ( ) → nothing

Request that the connection be established. This will be done asynchronously and errors will be returned by emitting StatusChanged signals.

Possible errors

org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)

Disconnect ( ) → nothing

Request that the connection be closed. This closes the connection if it's not already in DISCONNECTED state, and destroys the connection object.

GetInterfaces ( ) → as

Get the optional interfaces supported by this connection. Before the connection status changes to CONNECTED, the return from this method may change at any time, but it is guaranteed that interfaces will only be added, not removed. After the connection status changes to CONNECTED, the return from this method cannot change further.

There is no explicit change notification; reasonable behaviour for a client would be to retrieve the interfaces list once initially, and once more when it becomes CONNECTED.

In some connection managers, certain capabilities of a connection are known to be implemented for all connections (e.g. support for SimplePresence), and some interfaces (like SimplePresence) can even be used before connecting. Other capabilities may or may not exist, depending on server functionality; by the time the connection goes CONNECTED, the connection manager is expected to have evaluated the server's functionality and enabled any extra interfaces for the remainder of the Connection's lifetime.

Returns

as (DBus_Interface[])
An array of D-Bus interface names

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
Before version 0.17.8 calling GetInterfaces while on a connection that is not yet CONNECTED wasn't allowed. If a CM returns this error, its list of interfaces should be regarded as empty until it becomes CONNECTED.

GetProtocol ( ) → s

Get the protocol this connection is using.

Returns

s (Protocol)
A string identifier for the protocol

GetSelfHandle ( ) → u

Get the handle which represents the user on this connection, which will remain valid for the lifetime of this connection, or until a change in the user's identifier is signalled by the Renamed signal on the Renaming interface (if present).

Returns

u (Contact_Handle)
An integer handle representing the user

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)

GetStatus ( ) → u

Get the current status as defined in the StatusChanged signal.

Returns

u (Connection_Status)
An integer representing the current status

HoldHandles ( u: handle_type, au: handles ) → nothing

Notify the connection manger that your client is holding a copy of handles which may not be in use in any existing channel or list, and were not obtained by using the RequestHandles method. For example, a handle observed in an emitted signal, or displayed somewhere in the UI that is not associated with a channel. The connection manager must not deallocate a handle where any clients have used this method to indicate it is in use until the ReleaseHandle method is called, or the clients disappear from the bus.

Note that HoldHandles is idempotent - calling it multiple times is equivalent to calling it once. If a handle is "referenced" by several components which share a D-Bus unique name, the client should perform reference counting internally, and only call ReleaseHandles when none of the cooperating components need the handle any longer.

Parameters

handle_typeu (Handle_Type)
The type of handle to be held
handlesau (Handle[])
A array of integer handles to hold

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)

InspectHandles ( u: handle_type, au: handles ) → as

Return a string representation for a number of handles of a given type.

Parameters

handle_typeu (Handle_Type)
The type of handle to be inspected
handlesau (Handle[])
An array of integer handles of this type

Returns

as
An array of handle names in the same order as the given numbers

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)

ListChannels ( ) → a(osuu)

List all the channels which currently exist on this connection.

Returns

a(osuu) (Channel_Info[])
An array of structs representing channels.

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)

ReleaseHandles ( u: handle_type, au: handles ) → nothing

Explicitly notify the connection manager that your client is no longer holding any references to the given handles, and that they may be deallocated if they are not held by any other clients or referenced by any existing channels. See HoldHandles for notes.

Parameters

handle_typeu (Handle_Type)
An integer handle type (as defined in RequestHandle)
handlesau (Handle[])
An array of integer handles being held by the client

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
The handle type is invalid
org.freedesktop.Telepathy.Error.InvalidHandle
One of the given handles is not valid
org.freedesktop.Telepathy.Error.NotAvailable
One of the given handles is not held by this client

RequestChannel ( s: type, u: handle_type, u: handle, b: suppress_handler ) → o

Request a channel satisfying the specified type and communicating with the contact, room, list etc. indicated by the given handle_type and handle. The handle_type and handle may both be zero to request the creation of a new, empty channel, which may or may not be possible, depending on the protocol and channel type.

On success, the returned channel will always be of the requested type (i.e. implement the requested channel-type interface).

If a new, empty channel is requested, on success the returned channel will always be an "anonymous" channel for which the type and handle are both zero.

If a channel to a contact, room etc. is requested, on success, the returned channel may either be a new or existing channel to the requested entity (i.e. its GetHandle() returns the requested handle type and handle), or a newly created "anonymous" channel associated with the requested handle in some implementation-specific way.

For example, for a contact handle, the returned channel might be "anonymous", but implement the groups interface and have the requested contact already present among the members.

If the request cannot be satisfied, an error is raised and no channel is created.

Parameters

types (DBus_Interface)
A D-Bus interface name representing base channel type
handle_typeu (Handle_Type)
An integer representing the handle type, or Handle_Type_None if no handle is specified
handleu (Handle)
A nonzero integer handle representing a contact, room, list etc. according to handle_type, or zero if the handle_type is Handle_Type_None
suppress_handlerb
If true, the requesting client intends to take responsibility for displaying the channel to the user, so no other handler needs to be launched

Returns

o
The D-Bus object path for the channel created or retrieved

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotImplemented
Unknown channel type
org.freedesktop.Telepathy.Error.InvalidHandle
The given handle does not exist or cannot be created
org.freedesktop.Telepathy.Error.NotAvailable
The requested channel type cannot be created with the given handle
org.freedesktop.Telepathy.Error.Channel.Banned
You are banned from the channel. (generic description)
org.freedesktop.Telepathy.Error.Channel.Full
The channel is full. (generic description)
org.freedesktop.Telepathy.Error.Channel.InviteOnly
The requested channel is invite-only. (generic description)

RequestHandles ( u: handle_type, as: names ) → au

Request several handles from the connection manager which represent a number of contacts, rooms or server-stored lists on the service. 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 ReleaseHandle method. Where the name refers to an entity that already has a handle in this connection manager, this handle should be returned instead. The handle number 0 must not be returned by the connection manager.

Parameters

handle_typeu (Handle_Type)
The type of handle required
namesas
An array of names of entities to request handles for

Returns

au (Handle[])
An array of integer handle numbers in the same order as the given strings

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
The handle type is invalid
org.freedesktop.Telepathy.Error.NotAvailable
The given name is not a valid entity of the given type

Signals:

NewChannel ( o: object_path, s: channel_type, u: handle_type, u: handle, b: suppress_handler )

Emitted when a new Channel object is created, either through user request or incoming information from the service.

Parameters

object_patho
A D-Bus object path for the channel object on this service
channel_types (DBus_Interface)
A D-Bus interface name representing the channel type
handle_typeu (Handle_Type)
An integer representing the type of handle this channel communicates with, or Handle_Type_None if no handle is specified
handleu (Handle)
A handle indicating the specific contact, room or list this channel communicates with, or zero if no handle is specified
suppress_handlerb

If true, the channel was requested by a client that intends to present it to the user itself (i.e. it passed suppress_handler=TRUE to the RequestChannel method), so no other handler should be launched. Clients MAY assume that channels where this is true were created by a user request.

If false, either the channel was created due to incoming information from the service, or the channel was requested by a local client that does not intend to handle the channel itself (this usage is deprecated).

Clients MUST NOT assume that only incoming channels will have this flag set to false.

StatusChanged ( u: status, u: reason )

Emitted when the status of the connection changes. All states and reasons have numerical values, as defined in ConnectionStatus and ConnectionStatusReason.

Parameters

statusu (Connection_Status)
An integer indicating the new status, as defined by ConnectionStatus
reasonu (Connection_Status_Reason)
An integer indicating the reason for the status change, as defined by ConnectionStatusReason

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Simple types

Handle − u

An unsigned 32-bit integer representing a handle

Contact_Handle − u

An unsigned 32-bit integer representing a handle of type Handle_Type_Contact

Room_Handle − u

An unsigned 32-bit integer representing a handle of type Handle_Type_Room

List_Handle − u

An unsigned 32-bit integer representing a handle of type Handle_Type_List

Group_Handle − u

An unsigned 32-bit integer representing a handle of type Handle_Type_Group

Enumerated types:

Handle_Type

Handle_Type_None = 0
A "null" handle type used to indicate the absence of a handle. When a handle type and a handle appear as a pair, if the handle type is zero, the handle must also be zero.
Handle_Type_Contact = 1
A contact
Handle_Type_Room = 2
A chat room
Handle_Type_List = 3
A server-generated contact list (see Channel.Interface.Group)
Handle_Type_Group = 4
A user-defined contact list (see Channel.Interface.Group)

Connection_Status

Connection_Status_Connected = 0
The connection is alive and all methods are available.
Connection_Status_Connecting = 1
The connection has not yet been established, or has been severed and reconnection is being attempted. Some methods may fail until the connection has been established.
Connection_Status_Disconnected = 2
The connection has been severed and no method calls are valid. The object may be removed from the bus at any time.

Connection_Status_Reason

Connection_Status_Reason_None_Specified = 0
There is no reason set for this state change.
Connection_Status_Reason_Requested = 1
The change is in response to a user request.
Connection_Status_Reason_Network_Error = 2
There was an error sending or receiving on the network socket.
Connection_Status_Reason_Authentication_Failed = 3
The username or password was invalid.
Connection_Status_Reason_Encryption_Error = 4
There was an error negotiating SSL on this connection, or encryption was unavailable and require-encryption was set when the connection was created.
Connection_Status_Reason_Name_In_Use = 5
Someone is already connected to the server using the name you are trying to connect with.
Connection_Status_Reason_Cert_Not_Provided = 6
The server did not provide a SSL certificate.
Connection_Status_Reason_Cert_Untrusted = 7
The server's SSL certificate could not be trusted.
Connection_Status_Reason_Cert_Expired = 8
The server's SSL certificate has expired.
Connection_Status_Reason_Cert_Not_Activated = 9
The server's SSL certificate is not yet valid.
Connection_Status_Reason_Cert_Hostname_Mismatch = 10
The server's SSL certificate did not match its hostname.
Connection_Status_Reason_Cert_Fingerprint_Mismatch = 11
The server's SSL certificate does not have the expected fingerprint.
Connection_Status_Reason_Cert_Self_Signed = 12
The server's SSL certificate is self-signed.
Connection_Status_Reason_Cert_Other_Error = 13
There was some other error validating the server's SSL certificate.

Structure types

Channel_Info − ( o: Channel, s: Channel_Type, u: Handle_Type, u: Handle )

A struct representing a channel, as returned by ListChannels on the Connection interface.

In bindings that need a separate name, arrays of Channel_Info should be called Channel_Info_List.

Members

Channelo
The object path of the channel, which is on the same bus name as the connection
Channel_Types (DBus_Interface)
The channel's type
Handle_Typeu (Handle_Type)
The type of the handle that the channel communicates with, or Handle_Type_None if there is no associated handle
Handleu (Handle)
The handle that the channel communicates with, or 0 if there is no associated handle

org.freedesktop.Telepathy.Connection.Interface.Aliasing

Implementations of this interface must also implement:

An interface on connections to support protocols where contacts have an alias which they can change at will. Provides a method for the user to set their own alias, and a signal which should be emitted when a contact's alias is changed or first discovered.

On connections where the user is allowed to set aliases for contacts and store them on the server, the GetAliasFlags method will have the CONNECTION_ALIAS_FLAG_USER_SET flag set, and the SetAliases method may be called on contact handles other than the user themselves.

Aliases are intended to be used as the main displayed name for the contact, where available.

Methods:

GetAliasFlags ( ) → u

Return a bitwise OR of flags detailing the behaviour of aliases on this connection.

Returns

u (Connection_Alias_Flags)
An integer with a bitwise OR of flags from ConnectionAliasFlags

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)

RequestAliases ( au: contacts ) → as

Request the value of several contacts' aliases at once.

Parameters

contactsau (Contact_Handle[])
An array of handles representing contacts

Returns

as
A list of aliases in the same order as the contact handles

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)

GetAliases ( au: contacts ) → a{us}

Request the value of several contacts' aliases at once. This SHOULD only return cached aliases, falling back on the handle name if none is present. Also if there was no cached alias, a request SHOULD be started of which the result is later signalled by AliasesChanged.

Parameters

contactsau (Contact_Handle[])
An array of handles representing contacts

Returns

a{us} (Alias_Map)
A dictionary mapping contact handles to aliases

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)

SetAliases ( a{us}: aliases ) → nothing

Request that the alias of the given contact be changed. Success will be indicated by emitting an AliasesChanged signal. On connections where the CONNECTION_ALIAS_FLAG_USER_SET flag is not set, this method will only ever succeed if the contact is the user's own handle (as returned by GetSelfHandle on the Connection interface).

Parameters

aliasesa{us} (Alias_Map)
A dictionary mapping integer handles of contacts to strings of the new alias to set.

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)

Signals:

AliasesChanged ( a(us): aliases )

Signal emitted when a contact's alias (or that of the user) is changed.

Parameters

aliasesa(us) (Alias_Pair[])
An array containing structs of:
  • the handle representing the contact
  • the new alias

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Sets of flags:

Connection_Alias_Flags

Connection_Alias_Flag_User_Set = 1

The aliases of contacts on this connection may be changed by the user of the service, not just by the contacts themselves. This is the case on Jabber, for instance.

It is possible that aliases can be changed by the contacts too - which alias takes precedence is not defined by this specification, and depends on the server and/or connection manager implementation.

This flag only applies to the aliases of "globally valid" contact handles. At this time, clients should not expect to be able to change the aliases corresponding to any channel-specific handles. If this becomes possible in future, a new flag will be defined.

Structure types

Alias_Pair − ( u: Handle, s: Alias )

A pair (contact handle, alias) as seen in the AliasesChanged signal.

In bindings that need a separate name, arrays of Alias_Pair should be called Alias_Pair_List.

Members

Handleu (Contact_Handle)
(undocumented)
Aliass
(undocumented)

Mapping types

Alias_Map − a{ u: Handle → s: Alias }

A dictionary whose keys are contact handles and whose values are aliases.

Members

Handleu (Contact_Handle)
(undocumented)
Aliass
(undocumented)

org.freedesktop.Telepathy.Connection.Interface.Avatars

Implementations of this interface must also implement:

An interface for requesting avatars for contacts on a given connection, receiving notification when avatars are changed, and publishing your own avatar.

Avatars are identified by a unique (per contact) token which represents a hash or timestamp (depending on the protocol) of the contacts' avatar data. An empty token means that an avatar has not been set for this contact, and a changed token implies the contact's avatar has changed, but the strings should otherwise be considered opaque by clients.

A client should use GetKnownAvatarTokens to request the tokens for the avatars of all the contacts it is interested in when it connects. The avatars can then be requested using RequestAvatars for the contacts. Clients should bind to the AvatarChanged signal and request a new copy of the avatar when a contacts' avatar token changes. Clients should cache the token and data of each contact's avatar between connections, to avoid repeatedly retrieving the same avatar.

To publish an avatar, a client should use SetAvatar to provide an image which meets the requirements returned by the GetAvatarRequirements function. On some protocols the avatar is stored on the server, so setting the avatar is persistent, but on others it is transferred via a peer to peer mechanism, so needs to be set every connection. Hence, on every connection, clients should inspect the avatar token of the connection's self handle using GetKnownAvatarTokens; if the self handle is not in the returned map, the client should re-set the avatar. If the self handle's avatar token is known, but the avatar has been changed locally since the last connection, the client should upload the new avatar; if the avatar has not changed locally, then the client should download the avatar from the server if its token differs from the that of the local avatar.

To remove the published avatar on protocols which have persistent avatars, a client should use the ClearAvatar method. This method can safely be used even if there is no avatar for this connection.

Methods:

GetAvatarRequirements ( ) → as, q, q, q, q, u

Get the required format of avatars on this connection.

Returns

as
An array of supported MIME types (eg image/jpeg)
q
The minimum image width in pixels
q
The minimum image height in pixels
q
The maximum image width in pixels, or 0 if there is no limit
q
The maximum image height in pixels, or 0 if there is no limit
u
The maximum image size in bytes, or 0 if there is no limit

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)

GetAvatarTokens ( au: contacts ) → as

Get the unique tokens for all of the given contacts' avatars. Using this method in new Telepathy clients is deprecated; use GetKnownAvatarTokens instead.

Parameters

contactsau (Contact_Handle[])
An array of handles representing contacts

Returns

as
An array of avatar tokens or empty strings (if no avatar is set) in the same order as the given array of contact handles

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)

GetKnownAvatarTokens ( au: contacts ) → a{us}

Get the unique tokens for the given contacts' avatars. These tokens can be persisted across connections, and should be used by the client to check whether the avatars have been updated. For handles other than the self handle, only tokens that are already known are returned; an empty token means the given contact has no avatar. However, a CM must always have the tokens for the self handle if one is set (even if it is set to no avatar). On protocols where the avatar does not persist between connections, a CM should omit the self handle from the returned map until an avatar is explicitly set or cleared.

Parameters

contactsau (Contact_Handle[])
An array of handles representing contacts

Returns

a{us} (Avatar_Token_Map)
A dictionary of handles mapped to avatar tokens, containing only the known avatar tokens.

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)

RequestAvatar ( u: contact ) → ay, s

Request the avatar for a given contact. Using this method in new Telepathy clients is deprecated; use RequestAvatars instead.

Parameters

contactu (Contact_Handle)
An integer handle for the contact to request the avatar for

Returns

ay
An array of bytes containing the image data
s
A string containing the image MIME type (eg image/jpeg), or empty if unknown

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
The contact does not currently have an avatar.

RequestAvatars ( au: contacts ) → nothing

Request avatars for a number of contacts. The AvatarRetrieved signal is emitted for each avatar retrieved. If the handles are valid but retrieving an avatar fails (for any reason, including the contact not having an avatar) the AvatarRetrieved signal is not emitted for that contact.

Parameters

contactsau (Contact_Handle[])
The contacts to retrieve avatars for

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)

SetAvatar ( ay: avatar, s: mime_type ) → s

Set a new avatar image for this connection. The avatar image must respect the requirements obtained by GetAvatarRequirements.

Parameters

avataray
An array of bytes representing the avatar image data
mime_types
A string representing the image MIME type

Returns

s
The string token of the new avatar

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)

ClearAvatar ( ) → nothing

Remove the avatar image for this connection.

Added in version 0.15.0.

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

Signals:

AvatarUpdated ( u: contact, s: new_avatar_token )

Emitted when the avatar for a contact has been updated, or first discovered on this connection. If the token differs from the token associated with the client's cached avatar for this contact, the new avatar should be requested with RequestAvatars.

Parameters

contactu (Contact_Handle)
An integer handle for the contact whose avatar has changed
new_avatar_tokens
Unique token for their new avatar

AvatarRetrieved ( u: contact, s: token, ay: avatar, s: type )

Emitted when the avatar for a contact has been retrieved.

Parameters

contactu (Contact_Handle)
The contact whose avatar has been retrieved
tokens
The token corresponding to the avatar
avataray
An array of bytes containing the image data
types
A string containing the image MIME type (eg image/jpeg), or empty if unknown

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Mapping types

Avatar_Token_Map − a{ u: Handle → s: Token }

A dictionary whose keys are contact handles and whose values are avatar tokens.

Members

Handleu (Contact_Handle)
(undocumented)
Tokens
(undocumented)

org.freedesktop.Telepathy.Connection.Interface.Capabilities

Implementations of this interface must also implement:

An interface for connections where it is possible to know what channel types may be requested before the request is made to the connection object. Each capability represents a commitment by the connection manager that it will ordinarily be able to create a channel when given a request with the given type and handle.

Capabilities pertain to particular contact handles, and represent activities such as having a text chat or a voice call with the user. The activities are represented by the D-Bus interface name of the channel type for that activity.

The generic capability flags are defined by Connection_Capability_Flags.

In addition, channel types may have type specific capability flags of their own, which are described in the documentation for each channel type.

This interface also provides for user interfaces notifying the connection manager of what capabilities to advertise for the user. This is done by using the AdvertiseCapabilities method, and deals with the interface names of channel types and the type specific flags pertaining to them which are implemented by available client processes.

Changed in version 0.17.8: Previously, this interface also expressed capabilities of the connection itself, indicating what sorts of channels could be requested (for instance, the ability to open chatroom lists or chatrooms). However, this was never very well-defined or consistent, and as far as we know it was never implemented correctly. This usage is now deprecated.

Methods:

AdvertiseCapabilities ( a(su): add, as: remove ) → a(su)

Used by user interfaces to indicate which channel types they are able to handle on this connection. Because these may be provided by different client processes, this method accepts channel types to add and remove from the set already advertised on this connection. The type of advertised capabilities (create versus invite) is protocol-dependent and hence cannot be set by the this method. In the case of a client adding an already advertised channel type but with new channel type specific flags, the connection manager should simply add the new flags to the set of advertised capabilities.

Upon a successful invocation of this method, the CapabilitiesChanged signal will be emitted for the user's own handle (as returned by GetSelfHandle) by the connection manager to indicate the changes that have been made. This signal should also be monitored to ensure that the set is kept accurate - for example, a client may remove capabilities or type specific capability flags when it exits which are still provided by another client.

Parameters

adda(su) (Capability_Pair[])
An array of structures containing:
  • a string channel type
  • a bitwise OR of type specific capability flags
removeas (DBus_Interface[])
An array of D-Bus interface names of channel types to remove

Returns

a(su) (Capability_Pair[])
An array of structures describing the current capabilities containing: a string channel type a bitwise OR of type specific capability flags

Possible errors

org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)

GetCapabilities ( au: handles ) → a(usuu)

Returns an array of capabilities for the given contact handles.

Parameters

handlesau (Contact_Handle[])

An array of contact handles for this connection.

This may include zero, which originally meant a query for capabilities available on the connection itself. This usage is deprecated; clients SHOULD NOT do this, and connection managers SHOULD proceed as though zero had not been present in this list.

Returns

a(usuu) (Contact_Capability[])
An array of structures containing:
  • an integer handle representing the contact
  • a string channel type
  • a bitwise OR of generic capability flags for the type
  • a bitwise OR of type specific capability flags for the type

Possible errors

org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The handle does not represent a contact and is not zero
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)

Signals:

CapabilitiesChanged ( a(usuuuu): caps )

Announce that there has been a change of capabilities on the given handle.

If the handle is zero, the capabilities refer to the connection itself, in some poorly defined way. This usage is deprecated and clients should ignore it.

Parameters

capsa(usuuuu) (Capability_Change[])
An array of structures containing:
  • an integer handle representing the contact
  • a string channel type
  • a bitwise OR of the contact's old generic capability flags
  • a bitwise OR of the contact's new generic capability flags
  • a bitwise OR of the contact's old type specific capability flags
  • a bitwise OR of the contact's new type specific capability flags

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Sets of flags:

Connection_Capability_Flags

Connection_Capability_Flag_Create = 1
The given channel type and handle can be given to RequestChannel to create a new channel of this type.
Connection_Capability_Flag_Invite = 2
The given contact can be invited to an existing channel of this type.

Structure types

Capability_Pair − ( s: Channel_Type, u: Type_Specific_Flags )

A pair (channel type, type-specific flags) as passed to AdvertiseCapabilities on the Capabilities interface.

In bindings that need a separate name, arrays of Capability_Pair should be called Capability_Pair_List.

Members

Channel_Types (DBus_Interface)
(undocumented)
Type_Specific_Flagsu
(undocumented)

Contact_Capability − ( u: Handle, s: Channel_Type, u: Generic_Flags, u: Type_Specific_Flags )

A struct (contact handle, channel type, generic flags, type-specific flags) representing a capability posessed by a contact, as returned by GetCapabilities on the Capabilities interface.

In bindings that need a separate name, arrays of Contact_Capability should be called Contact_Capability_List.

Members

Handleu (Contact_Handle)
(undocumented)
Channel_Types (DBus_Interface)
(undocumented)
Generic_Flagsu (Connection_Capability_Flags)
(undocumented)
Type_Specific_Flagsu
(undocumented)

Capability_Change − ( u: Handle, s: Channel_Type, u: Old_Generic_Flags, u: New_Generic_Flags, u: Old_Type_Specific_Flags, u: New_Type_Specific_Flags )

A struct (contact handle, channel type, old generic flags, new generic flags, old type-specific flags, new type-specific flags) representing a change to one of a contact's capabilities, as seen in the CapabilitiesChanged signal on the Capabilities interface.

In bindings that need a separate name, arrays of Capability_Change should be called Capability_Change_List.

Members

Handleu (Contact_Handle)
(undocumented)
Channel_Types (DBus_Interface)
(undocumented)
Old_Generic_Flagsu (Connection_Capability_Flags)
(undocumented)
New_Generic_Flagsu (Connection_Capability_Flags)
(undocumented)
Old_Type_Specific_Flagsu
(undocumented)
New_Type_Specific_Flagsu
(undocumented)

org.freedesktop.Telepathy.Connection.Interface.Contacts

Implementations of this interface must also implement:

This interface allows many attributes of many contacts to be obtained in a single D-Bus round trip.

Each contact attribute has an string identifier (Contact_Attribute), which is namespaced by the D-Bus interface which defines it.

An initial set of contact attributes is defined here:

org.freedesktop.Telepathy.Connection/contact-id (type s)
The same string that would be returned by InspectHandles (always present in the result)
org.freedesktop.Telepathy.Connection.Interface.Aliasing/alias (type s)
The same string that would be returned by GetAliases (always present with some value, possibly the same as Connection/contact-id, if information from the Aliasing interface was requested)
org.freedesktop.Telepathy.Connection.Interface.Avatars/token (type s)
The same string that would be returned by GetKnownAvatarTokens (omitted from the result if the contact's avatar token is not known, present as an empty string if the contact is known not to have an avatar). Unlike in the GetKnownAvatarTokens method, the avatar tokens for the self handle aren't required to be present. This attribute should not be used to determine whether or not the Avatar needs to be set.
org.freedesktop.Telepathy.Connection.Interface.SimplePresence/presence (type (uss), Simple_Presence)
The same struct that would be returned by GetPresences (always present with some value if information from the SimplePresence interface was requested)
org.freedesktop.Telepathy.Connection.Interface.Capabilities/caps (type a(usuu), Contact_Capability)
The same structs that would be returned by GetCapabilities (all of them will redundantly have the contact's handle as the first member). 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.

Added in version 0.17.9.

Methods:

GetContactAttributes ( au: Handles, as: Interfaces, b: Hold ) → a{ua{sv}}

Return any number of contact attributes for the given handles.

Parameters

Handlesau (Contact_Handle[])
An array of handles representing contacts.
Interfacesas (DBus_Interface[])

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.

It is an error to request interfaces that are not supported by this Connection (i.e. mentioned in the ContactAttributeInterfaces property).

This makes it possible to distinguish between interfaces for which the Connection has nothing to say (e.g. we don't know the avatar tokens of any of the contacts, so we omitted them all), and interfaces for which this API isn't supported.

Attributes from the interface org.freedesktop.Telepathy.Connection are always returned, and need not be requested explicitly.

As well as returning cached information immediately, the connection MAY start asynchronous requests to obtain better values for the contact attributes. If better values are later obtained by this process, they will be indicated with the usual signals (such as AliasesChanged).

For instance, an XMPP connection manager could download vCards in response to a request for Aliasing attributes.
Holdb
If true, all handles in the result have been held on behalf of the calling process, as if by a call to Connection.HoldHandles.
For further round-trip avoidance.

Returns

Attributesa{ua{sv}} (Contact_Attributes_Map)

A dictionary mapping the contact handles to contact attributes. If any of the requested handles 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.

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).

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
One of the requested interfaces is not supported (mentioned in ContactAttributeInterfaces).

Interface has no signals.

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

ContactAttributeInterfacesas (DBus_Interface[]), read-only
A list of D-Bus interfaces for which GetContactAttributes is expected to work. This cannot change during the lifetime of the Connection.

Simple types

Contact_Attribute − s

A DBus_Interface, followed by a slash '/' character and an identifier for an attribute defined by that interface. The attribute identifier SHOULD be in lower case.
These aren't D-Bus core Properties, and we want them to look visibly different.

Mapping types

Single_Contact_Attributes_Map − a{ s: Attribute → v: Value }

Some of the attributes of a single contact.

Members

Attributes (Contact_Attribute)
The name of the attribute
Valuev
The value of the attribute

Contact_Attributes_Map − a{ u: Contact → a{sv}: Attributes }

Mapping returned by GetContactAttributes, representing a collection of Contacts and their requested attributes.

Members

Contactu (Contact_Handle)
A contact
Attributesa{sv} (Single_Contact_Attributes_Map)
Attributes of that contact

org.freedesktop.Telepathy.Connection.Interface.SimplePresence

Implementations of this interface must also implement:

This interface is for services which have a concept of presence which can be published for yourself and monitored on your contacts.

Presence on an individual (yourself or one of your contacts) is modelled as a status and a status message. Valid statuses are defined per connection, and a list of those that can be set on youself can be obtained from the Statuses property.

Each status has an arbitrary string identifier which should have an agreed meaning between the connection manager and any client which is expected to make use of it. The following well-known values should be used where possible to allow clients to identify common choices:

status identifier Connection_Presence_Type comments
available Connection_Presence_Type_Available
away Connection_Presence_Type_Away
brb Connection_Presence_Type_Away Be Right Back (a more specific form of Away)
busy Connection_Presence_Type_Busy
dnd Connection_Presence_Type_Busy Do Not Disturb (a more specific form of Busy)
xa Connection_Presence_Type_Extended_Away Extended Away
hidden Connection_Presence_Type_Hidden Also known as "Invisible" or "Appear Offline"
offline Connection_Presence_Type_Offline
unknown Connection_Presence_Type_Unknown special, see below
error Connection_Presence_Type_Error special, see below

As well as these well-known status identifiers, every status also has a numerical type value chosen from ConnectionPresenceType which can be used by the client to classify even unknown statuses into different fundamental types.

These numerical types exist so that even if a client does not understand the string identifier being used, and hence cannot present the presence to the user to set on themselves, it may display an approximation of the presence if it is set on a contact.

As well as the normal status identifiers, there are two special ones that may be present: 'unknown' with type Unknown and 'error' with type Error. 'unknown' indicates that it is impossible to determine the presence of a contact at this time, for example because it's not on the 'subscribe' list and the protocol only allows one to determine the presence of contacts you're subscribed to. 'error' indicates that there was a failure in determining the status of a contact.

If the connection has a 'subscribe' contact list, PresencesChanged signals should be emitted to indicate changes of contacts on this list, and should also be emitted for changes in your own presence. Depending on the protocol, the signal may also be emitted for others such as people with whom you are communicating, and any user interface should be updated accordingly.

Methods:

SetPresence ( s: status, s: status_message ) → nothing

Request that the presence status and status message are published for the connection. Changes will be indicated by PresencesChanged signals being emitted.

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 selected status.

In DISCONNECTED state the Statuses property will indicate which statuses are allowed to be set while DISCONNECTED (none, if the Connection Manager doesn't allow this). This value MUST NOT be cached, as the set of allowed presences might change upon connecting.

Parameters

statuss

The string identifier of the desired status. Possible status identifiers are defined in the Statuses property.

Clients MUST NOT set a status whose string value they do not recognise, even if its presence type in Statuses matches what the user requested.

Suppose a protocol has statuses that include 'phone' (of type BUSY) and 'in-a-meeting' (of type BUSY), but there is no generic 'busy' status.

If the user requests "Busy" status from a menu, a client author might be tempted to pick an arbitrary status that has type BUSY. However, on this protocol, neither of the choices would be appropriate, and incorrect information about the user would be conveyed.

status_messages
The status message associated with the current status.

Possible errors

org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Either the specified status is not supported, the specified status cannot be set on the user themselves, or a non-empty message was supplied for a status that does not accept a message.
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)

GetPresences ( au: contacts ) → a{u(uss)}

Get presence previously emitted by PresencesChanged for the given contacts. Data is returned in the same structure as the PresencesChanged signal; no additional network requests are made.

Parameters

contactsau (Contact_Handle[])
An array of the contacts whose presence should be obtained.

Returns

presencea{u(uss)} (Simple_Contact_Presences)

Presence information in the same format as for the PresencesChanged signal. The returned mapping MUST include an entry for each contact in the method's argument.

The definition of the connection presence types Unknown and Offline means that if a connection manager will return Unknown for contacts not on the subscribe list, it MUST delay the reply to this method call until it has found out which contacts are, in fact, on the subscribe list.

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
While discovering the subscribe list in order to distinguish between Unknown and Offline statuses, a network error occurred.
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)

Signals:

PresencesChanged ( a{u(uss)}: presence )

This signal should be emitted when your own presence has been changed, or the presence of the member of any of the connection's channels has been changed.

Parameters

presencea{u(uss)} (Simple_Contact_Presences)
A dictionary of contact handles mapped to the status, presence type and status message.

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

Statusesa{s(ubb)} (Simple_Status_Spec_Map), read-only

A dictionary where the keys are the presence statuses that the user can set on themselves for this connection, and the values are the corresponding presence types.

While the connection is in the DISCONNECTED state, it contains the set of presence statuses allowed to be set before connecting. The connection manager will attempt to set the appropriate status when the connection becomes connected, but cannot necessarily guarantee it. The available statuses cannot change until the connection status changes, so there is no change notification.

While the connection is in the CONNECTED state, this property contains the set of presence statuses which are actually available on this protocol. This set is constant for the remaining lifetime of the connection, so again, there is no change notification.

While the connection is in the CONNECTING state, the value of this property is undefined and SHOULD NOT be used. It can change at any time without notification (in particular, any cached values from when the connection was in the DISCONNECTED or CONNECTING state MUST NOT be assumed to still be correct when the state has become CONNECTED).

This property MUST include the special statuses "unknown" and "error" if and only if the connection manager can emit them as a contact's status.

For instance, connection managers for local-xmpp (XEP-0174) would omit "unknown" since there is no such concept.

Structure types

Simple_Presence − ( u: Type, s: Status, s: Status_Message )

A struct representing the presence of a contact.

Arrays of Simple_Presence don't generally make sense.

Members

Typeu (Connection_Presence_Type)
The presence type, e.g. Connection_Presence_Type_Away.
Statuss
The string identifier of the status, e.g. "brb", as defined in the Statuses property.
Status_Messages

The user-defined status message, e.g. "Back soon!".

Clients SHOULD set the status message for the local user to the empty string, unless the user has actually provided a specific message (i.e. one that conveys more information than the Status).

User interfaces SHOULD regard an empty status message as unset, and MAY replace it with a localized string corresponding to the Status or Type.

Use case: Daf sets his status in Empathy by choosing the Welsh translation of "Available" from a menu. It is more informative for his English-speaking colleagues to see the English translation of "Available" (as localized by their own clients) than to see the Welsh version (which they don't understand anyway).

Simple_Status_Spec − ( u: Type, b: May_Set_On_Self, b: Can_Have_Message )

A struct containing information about a status.

Arrays of Simple_Status_Spec don't generally make sense.

Members

Typeu (Connection_Presence_Type)
The type of a presence. This SHOULD NOT be used as a way to set statuses that the client does not recognise (as explained in SetPresence), but MAY be used to check that the client's assumptions about a particular status name match the connection manager's.
May_Set_On_Selfb
If true, the user can set this status on themselves using SetPresence.
Can_Have_Messageb
If true, a non-empty message can be set for this status. Otherwise, the empty string is the only acceptable message.
On IRC you can be Away with a status message, but if you are available you cannot set a status message.

Mapping types

Simple_Contact_Presences − a{ u: Contact → (uss): Presence }

Mapping returned by GetPresences and signalled by PresencesChanged, indicating the presence of a number of contacts.

Members

Contactu (Contact_Handle)
A contact
Presence(uss) (Simple_Presence)
The contact's presence

Simple_Status_Spec_Map − a{ s: Identifier → (ubb): Spec }

A mapping describing possible statuses.

Members

Identifiers
The string identifier of this status.
Spec(ubb) (Simple_Status_Spec)
Details of this status.

org.freedesktop.Telepathy.Connection.Interface.Presence

Implementations of this interface must also implement:

This interface will become deprecated in future versions. New client implementations MAY use org.freedesktop.Telepathy.Connection.Interface.SimplePresence instead; new connection managers SHOULD implement both Presence and SimplePresence.

This interface is for services which have a concept of presence which can be published for yourself and monitored on your contacts. Telepathy's definition of presence is based on that used by the Galago project.

Presence on an individual (yourself or one of your contacts) is modelled as a last activity time along with a set of zero or more statuses, each of which may have arbitrary key/value parameters. Valid statuses are defined per connection, and a list of them can be obtained with the GetStatuses method.

Each status has an arbitrary string identifier which should have an agreed meaning between the connection manager and any client which is expected to make use of it. The following well-known values (in common with those in Galago) should be used where possible to allow clients to identify common choices:

As well as these well-known status identifiers, every status also has a numerical type value chosen from ConnectionPresenceType which can be used by the client to classify even unknown statuses into different fundamental types.

These numerical types exist so that even if a client does not understand the string identifier being used, and hence cannot present the presence to the user to set on themselves, it may display an approximation of the presence if it is set on a contact.

The dictionary of variant types allows the connection manager to exchange further protocol-specific information with the client. It is recommended that the string (s) argument 'message' be interpreted as an optional message which can be associated with a presence status.

If the connection has a 'subscribe' contact list, PresenceUpdate signals should be emitted to indicate changes of contacts on this list, and should also be emitted for changes in your own presence. Depending on the protocol, the signal may also be emitted for others such as people with whom you are communicating, and any user interface should be updated accordingly.

On some protocols, RequestPresence may only succeed on contacts on your 'subscribe' list, and other contacts will cause a PermissionDenied error. On protocols where there is no 'subscribe' list, and RequestPresence succeeds, a client may poll the server intermittently to update any display of presence information.

Methods:

AddStatus ( s: status, a{sv}: parms ) → nothing

Request that a single presence status is published for the user, along with any desired parameters. Changes will be indicated by PresenceUpdate signals being emitted.

Parameters

statuss
The string identifier of the desired status
parmsa{sv} (String_Variant_Map)
A dictionary of optional parameter names mapped to their variant-boxed values

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)

ClearStatus ( ) → nothing

Request that all of a user's presence statuses be removed. Be aware that this request may simply result in the statuses being replaced by a default available status. Changes will be indicated by PresenceUpdate signals being emitted.

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)

GetPresence ( au: contacts ) → a{u(ua{sa{sv}})}

Get presence previously emitted by PresenceUpdate for the given contacts. Data is returned in the same structure as the PresenceUpdate signal. Using this method in favour of RequestPresence has the advantage that it will not wake up each client connected to the PresenceUpdate signal.

Parameters

contactsau (Contact_Handle[])
An array of the contacts whose presence should be obtained

Returns

presencea{u(ua{sa{sv}})} (Contact_Presences)
Presence information in the same format as for the PresenceUpdate signal

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)

GetStatuses ( ) → a{s(ubba{ss})}

Get a dictionary of the valid presence statuses for this connection. This is only available when online because only some statuses will be available on some servers.

Returns

a{s(ubba{ss})} (Status_Spec_Map)
A dictionary of string identifiers mapped to a struct for each status, containing: a type value from one of the values above a boolean to indicate if this status may be set on yourself a boolean to indicate if this is an exclusive status which you may not set alongside any other a dictionary of valid optional string argument names mapped to their types

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

RemoveStatus ( s: status ) → nothing

Request that the given presence status is no longer published for the user. Changes will be indicated by PresenceUpdate signals being emitted. As with ClearStatus, removing a status may actually result in it being replaced by a default available status.

Parameters

statuss
The string identifier of the status not to publish anymore for the user

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
The status requested is not currently set

RequestPresence ( au: contacts ) → nothing

Request the presence for contacts on this connection. A PresenceUpdate signal will be emitted when they are received. This is not the same as subscribing to the presence of a contact, which must be done using the 'subscription' Channel.Type.ContactList, and on some protocols presence information may not be available unless a subscription exists.

Parameters

contactsau (Contact_Handle[])
An array of the contacts whose presence should be obtained

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
The presence of the requested contacts is not reported to this connection

SetLastActivityTime ( u: time ) → nothing

Request that the recorded last activity time for the user be updated on the server.

Parameters

timeu (Unix_Timestamp)
A UNIX timestamp of the user's last activity time (in UTC)

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotImplemented
This protocol has no concept of idle time

SetStatus ( a{sa{sv}}: statuses ) → nothing

Request that the user's presence be changed to the given statuses and desired parameters. Changes will be reflected by PresenceUpdate signals being emitted. On certain protocols, this method may be called on a newly-created connection which is still in the DISCONNECTED state, and will sign on with the requested status. If the requested status is not available after signing on, NotAvailable will be returned and the connection will remain offline, or if the protocol does not support signing on with a certain status, Disconnected will be returned.

Parameters

statusesa{sa{sv}} (Multiple_Status_Map)
A dictionary mapping status identifiers to dictionaries, which map optional parameter names to their variant-boxed values

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)

Signals:

PresenceUpdate ( a{u(ua{sa{sv}})}: presence )

This signal should be emitted when your own presence has been changed, or the presence of the member of any of the connection's channels has been changed, or when the presence requested by RequestPresence is available.

Parameters

presencea{u(ua{sa{sv}})} (Contact_Presences)
A dictionary of contact handles mapped to a struct containing a UNIX timestamp of the last activity time (in UTC), and a dictionary mapping the contact's current status identifiers to a dictionary of optional parameter names mapped to their variant-boxed values

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Enumerated types:

Connection_Presence_Type

Connection_Presence_Type_Unset = 0
An invalid presence type used as a null value. This value MUST NOT appear in the result of GetStatuses, or in the Statuses property of the SimplePresence interface.
Connection_Presence_Type_Offline = 1
Offline
Connection_Presence_Type_Available = 2
Available
Connection_Presence_Type_Away = 3
Away
Connection_Presence_Type_Extended_Away = 4
Away for an extended time
Connection_Presence_Type_Hidden = 5
Hidden (invisible)
Connection_Presence_Type_Busy = 6
Busy, Do Not Disturb.

Added in version 0.17.0.

Connection_Presence_Type_Unknown = 7
Unknown, unable to determine presence for this contact, for example if the protocol only allows presence of subscribed contacts.

Added in version 0.17.8.

Connection_Presence_Type_Error = 8
Error, an error occurred while trying to determine presence. The message, if set, is an error from the server.

Added in version 0.17.8.

Structure types

Last_Activity_And_Statuses − ( u: Last_Activity, a{sa{sv}}: Statuses )

Structure representing a contact's presence, containing a last-activity time (deprecated) and a Multiple_Status_Map.

Arrays of Last_Activity_And_Statuses don't generally make sense.

Members

Last_Activityu (Unix_Timestamp)
(undocumented)
Statusesa{sa{sv}} (Multiple_Status_Map)
(undocumented)

Status_Spec − ( u: Type, b: May_Set_On_Self, b: Exclusive, a{ss}: Parameter_Types )

Arrays of Status_Spec don't generally make sense.

Members

Typeu (Connection_Presence_Type)
(undocumented)
May_Set_On_Selfb
(undocumented)
Exclusiveb
(undocumented)
Parameter_Typesa{ss} (String_String_Map)
(undocumented)

Mapping types

Multiple_Status_Map − a{ s: Status → a{sv}: Parameters }

Mapping used in Last_Activity_And_Statuses and passed to SetStatus, representing a collection of statuses. Use of this mapping with more than one member is deprecated.

Members

Statuss
(undocumented)
Parametersa{sv} (String_Variant_Map)
(undocumented)

Contact_Presences − a{ u: Contact → (ua{sa{sv}}): Presence }

Mapping returned by GetPresence and signalled by PresenceUpdate, where the keys are contacts and the values represent their presences.

Members

Contactu (Contact_Handle)
(undocumented)
Presence(ua{sa{sv}}) (Last_Activity_And_Statuses)
(undocumented)

Status_Spec_Map − a{ s: Identifier → (ubba{ss}): Spec }

Members

Identifiers
(undocumented)
Spec(ubba{ss}) (Status_Spec)
(undocumented)

org.freedesktop.Telepathy.Connection.Interface.Renaming

This interface is not well-tested and is likely to cause havoc to your API/ABI if bindings are generated. Don't include it in libraries that care about compatibility.

Implementations of this interface must also implement:

An interface on connections to support protocols where the unique identifiers of contacts can change. Because handles are immutable, this is represented by a pair of handles, that representing the old name, and that representing the new one.

Methods:

RequestRename ( s: name ) → nothing

Request that the user's own identifier is changed on the server. If successful, a Renamed signal will be emitted for the current "self handle" as returned by GetSelfHandle.

It is protocol-dependent how the identifier that's actually used will be derived from the supplied identifier; some sort of normalization might take place.

Parameters

names
The desired identifier

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)

Signals:

Renamed ( u: original, u: new )

Emitted when the unique identifier of a contact on the server changes.

Any channels associated with the contact's original handle will continue to be to that handle, and so are no longer useful (unless the contact renames back, or another contact connects with that unique ID). Clients may open a similar channel associated with the new handle to continue communicating with the contact.

For example, if a GUI client associates text channels with chat windows, it should detach the old channel from the chat window, closing it, and associate a channel to the new handle with the same window.

If the contact's old handle is in any of the member lists of a channel which has the groups interface, it will be removed from the channel and the new handle will be added. The resulting MembersChanged signal must be emitted after the Renamed signal; the reason should be RENAMED.

The handles may be either general-purpose or channel-specific. If the original handle is general-purpose, the new handle must be general-purpose; if the original handle is channel-specific, the new handle must be channel-specific in the same channel.

Parameters

originalu (Contact_Handle)
The handle of the original identifier
newu (Contact_Handle)
The handle of the new identifier

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

org.freedesktop.Telepathy.Connection.Interface.Requests.DRAFT

This interface is experimental and is likely to cause havoc to your API/ABI if bindings are generated. Don't include it in libraries that care about compatibility.

Implementations of this interface must also implement:

An enhanced version of the Telepathy connection interface, which can represent bundles of channels that should be dispatched together, and does not assume any particular properties by which channels are uniquely identifiable.

Added in version 0.17.9.

Methods:

CreateChannel ( a{sv}: Request ) → o, a{sv}

Request that channels are created.

There is deliberately no flag corresponding to the suppress_handler argument to Connection.RequestChannel, because passing a FALSE value for that argument is deprecated. Requests made using this interface always behave as though suppress_handler was TRUE.

Parameters

Requesta{sv} (Qualified_Property_Value_Map)

A dictionary containing desirable properties. Some properties are defined such that only an exact match makes sense, and connection managers MUST NOT satisfy a request with a channel where that property does not match; some properties are defined such that the connection manager MAY treat the request as merely a hint, and make a best-effort attempt to satisfy it. This is documented separately for each property.

If this dictionary contains a property whose semantics are not known to the connection manager, this method MUST fail without side-effects (in particular it must not create a new channel).

This is necessary if we want to be able to invent properties in future that, when used in a request, are hard requirements rather than just hints. A connection manager that did not know the semantics of those properties could incorrectly return a new channel that did not satisfy the requirements.

The connection manager MUST NOT respond successfully, and SHOULD NOT create a new channel or cause any other side-effects, unless it can create a new channel that satisfies the client's requirements.

Properties that will be set by this argument need not have write access after the channel has been created - indeed, it is expected that most will be read-only.

Returns

Channelo
The Channel object, which MUST already have been signalled with NewChannels by the time this method returns.
Propertiesa{sv} (Qualified_Property_Value_Map)

Properties of the channel that was produced, equivalent to the properties in Channel_Details. Connection managers MUST NOT include properties here whose values can change, for the same reasons as in Channel_Details.

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotImplemented
The channel request was one that can never succeed, such as requesting an unsupported channel type, or requesting a channel type which this connection manager does not support with the given target handle type.
org.freedesktop.Telepathy.Error.InvalidHandle
An invalid handle was requested as the value of a property whose value is a handle (like Channel.TargetHandle), or a syntactically invalid identifier was requested as the value of a property whose value is the string corresponding to a handle (like TargetID).
org.freedesktop.Telepathy.Error.NotAvailable
The requested channel cannot be created, but in principle, a similar request might succeed in future. For instance, this might be because the requested contact is using a client that lacks a particular feature, or because a channel matching the request already exists and the protocol requires that only one such channel can exist at a time.
org.freedesktop.Telepathy.Error.Channel.Banned
You are banned from the channel. (generic description)
org.freedesktop.Telepathy.Error.Channel.Full
The channel is full. (generic description)
org.freedesktop.Telepathy.Error.Channel.InviteOnly
The requested channel is invite-only. (generic description)

Signals:

NewChannels ( a(oa{sv}): Channels )

New channels have been created. The connection manager SHOULD emit a single signal for any group of closely related channels that are created at the same time, so that the channel dispatcher can try to dispatch them to a handler as a unit.

In particular, if additional channels are created as a side-effect of a call to CreateChannel, these channels SHOULD appear in the same NewChannels signal as the channel that satisfies the request.

Joining a MUC Tube in XMPP requires joining the corresponding MUC (chatroom), so a Text channel can be created as a side-effect.

Parameters

Channelsa(oa{sv}) (Channel_Details[])
The channels and their details. All channels that are signalled together like this MUST have the same Bundle property, which may either refer to an existing bundle, or establish a new bundle.

ChannelClosed ( o: Removed )

Emitted when a channel is closed and hence disappears from the Channels property.
This is redundant with the Close signal on the channel itself, but it does provide full change notification for the Channels property.

Parameters

Removedo
The channel which has been removed from the Channels property

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

Channelsa(oa{sv}) (Channel_Details[]), read-only
A list of all the channels which currently exist on this connection. Change notification is via the NewChannels and ChannelClosed signals.
RequestableChannelClassesa(a{sv}as) (Requestable_Channel_Class[]), read-only

The classes of channel that are expected to be available on this connection, i.e. those for which CreateChannel can reasonably be expected to succeed. User interfaces can use this information to show or hide UI components.

This property cannot change after the connection has gone to state Connection_Status_Connected, so there is no change notification (if the connection has context-dependent capabilities, it SHOULD advertise support for all classes of channel that it might support during its lifetime). Before this state has been reached, the value of this property is undefined.

This is not on an optional interface, because connection managers can always offer some sort of clue about the channel classes they expect to support (at worst, they can announce support for everything for which they have code).

Structure types

Channel_Details − ( o: Channel, a{sv}: Properties )

Enough details of a channel that clients can work out how to dispatch or handle it.

In bindings that need a separate name, arrays of Channel_Details should be called Channel_Details_List.

Members

Channelo
The object path of the channel.
Propertiesa{sv} (Qualified_Property_Value_Map)

Properties of the channel.

Connection managers MUST NOT include properties in this mapping if their values can change. Clients MUST ignore properties that appear in this mapping if their values can change.

If properties that could change were included, the following race condition would be likely to exist in some cases:

  • NewChannels or Get("Channels") includes a property P with value V1
  • Client creates a proxy object for the channel
  • The value of P changes to V2
  • Client connects to PChanged signal
  • Client should call Get("P") or GetAll here, to avoid the race, but client's author has forgotten to do so
  • Proxy object thinks P == V1, but actually P == V2

We've taken the opportunity to make the API encourage the client author to get it right. Where possible, we intend that properties whose value will be used in channel dispatching or other "early" processing will be defined so that they are immutable (can never change).

Each dictionary MUST contain the keys org.freedesktop.Telepathy.Channel.ChannelType, org.freedesktop.Telepathy.Channel.TargetHandleType, org.freedesktop.Telepathy.Channel.TargetHandle and org.freedesktop.Telepathy.Channel.TargetID.

We expect these to be crucial to the channel-dispatching process.

Requestable_Channel_Class − ( a{sv}: Fixed_Properties, as: Allowed_Properties )

Structure representing a class of channels that can be requested, identified by a set of properties that identify that class of channel.

This will often just be the channel type and the handle type, but can include other properties of the channel - for instance, encrypted channels might require properties that unencrypted channels do not, like an encryption key.

In some cases, these classes of channel may overlap, in the sense that one class fixes all the properties that another class does, plus some more properties.

For older clients to still be able to understand how to request channels in the presence of a hypothetical "encryption" interface, we'd need to represent it like this:

  • class 1: ChannelType = Text, TargetHandleType = CONTACT
  • class 2: Channel.ChannelType = Text, Channel.TargetHandleType = CONTACT, Encryption.Encrypted = TRUE

In bindings that need a separate name, arrays of Requestable_Channel_Class should be called Requestable_Channel_Class_List.

Members

Fixed_Propertiesa{sv} (Channel_Class)

The property values that identify this requestable channel class. These properties MUST be included in requests for a channel of this class, and MUST take these values.

Clients that do not understand the semantics of all the Fixed_Properties MUST NOT request channels of this class, since they would be unable to avoid making an incorrect request.

This implies that connection managers wishing to make channels available to old or minimal clients SHOULD have a channel class with the minimum number of Fixed_Properties, and MAY additionally have channel classes with extra Fixed_Properties.

Allowed_Propertiesas (DBus_Qualified_Member[])

Properties that MAY be set when requesting a channel of this channel type and handle type.

This array MUST NOT include properties that are in the Fixed_Properties mapping.

Properties in this array may either be required or optional, according to their documented semantics.

For instance, if TargetHandleType takes a value that is not Handle_Type_None, one or the other of TargetHandle and TargetID is required. Clients are expected to understand the documented relationship between the properties, so we do not have separate arrays of required and optional properties.

If this array contains the Bundle property, then this class of channel can be combined with other channels with that property in a request, or added to an existing bundle. If not, this signifies that the connection manager is unable to mark channels of this class as part of a bundle - this means that to the remote contact they are likely to be indistinguishable from channels requested separately.

Mapping types

Channel_Class − a{ s: Key → v: Value }

Mapping representing a class of channels that can be requested from a connection manager, can be handled by a user interface, are supported by a contact, etc.

Classes of channel are identified by the fixed values of a subset of their properties.

Channel classes SHOULD always include the keys org.freedesktop.Telepathy.Channel.ChannelType and org.freedesktop.Telepathy.Channel.TargetHandleType.

Members

Keys (DBus_Qualified_Member)
A D-Bus interface name, followed by a dot and a D-Bus property name.
Valuev
The value of the property.

org.freedesktop.Telepathy.ChannelBundle.DRAFT

This interface is experimental and is likely to cause havoc to your API/ABI if bindings are generated. Don't include it in libraries that care about compatibility.

A group of related channels, which should all be dispatched to the same handler if possible.

Bundles currently have no functionality of their own, so clients SHOULD NOT examine this interface, but should instead treat the bundle object-path as an opaque identifier. If more functionality is added to bundles in future, this interface will be used for capability discovery.

The lifetime of a bundle is defined by its component channels - as long as one or more channels whose Bundle property is B exist, the bundle B will also exist.

Interface has no methods.

Interface has no signals.

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

Interfacesas (DBus_Interface[]), read-only
A list of the extra interfaces provided by this channel bundle.

org.freedesktop.Telepathy.Channel

All communication in the Telepathy framework is carried out via channel objects which are created and managed by connections. This interface must be implemented by all channel objects, along with one single channel type, such as Channel.Type.ContactList which represents a list of people (such as a buddy list) or a Channel.Type.Text which represents a channel over which textual messages are sent and received.

Each channel may have an immutable handle associated with it, which may be any handle type, such as a contact, room or list handle, indicating that the channel is for communicating with that handle.

If a channel does not have a handle (an "anonymous channel" with Target_Handle = 0 and Target_Handle_Type = Handle_Type_None), it means that the channel is defined by some other terms, such as it may be a transient group defined only by its members as visible through the Channel.Interface.Group interface.

Other optional interfaces can be implemented to indicate other available functionality, such as Channel.Interface.Group if the channel contains a number of contacts, Channel.Interface.Password to indicate that a channel may have a password set to require entry, and Properties for extra data about channels which represent chat rooms or voice calls. The interfaces implemented may not vary after the channel's creation has been signalled to the bus (with the connection's NewChannel signal).

Specific connection manager implementations may implement channel types and interfaces which are not contained within this specification in order to support further functionality. To aid interoperability between client and connection manager implementations, the interfaces specified here should be used wherever applicable, and new interfaces made protocol-independent wherever possible. Because of the potential for 3rd party interfaces adding methods or signals with conflicting names, the D-Bus interface names should always be used to invoke methods and bind signals.

Changed in version 0.17.7: Previously we guaranteed that, for any handle type other than Handle_Type_None, and for any channel type and any handle, there would be no more than one channel with that combination of channel type, handle type and handle. This guarantee has now been removed in order to accommodate features like message threads.

Methods:

Close ( ) → nothing

Request that the channel be closed. This is not the case until the Closed signal has been emitted, and depending on the connection manager this may simply remove you from the channel on the server, rather than causing it to stop existing entirely. Some channels such as contact list channels may not be closed.

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotImplemented
This channel may never be closed, e.g. a contact list
org.freedesktop.Telepathy.Error.NotAvailable
This channel is not currently in a state where it can be closed, e.g. a non-empty user-defined contact group

GetChannelType ( ) → s

Returns the interface name for the type of this channel. Clients SHOULD use the ChannelType property instead, falling back to this method only if necessary.
The GetAll method lets clients retrieve all properties in one round-trip.

Deprecated since version 0.17.7. Use the ChannelType property if possible.

Returns

s (DBus_Interface)
The interface name

GetHandle ( ) → u, u

Returns the handle type and number if this channel represents a communication with a particular contact, room or server-stored list, or zero if it is transient and defined only by its contents. Clients SHOULD use the TargetHandle and TargetHandleType properties instead, falling back to this method only if necessary.
The GetAll method lets clients retrieve all properties in one round-trip.

Deprecated since version 0.17.7. Use the TargetHandleType and TargetHandle properties if possible.

Returns

u (Handle_Type)
The same as TargetHandleType.
u (Handle)
The same as TargetHandle.

GetInterfaces ( ) → as

Get the optional interfaces implemented by the channel. Clients SHOULD use the Interfaces property instead, falling back to this method only if necessary.
The GetAll method lets clients retrieve all properties in one round-trip.

Deprecated since version 0.17.7. Use the Interfaces property if possible.

Returns

as (DBus_Interface[])
An array of the D-Bus interface names

Signals:

Closed ( )

Emitted when the channel has been closed. Method calls on the channel are no longer valid after this signal has been emitted, and the connection manager may then remove the object from the bus at any point.

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

ChannelTypes (DBus_Interface), read-only

The channel's type. This cannot change once the channel has been created.

For compatibility between older connection managers and newer clients, if this is unavailable or is an empty string, clients MUST use the result of calling GetChannelType.

The GetAll method lets clients retrieve all properties in one round-trip, which is desirable.

When requesting a channel, the request MUST specify a channel type, and the request MUST fail if the specified channel type cannot be supplied.

Common sense.

Added in version 0.17.7.

Interfacesas (DBus_Interface[]), read-only

Extra interfaces provided by this channel. This SHOULD NOT include the channel type and the Channel interface itself, and cannot change once the channel has been created.

For compatibility between older connection managers and newer clients, if this is unavailable, or if this is an empty list and ChannelType is an empty string, clients MUST use the result of calling GetInterfaces instead. If this is an empty list but ChannelType is non-empty, clients SHOULD NOT call GetInterfaces; this implies that connection managers that implement the ChannelType property MUST also implement the Interfaces property correctly.

The GetAll method lets clients retrieve all properties in one round-trip, which is desirable.

When requesting a channel with a particular value for this property, the request must fail without side-effects unless the connection manager expects to be able to provide a channel whose interfaces include at least the interfaces requested.

Added in version 0.17.7.

TargetHandleu (Handle), read-only

The handle (a representation for the identifier) of the contact, chatroom, etc. with which this handle communicates. Its type is given by the TargetHandleType property.

This is fixed for the lifetime of the channel, so channels which could potentially be used to communicate with multiple contacts (such as streamed media calls defined by their members, or ad-hoc chatrooms like MSN switchboards) must have TargetHandleType set to Handle_Type_None and TargetHandle set to 0.

Unlike in the telepathy-spec 0.16 API, there is no particular uniqueness guarantee - there can be many channels with the same (channel type, handle type, handle) tuple. This is necessary to support conversation threads in XMPP and SIP, for example.

If this is present in a channel request, it must be nonzero, TargetHandleType MUST be present and not Handle_Type_None, and TargetID MUST NOT be present.

The channel that satisfies the request MUST either:

Added in version 0.17.7.

TargetIDs, read-only

The string that would result from inspecting the TargetHandle property (i.e. the identifier in the IM protocol of the contact, room, etc. with which this channel communicates), or the empty string if the TargetHandle is 0.

The presence of this property avoids the following race condition:

  • New channel C is signalled with target handle T
  • Client calls InspectHandles(CONTACT, [T])
  • Channel C closes, removing the last reference to handle T
  • InspectHandles(CONTACT, [T]) returns an error

If this is present in a channel request, TargetHandleType MUST be present and not Handle_Type_None, and TargetHandle MUST NOT be present. The request MUST fail with error InvalidHandle, without side-effects, if the requested TargetID would not be accepted by RequestHandles.

The returned channel must be related to the handle corresponding to the given identifier, in the same way as if TargetHandle had been part of the request instead.

Requesting channels with a string identifier saves a round-trip (the call to RequestHandles). It also allows the channel dispatcher to accept a channel request for an account that is not yet connected (and thus has no valid handles), bring the account online, and pass on the same parameters to the new connection's CreateChannel method.

Added in version 0.17.9.

TargetHandleTypeu (Handle_Type), read-only

The type of TargetHandle.

If this is omitted from a channel request, connection managers SHOULD treat this as equivalent to Handle_Type_None.

If this is omitted or is Handle_Type_None, TargetHandle and TargetID MUST be omitted from the request.

Added in version 0.17.7.

org.freedesktop.Telepathy.Channel.FUTURE

This interface is a staging area for future Channel functionality and is likely to cause havoc to your API/ABI if bindings are generated. Don't include it in libraries that care about compatibility.

This interface contains functionality which we intend to incorporate into the Channel interface in future. It should be considered to be conceptually part of the core Channel interface, but without API or ABI guarantees.

If we add new functionality to the Channel interface, libraries that use generated code (notably telepathy-glib) will have it as part of their ABI forever, meaning we can't make incompatible changes. By using this interface as a staging area for future Channel functionality, we can try out new properties, signals and methods as application-specific extensions, then merge them into the core Channel interface when we have enough implementation experience to declare them to be stable.

The name is by analogy to Python's __future__ pseudo-module.

Interface has no methods.

Interface has no signals.

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

Requestedb, read-only

True if this channel was created in response to a call to Connection.RequestChannel, or Connection.Interface.Requests.DRAFT.CreateChannel.

The idea of this property is to distinguish between "incoming" and "outgoing" channels, in a way that doesn't break down when considering special cases like contact lists that are automatically created on connection to the server, or chatrooms that an IRC proxy/bouncer like irssi-proxy or bip was already in.

The reason we want to make that distinction is that UIs for things that the user explicitly requested should start up automatically, whereas for incoming messages and VoIP calls we should first ask the user whether they want to open the messaging UI or accept the call.

If the channel was not explicitly requested (even if it was created as a side-effect of a call to one of those functions, e.g. because joining a Tube in a MUC context on XMPP implies joining that MUC), then this property is false.

For compatibility with older connection managers, clients SHOULD assume that this property is true if they see a channel announced by the Connection.NewChannel signal with the suppress_handler parameter set to true.

In a correct connection manager, the only way to get such a channel is to request it.

Clients MAY additionally assume that this property is false if they see a channel announced by the NewChannel signal with the suppress_handler parameter set to false.

This is more controversial, since it's possible to get that parameter set to false by requesting a channel. However, there's no good reason to do so, and we've deprecated this practice.

In the particular case of the channel dispatcher, the only side-effect of wrongly thinking a channel is unrequested is likely to be that the user has to confirm that they want to use it, so it seems fairly harmless to assume in the channel dispatcher that channels with suppress_handler false are indeed unrequested.

InitiatorHandleu (Contact_Handle), read-only

The contact who initiated the channel. For channels requested by the local user, this MUST be the same thing as would be returned by Connection.GetSelfHandle() at the time the channel was created.

The careful wording about the self-handle is because the Renaming interface can cause the return from Connection.GetSelfHandle to change. It's something of a specification bug that we don't signal this in the Connection interface yet.

For channels requested by a remote user, this MUST be their handle. If unavailable or not applicable, this MUST be 0 (for instance, contact lists are not really initiated by anyone in particular, and it's easy to imagine a protocol where chatroom invitations can be anonymous).

For channels with the Group interface, this SHOULD be the same contact who is signalled as the "Actor" causing the self-handle to be placed in the local-pending set.

This SHOULD NOT be a channel-specific handle, if possible.

It does not make sense for this property to be in channel requests - the initiator will always be the local user - so it MUST NOT be accepted.

Added in version 0.17.7. (in Channel.FUTURE pseudo-interface)

InitiatorIDs, read-only

The string that would result from inspecting the InitiatorHandle property (i.e. the initiator's identifier in the IM protocol).

The presence of this property avoids the following race condition:

  • New StreamedMedia channel C is signalled with initiator handle I
  • Client calls InspectHandles(CONTACT, [I])
  • Channel C closes, removing the last reference to handle I
  • InspectHandles(CONTACT, [I]) returns an error
  • Client can indicate that a call was missed, but not who called!

It does not make sense for this property to be in channel requests - the initiator will always be the local user - so it MUST NOT be accepted.

Added in version 0.17.7. (in Channel.FUTURE pseudo-interface)

Bundleo, read-only

The ChannelBundle to which this channel belongs.

A channel's Bundle property can never change.

Older connection managers might not have this property. Clients (particularly the channel dispatcher) SHOULD recover by considering each channel to be in a bundle containing only that channel, distinct from all other bundles, which has no additional interfaces.

Added in version 0.17.9. (in Channel.FUTURE pseudo-interface)

org.freedesktop.Telepathy.Channel.Type.ContactList

Implementations of this interface must also implement:

A channel type for representing a list of people on the server which is not used for communication. This is intended for use with the interface Channel.Interface.Group for managing buddy lists and privacy lists on the server. This channel type has no methods because all of the functionality it represents is available via the group interface.

There are currently two types of contact list: HANDLE_TYPE_LIST is a "magic" server-defined list, and HANDLE_TYPE_GROUP is a user-defined contact group.

For server-defined lists like the subscribe list, singleton instances of this channel type should be created by the connection manager at connection time if the list exists on the server, or may be requested by using the appropriate handle. These handles can be obtained using RequestHandles with a handle type of HANDLE_TYPE_LIST and one of the following identifiers:

These contact list channels may not be closed.

For user-defined contact groups, instances of this channel type should be created by the connection manager at connection time for each group that exists on the server. New, empty groups can be created by calling RequestHandles with a handle type of HANDLE_TYPE_GROUP and with the name set to the human-readable UTF-8 name of the group.

User-defined groups may be deleted by closing the channel, but only if the group is already empty. Closing a channel to a non-empty group is not allowed; its members must be set to the empty set first.

On some protocols (e.g. XMPP) empty groups are not represented on the server, so disconnecting from the server and reconnecting might cause empty groups to vanish.

Interface has no methods.

Interface has no signals.

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

org.freedesktop.Telepathy.Channel.Type.StreamedMedia

Implementations of this interface must also implement:

A channel that can send and receive streamed media such as audio or video. Provides a number of methods for listing and requesting new streams, and signals to indicate when streams have been added, removed and changed status.

Channels of this type are expected to provide the Group interface and be "anonymous" (have no associated handle). To make a media call to a contact, clients should request a new, empty streamed media channel, then call AddMembers to add the contact to the channel. The local user should be in the group's members, while the contact should be absent from the channel until a call is made, appear in "remote pending" from when the call is attempted until the call is accepted, then move to the group's members.

Similarly, incoming calls should be signalled as having handle type 0 and handle 0. The remote contact should be in the group's members, with the local user in the "local pending" members; to accept the call, AddMembers can be used to move the local user to the group's members.

In general this should be used in conjunction with the MediaSignalling interface to exchange connection candidates and codec choices with whichever component is responsible for the streams. However, in certain applications where no candidate exchange is necessary (eg the streams are handled by specialised hardware which is controlled directly by the connection manager), the signalling interface can be omitted and this channel type used simply to control the streams.

Methods:

ListStreams ( ) → a(uuuuuu)

Returns an array of structs representing the streams currently active within this channel. Each stream is identified by an unsigned integer which is unique for each stream within the channel.

Returns

a(uuuuuu) (Media_Stream_Info[])
An array of structs containing:
  • the stream identifier
  • the contact handle who the stream is with (or 0 if the stream represents more than a single member)
  • the type of the stream
  • the current stream state
  • the current direction of the stream
  • the current pending send flags

RemoveStreams ( au: streams ) → nothing

Request that the given streams are removed.

Parameters

streamsau (Stream_ID[])
An array of stream identifiers (as defined in ListStreams)

Possible errors

org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)

RequestStreamDirection ( u: stream_id, u: stream_direction ) → nothing

Request a change in the direction of an existing stream. In particular, this might be useful to stop sending media of a particular type, or inform the peer that you are no longer using media that is being sent to you.

Depending on the protocol, streams which are no longer sending in either direction should be removed and a StreamRemoved signal emitted. Some direction changes can be enforced locally (for example, BIDIRECTIONAL -> RECEIVE can be achieved by merely stopping sending), others may not be possible on some protocols, and some need agreement from the remote end. In this case, the MEDIA_STREAM_PENDING_REMOTE_SEND flag will be set in the StreamDirectionChanged signal, and the signal emitted again without the flag to indicate the resulting direction when the remote end has accepted or rejected the change.

Parameters

stream_idu
The stream identifier (as defined in ListStreams)
stream_directionu (Media_Stream_Direction)
The desired stream direction (a value of MediaStreamDirection)

Possible errors

org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)

RequestStreams ( u: contact_handle, au: types ) → a(uuuuuu)

Request that streams be established to exchange the given types of media with the given member. In general this will try and establish a bidirectional stream, but on some protocols it may not be possible to indicate to the peer that you would like to receive media, so a send-only stream will be created initially. In the cases where the stream requires remote agreement (eg you wish to receive media from them), the StreamDirectionChanged signal will be emitted with the MEDIA_STREAM_PENDING_REMOTE_SEND flag set, and the signal emitted again with the flag cleared when the remote end has replied.

Changed in version 0.17.2: It is valid to use a handle which is neither a current nor pending member in this channel's Group interface. If so, that handle will be added to the remote-pending set only when an attempt has actually been made to contact them. For further call-state notification, use the CallState interface, if supported. This usage was not allowed in spec versions below 0.17.2.

Parameters

contact_handleu (Contact_Handle)
A contact handle with whom to establish the streams
typesau (Media_Stream_Type[])
An array of stream types (values of MediaStreamType)

Returns

a(uuuuuu) (Media_Stream_Info[])
An array of structs (in the same order as the given stream types) containing:
  • the stream identifier
  • the contact handle who the stream is with (or 0 if the stream represents more than a single member)
  • the type of the stream
  • the current stream state
  • the current direction of the stream
  • the current pending send flags

Possible errors

org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)

Signals:

StreamAdded ( u: stream_id, u: contact_handle, u: stream_type )

Emitted when a new stream has been added to this channel.

Parameters

stream_idu
The stream identifier (as defined in ListStreams)
contact_handleu (Contact_Handle)
The contact handle who the stream is with (or 0 if it represents more than a single member)
stream_typeu (Media_Stream_Type)
The stream type (a value from MediaStreamType)

StreamDirectionChanged ( u: stream_id, u: stream_direction, u: pending_flags )

Emitted when the direction or pending flags of a stream are changed. If the MEDIA_STREAM_PENDING_LOCAL_SEND flag is set, the remote user has requested that we begin sending on this stream. RequestStreamDirection should be called to indicate whether or not this change is acceptable.

Parameters

stream_idu
The stream identifier (as defined in ListStreams)
stream_directionu (Media_Stream_Direction)
The new stream direction (as defined in ListStreams)
pending_flagsu (Media_Stream_Pending_Send)
The new pending send flags (as defined in ListStreams)

StreamError ( u: stream_id, u: errno, s: message )

Emitted when a stream encounters an error.

Parameters

stream_idu
The stream identifier (as defined in ListStreams)
errnou
A stream error number, one of the values of MediaStreamError
messages
A string describing the error (for debugging purposes only)

StreamRemoved ( u: stream_id )

Emitted when a stream has been removed from this channel.

Parameters

stream_idu
stream_id - the stream identifier (as defined in ListStreams)

StreamStateChanged ( u: stream_id, u: stream_state )

Emitted when a member's stream's state changes.

Parameters

stream_idu
The stream identifier (as defined in ListStreams)
stream_stateu (Media_Stream_State)
The new stream state (as defined in ListStreams)

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Simple types

Stream_ID − u

Enumerated types:

Media_Stream_Type

Media_Stream_Type_Audio = 0
An audio stream
Media_Stream_Type_Video = 1
A video stream

Media_Stream_State

Media_Stream_State_Disconnected = 0
The stream is disconnected.
Media_Stream_State_Connecting = 1
The stream is trying to connect.
Media_Stream_State_Connected = 2
The stream is connected.

Media_Stream_Direction

Media_Stream_Direction_None = 0
Media are not being sent or received
Media_Stream_Direction_Send = 1
Media are being sent, but not received
Media_Stream_Direction_Receive = 2
Media are being received, but not sent
Media_Stream_Direction_Bidirectional = 3
Media are being sent and received

Sets of flags:

Media_Stream_Pending_Send

Media_Stream_Pending_Local_Send = 1
The local user has been asked to send media by the remote user. Call RequestStreamDirection to indicate whether or not this is acceptable.
Media_Stream_Pending_Remote_Send = 2
The remote user has been asked to send media by the local user. The StreamDirectionChanged signal will be emitted when the remote user accepts or rejects this change.

Channel_Media_Capabilities

The channel-type-specific capability flags used for Channel.Type.StreamedMedia in the Connection.Interface.Capabilities interface.
Channel_Media_Capability_Audio = 1
The handle is capable of using audio streams within a media channel.
Channel_Media_Capability_Video = 2
The handle is capable of using video streams within a media channel.
Channel_Media_Capability_NAT_Traversal_STUN = 4
The handle is capable of performing STUN to traverse NATs.
Channel_Media_Capability_NAT_Traversal_GTalk_P2P = 8
The handle is capable of establishing Google Talk peer-to-peer connections (as implemented in libjingle 0.3) to traverse NATs.

Structure types

Media_Stream_Info − ( u: Identifier, u: Contact, u: Type, u: State, u: Direction, u: Pending_Send_Flags )

In bindings that need a separate name, arrays of Media_Stream_Info should be called Media_Stream_Info_List.

Members

Identifieru (Stream_ID)
(undocumented)
Contactu (Contact_Handle)
(undocumented)
Typeu (Media_Stream_Type)
(undocumented)
Stateu (Media_Stream_State)
(undocumented)
Directionu (Media_Stream_Direction)
(undocumented)
Pending_Send_Flagsu (Media_Stream_Pending_Send)
(undocumented)

org.freedesktop.Telepathy.Channel.Type.RoomList

Implementations of this interface must also implement:

A channel type for listing named channels available on the server. Once the ListRooms method is called, it emits signals for rooms present on the server, until you Close this channel. In some cases, it may not be possible to stop the deluge of information from the server. This channel should be closed when the room information is no longer being displayed, so that the room handles can be freed.

This channel type may be implemented as a singleton on some protocols, so clients should be prepared for the eventuality that they are given a channel that is already in the middle of listing channels. The ListingRooms signal, or GetListingRooms method, can be used to check this.

Methods:

GetListingRooms ( ) → b

Check to see if there is already a room list request in progress on this channel.

Returns

b
A boolean indicating if room listing is in progress

ListRooms ( ) → nothing

Request the list of rooms from the server. The ListingRooms signal should be emitted when this request is being processed, GotRooms when any room information is received, and ListingRooms when the request is complete.

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)

StopListing ( ) → nothing

Stop the room listing if it's in progress, but don't close the channel. The ListingRooms signal should be emitted when the listing stops.

Signals:

GotRooms ( a(usa{sv}): rooms )

Emitted when information about rooms on the server becomes available. The array contains the room handle (as can be passed to the RequestChannel method with HANDLE_TYPE_ROOM), the channel type, and a dictionary containing further information about the room as available. The following well-known keys and types are recommended for use where appropriate:

s:handle-name
The string name of the room handle (as would be returned by InspectHandles)
s:name
The human-readable name of the room if different from the handle
s:description
A description of the room's overall purpose
s:subject
The current subject of conversation in the room
u:members
The number of members of the room
b:password
True if the room requires a password to enter
b:invite-only
True if you cannot join the room, but must be invited

Parameters

roomsa(usa{sv}) (Room_Info[])
An array of structs containing:
  • an integer room handle
  • a string representing the D-Bus interface name of the channel type
  • a dictionary mapping string keys to variant boxed information

ListingRooms ( b: listing )

Emitted to indicate whether or not room listing request is currently in progress.

Parameters

listingb
A boolean indicating if room listing is in progress

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

Servers, read-only
For protocols with a concept of chatrooms on multiple servers with different DNS names (like XMPP), the DNS name of the server whose rooms are listed by this channel, e.g. "conference.jabber.org". Otherwise, the empty string. This property cannot change during the lifetime of the channel.

Structure types

Room_Info − ( u: Handle, s: Channel_Type, a{sv}: Info )

In bindings that need a separate name, arrays of Room_Info should be called Room_Info_List.

Members

Handleu (Room_Handle)
(undocumented)
Channel_Types (DBus_Interface)
(undocumented)
Infoa{sv} (String_Variant_Map)
(undocumented)

org.freedesktop.Telepathy.Channel.Type.Text

Implementations of this interface must also implement:

A channel type for sending and receiving messages in plain text, with no formatting. In future specifications, channels for sending and receiving messages that can be reduced to plain text (i.e. formatted text) should also have this type.

When a message is received, an identifier is assigned and a Received signal emitted, and the message placed in a pending queue which can be inspected with ListPendingMessages. A client which has handled the message by showing it to the user (or equivalent) should acknowledge the receipt using the AcknowledgePendingMessage method, and the message will then be removed from the pending queue. Numeric identifiers for received messages may be reused over the lifetime of the channel.

Each message has an associated 'type' value, which should be one of the values allowed by ChannelTextMessageType.

Each message also has a flags value, which is a bitwise OR of the flags given in ChannelTextMessageFlags.

Sending messages can be requested using the Send method, which will return successfully and emit the Sent signal when the message has been delivered to the server, or return an error with no signal emission if there is a failure. If a message is sent but delivery of the message later fails, this is indicated with the SendError signal.

On protocols where additional contacts cannot be invited into a one-to-one chat, or where a one-to-one chat is just a series of individual personal messages rather than being represented by some object on the server (i.e. most protocols), one-to-one chats should be represented by a Text channel with handle type CONTACT.

Named chat rooms whose identity can be saved and used again later (IRC channels, Jabber MUCs) are expected to be represented by Text channels with handle type ROOM and the Group interface; they should usually also have the Properties interface.

Unnamed, transient chat rooms defined only by their members (e.g. on MSN) are expected to be represented by Text channels with handle type 0, handle 0, the Group interface, and optionally the Properties interface.

On protocols where a conversation with a user is actually just a nameless chat room starting with exactly two members, to which more members can be invited, calling RequestChannel with type Text and handle type CONTACT should continue to succeed, but may return a channel with handle type 0, handle 0, the group interface, and the local and remote contacts in its members.

Methods:

AcknowledgePendingMessages ( au: ids ) → nothing

Inform the channel that you have handled messages by displaying them to the user (or equivalent), so they can be removed from the pending queue.

Parameters

idsau (Message_ID[])
The IDs of the messages to acknowledge

Possible errors

org.freedesktop.Telepathy.Error.InvalidArgument
A given message ID was not found, so no action was taken

GetMessageTypes ( ) → au

Return an array indicating which types of message may be sent on this channel.

Returns

au (Channel_Text_Message_Type[])
An array of integer message types (ChannelTextMessageType)

ListPendingMessages ( b: clear ) → a(uuuuus)

List the messages currently in the pending queue, and optionally remove then all.

Parameters

clearb
If true, behave as if AcknowledgePendingMessages had also been called.

Returns

a(uuuuus) (Pending_Text_Message[])
An array of structs representing the pending queue. Each contains:
  • a numeric identifier
  • a Unix timestamp indicating when the message was received
  • the contact handle for the contact who sent the message
  • the message type, taken from ChannelTextMessageType
  • the bitwise-OR of the message flags from ChannelTextMessageFlags
  • the text of the message

Send ( u: type, s: text ) → nothing

Request that a message be sent on this channel. When the message has been submitted for delivery, this method will return and the Sent signal will be emitted. If the message cannot be submitted for delivery, the method returns an error and no signal is emitted.

Parameters

typeu (Channel_Text_Message_Type)
An integer indicating the type of the message
texts
The message to send

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)

Signals:

LostMessage ( )

This signal is emitted to indicate that an incoming message was not able to be stored and forwarded by the connection manager due to lack of memory.

Received ( u: id, u: timestamp, u: sender, u: type, u: flags, s: text )

Signals that a message with the given id, timestamp, sender, type and text has been received on this channel. Applications that catch this signal and reliably inform the user of the message should acknowledge that they have dealt with the message with the AcknowledgePendingMessage method.

Parameters

idu
A numeric identifier for acknowledging the message
timestampu (Unix_Timestamp)
A Unix timestamp indicating when the message was received
senderu (Contact_Handle)
The handle of the contact who sent the message
typeu (Channel_Text_Message_Type)
The type of the message (normal, action, notice, etc.)
flagsu (Channel_Text_Message_Flags)
A bitwise OR of the message flags
texts
The text of the message

SendError ( u: error, u: timestamp, u: type, s: text )

Signals that an outgoing message has failed to send. The error will be one of the values from ChannelTextSendError.

This signal should only be emitted for messages for which Sent has already been emitted and Send has already returned success.

Changed in version 0.17.3: older spec versions claimed that SendError was emitted instead of Sent, rather than in addition to Sent. However, the 0.17.3+ semantics were what we'd always actually implemented.

Parameters

erroru (Channel_Text_Send_Error)
The error that occurred
timestampu (Unix_Timestamp)
The Unix timestamp indicating when the message was sent
typeu (Channel_Text_Message_Type)
The message type
texts
The text of the message

Sent ( u: timestamp, u: type, s: text )

Signals that a message has been submitted for sending.

Parameters

timestampu (Unix_Timestamp)
Unix timestamp indicating when the message was sent
typeu (Channel_Text_Message_Type)
The message type (normal, action, notice, etc) from ChannelTextMessageType
texts
The text of the message

Telepathy Properties:

Accessed using the Telepathy Properties interface.

anonymousb
True if people may join the channel without other members being made aware of their identity.
invite-onlyb
True if people may not join the channel until they have been invited.
limitu
The limit to the number of members, if limited is true.
limitedb
True if there is a limit to the number of channel members.
moderatedb
True if channel membership is not sufficient to allow participation.
names
A human-visible name for the channel, if it differs from the string version of the channel's handle.
descriptions
A human-readable description of the channel's overall purpose.
passwords
The password required to enter the channel if password-required is true.
password-requiredb
True if a password must be provided to enter the channel.
persistentb
True if the channel will remain in existence on the server after all members have left it.
privateb
True if the channel is not visible to non-members.
subjects
A human-readable description of the current subject of conversation in the channel, similar to /topic in IRC.
subject-contactu
A contact handle representing who last modified the subject, or 0 if it isn't known.
subject-timestampu
A unix timestamp indicating when the subject was last modified.

Interface has no D-Bus core properties.

Simple types

Message_ID − u

A unique-per-channel identifier for an incoming message. These SHOULD be allocated in a way that minimizes collisions (in particular, message IDs SHOULD NOT be re-used until all of the 32-bit integer space has already been used).

Enumerated types:

Channel_Text_Send_Error

Channel_Text_Send_Error_Unknown = 0
An unknown error occurred
Channel_Text_Send_Error_Offline = 1
The requested contact was offline
Channel_Text_Send_Error_Invalid_Contact = 2
The requested contact is not valid
Channel_Text_Send_Error_Permission_Denied = 3
The user does not have permission to speak on this channel
Channel_Text_Send_Error_Too_Long = 4
The outgoing message was too long and was rejected by the server
Channel_Text_Send_Error_Not_Implemented = 5
The channel doesn't support sending text messages to the requested contact

Channel_Text_Message_Type

The type of message.
Channel_Text_Message_Type_Normal = 0
An ordinary chat message. Unknown types SHOULD be treated like this.
Channel_Text_Message_Type_Action = 1
An action which might be presented to the user as "* <sender> <action>", such as an IRC CTCP ACTION (typically selected by the "/me" command). For example, the text of the message might be "drinks more coffee".
Channel_Text_Message_Type_Notice = 2
A one-off or automated message not necessarily expecting a reply
Channel_Text_Message_Type_Auto_Reply = 3
An automatically-generated reply message.
Channel_Text_Message_Type_Delivery_Report = 4
This message type MUST NOT appear unless the channel supports the DeliveryReporting interface. The message MUST be as defined by the DeliveryReporting interface.

Sets of flags:

Channel_Text_Message_Flags

Channel_Text_Message_Flag_Truncated = 1
The incoming message was truncated to a shorter length by the server or the connection manager.
Channel_Text_Message_Flag_Non_Text_Content = 2

The incoming message contained non-text content which cannot be represented by this interface, but has been signalled in the Messages interface.

Connection managers SHOULD only set this flag if the non-text content appears to be relatively significant (exactly how significant is up to the implementor). The intention is that if this flag is set, clients using this interface SHOULD inform the user that part of the message was not understood.

Structure types

Pending_Text_Message − ( u: Identifier, u: Unix_Timestamp, u: Sender, u: Message_Type, u: Flags, s: Text )

A struct (message ID, timestamp in seconds since 1970-01-01 00:00 UTC, sender's handle, message type, flags, text) representing a pending text message, as returned by ListPendingMessages on the Text channel type. The arguments of the Received signal also match this struct's signature.

In bindings that need a separate name, arrays of Pending_Text_Message should be called Pending_Text_Message_List.

Members

Identifieru (Message_ID)
(undocumented)
Unix_Timestampu (Unix_Timestamp)
(undocumented)
Senderu (Contact_Handle)
(undocumented)
Message_Typeu (Channel_Text_Message_Type)
(undocumented)
Flagsu (Channel_Text_Message_Flags)
(undocumented)
Texts
(undocumented)

org.freedesktop.Telepathy.Channel.Type.Tubes

Implementations of this interface must also implement:

A "tube" is a mechanism for arbitrary data transfer. Two types of data transfer are currently specified: D-Bus messages, and streams of bytes. Each tube has a service name, which is a string specifying the kind of communication that takes place over it, and a dictionary of arbitrary parameters. Tube parameters are commonly used for bootstrap information such as usernames and passwords. Each tube is identified by a locally unique identifier.

The Tubes channel type may be requested for handles of type HANDLE_TYPE_CONTACT and HANDLE_TYPE_ROOM.

Stream tubes specify listening addresses using pairs of parameters with signature 'u', 'v', where the integer 'u' is a member of Socket_Address_Type and the v is dependent on the type of address.

Methods:

GetAvailableStreamTubeTypes ( ) → a{uau}

List the available address types and access-control types for stream tubes.

Returns

a{uau} (Supported_Socket_Map)

A mapping from address types (members of Socket_Address_Type) to arrays of access-control type (members of Socket_Access_Control) that the connection manager supports for stream tubes with that address type. For simplicity, if a CM supports offering a particular type of tube, it is assumed to support accepting it.

A typical value for a host without IPv6 support:

            {
              Socket_Address_Type_IPv4:
                [Socket_Access_Control_Localhost, Socket_Access_Control_Port,
                 Socket_Access_Control_Netmask],
              Socket_Address_Type_Unix:
                [Socket_Access_Control_Localhost, Socket_Access_Control_Credentials]
            }
          

If stream tubes are not supported, this will be an empty dictionary.

GetAvailableTubeTypes ( ) → au

Returns

au (Tube_Type[])
An array of the available tube types, as defined by the Tube_Type enum.

ListTubes ( ) → a(uuusa{sv}u)

Returns

a(uuusa{sv}u) (Tube_Info[])
Return an array of tuples, each representing a tube, with the following members: the tube's ID the tube's initiator the tube's type the tube's service the tube's parameters the tube's state

OfferDBusTube ( s: service, a{sv}: parameters ) → u

Offers a D-Bus tube providing the service specified.

Parameters

services
A string representing the service name that will be used over the tube. It should be a well-known D-Bus service name, of the form com.example.ServiceName.
parametersa{sv} (String_Variant_Map)
A dictionary of properties for the new tube; the allowable keys, types and values are defined by the service. Connection managers must support the value being any primitive (non-container) D-Bus type, or a byte array 'ay'.

Returns

u (Tube_ID)
The ID of the new tube.

Possible errors

org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
The contact associated with this channel doesn't have tubes capabilities.
org.freedesktop.Telepathy.Error.NotImplemented
The connection manager doesn't support D-Bus tubes.

OfferStreamTube ( s: service, a{sv}: parameters, u: address_type, v: address, u: access_control, v: access_control_param ) → u

Offer a stream tube exporting the local socket specified.

Parameters

services
A string representing the service name that will be used over the tube. It should be a well-known TCP service name as defined by http://www.iana.org/assignments/port-numbers or http://www.dns-sd.org/ServiceTypes.html, for instance "rsync" or "daap".
parametersa{sv} (String_Variant_Map)

A dictionary of properties for the new tube; the allowable keys, types and values are defined by the service. Connection managers must support the value being any primitive (non-container) D-Bus type, or a byte array 'ay'.

These should usually be the same key-value pairs specified for use in the DNS-SD TXT record for that service.

address_typeu (Socket_Address_Type)
The type of the listening address of the local service, as a member of Socket_Address_Type.
addressv
The listening address of the local service, as indicated by the address_type.
access_controlu (Socket_Access_Control)
The access control the local service applies to the local socket, specified so the connection manager can behave appropriately when it connects.
access_control_paramv
A parameter for the access control type, to be interpreted as specified in the documentation for the Socket_Access_Control enum.

Returns

u (Tube_ID)
The ID of the new tube.

Possible errors

org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
The contact associated with this channel doesn't have tube capabilities.
org.freedesktop.Telepathy.Error.NotImplemented
The connection manager doesn't support stream tubes, or does not support the given address type or access-control type.

AcceptDBusTube ( u: id ) → s

Accept a D-Bus tube that's in the "local pending" state. The connection manager will attempt to open the tube. The tube remains in the "local pending" state until the TubeStateChanged signal is emitted.

Parameters

idu (Tube_ID)
The ID of the tube to accept.

Returns

addresss
The string describing the address of the private bus. The client should not attempt to connect to the address until the tube is open.

Possible errors

org.freedesktop.Telepathy.Error.InvalidArgument
The given tube ID is invalid or does not refer to a D-Bus tube.

AcceptStreamTube ( u: id, u: address_type, u: access_control, v: access_control_param ) → v

Accept a stream tube that's in the "local pending" state. The connection manager will attempt to open the tube. The tube remains in the "local pending" state until the TubeStateChanged signal is emitted.

Parameters

idu (Tube_ID)
The ID of the tube to accept.
address_typeu (Socket_Address_Type)
The type of address the connection manager should listen on.
access_controlu (Socket_Access_Control)
The type of access control the connection manager should apply to the socket.
access_control_paramv
A parameter for the access control type, to be interpreted as specified in the documentation for the Socket_Access_Control enum.

Returns

addressv
The address on which the connection manager will listen for connections to this tube. The client should not attempt to connect to the address until the tube is open.

Possible errors

org.freedesktop.Telepathy.Error.InvalidArgument
The given tube ID is invalid or does not refer to a stream tube.
org.freedesktop.Telepathy.Error.NotImplemented
The given address type or access-control mechanism is not supported.

CloseTube ( u: id ) → nothing

Close a tube.

Parameters

idu (Tube_ID)
The ID of the tube to close.

Possible errors

org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)

GetDBusTubeAddress ( u: id ) → s

For a D-Bus tube, return a string describing the address of the private bus.

Parameters

idu (Tube_ID)
The ID of the tube to get an address for.

Returns

s
The bus address.

Possible errors

org.freedesktop.Telepathy.Error.InvalidArgument
The tube is not a D-Bus tube.
org.freedesktop.Telepathy.Error.NotAvailable
This tube is not in the "open" state.

GetDBusNames ( u: id ) → a(us)

For a multi-user (i.e. Handle_Type_Room) D-Bus tube, obtain a mapping between contact handles and their unique bus names on this tube.

Parameters

idu (Tube_ID)
The ID of the tube to get names for.

Returns

a(us) (DBus_Tube_Member[])
An array of structures, each containing a contact handle and a D-Bus bus name.

Possible errors

org.freedesktop.Telepathy.Error.InvalidArgument
The tube is not a multi-user D-Bus tube.
org.freedesktop.Telepathy.Error.NotAvailable
This tube is not in the "open" state.

GetStreamTubeSocketAddress ( u: id ) → u, v

For a stream tube, obtain the address of the socket used to communicate over this tube.

Parameters

idu (Tube_ID)
The ID of the stream tube to get the socket for.

Returns

address_typeu (Socket_Address_Type)
The type of the listening address of the socket, as a member of Socket_Address_Type.
addressv
The listening address of the socket, as indicated by the address_type.

Possible errors

org.freedesktop.Telepathy.Error.InvalidArgument
The tube is not a stream tube.
org.freedesktop.Telepathy.Error.NotAvailable
This tube is not in the "open" state.

Signals:

NewTube ( u: id, u: initiator, u: type, s: service, a{sv}: parameters, u: state )

Emitted when a tube is created.

Parameters

idu (Tube_ID)
The ID of the new tube.
initiatoru (Contact_Handle)
The handle of the contact who initiated the tube.
typeu (Tube_Type)
The tube type, as defined by the Tube_Type enum.
services
A string representing the service that will be used over the tube.
parametersa{sv} (String_Variant_Map)
The new tube's properties.
stateu (Tube_State)
The new tube's state.

TubeStateChanged ( u: id, u: state )

Emitted when the state of a tube changes.

Parameters

idu (Tube_ID)
The ID of the tube that changed state.
stateu (Tube_State)
The new state of the tube; see the Tube_State enumeration.

TubeClosed ( u: id )

Emitted when a tube has been closed. The ID of a closed tube is no longer valid. The ID may later be reused for a new tube.

Parameters

idu (Tube_ID)
The ID of the tube that was closed.

DBusNamesChanged ( u: id, a(us): added, au: removed )

Emitted on a multi-user (i.e. Handle_Type_Room) D-Bus tube when a participant opens or closes the tube.

Parameters

idu (Tube_ID)
The ID of the tube whose names have changed.
addeda(us) (DBus_Tube_Member[])
Array of handles and D-Bus names of new participants.
removedau (Contact_Handle[])
Array of handles of former participants.

StreamTubeNewConnection ( u: id, u: handle )

Emitted on a stream tube when a participant opens a new connection to its socket.

Parameters

idu (Tube_ID)
The ID of the tube
handleu (Contact_Handle)
The handle of the participant who opened the new connection

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Simple types

Tube_ID − u

An identifier for a tube. These are local to a Tubes channel, and may not be assumed to be the same as the other participants' idea of the tube identifier.

Enumerated types:

Tube_Type

Tube_Type_DBus = 0

An ordered reliable transport, for transporting D-Bus traffic.

For each D-Bus tube, the connection manager listens on a D-Bus server address, as detailed in the D-Bus specification. On this address, it emulates a bus upon which each tube participant appears as an endpoint.

The objects and interfaces which are expected to exist on the emulated bus depend on the well-known name; typically, either the participant who initiated the tube is expected to export the same objects/interfaces that would be exported by a service of that name on a bus, or all participants are expected to export those objects/interfaces.

In a multi-user context (Handle_Type_Room) the tube behaves like the D-Bus bus daemon, so participants can send each other private messages, or can send broadcast messages which are received by everyone in the tube (including themselves). Each participant has a D-Bus unique name; connection managers must prevent participants from sending messages with the wrong sender unique name, and should attempt to avoid participants receiving messages not intended for them.

In a 1-1 context (Handle_Type_Contact) the tube behaves like a peer-to-peer D-Bus connection - arbitrary D-Bus messages with any sender and/or destination can be sent by each participant, and each participant receives all messages sent by the other participant.

Tube_Type_Stream = 1

A transport for ordered, reliable data transfer, similar to SOCK_STREAM sockets.

When accepting a Stream Unix tube, a new listening local socket is created. Each time the client connects to this socket, the connection manager of the initiator of the tube opens a new connection to its local socket. Both sides can then use this pair of sockets to communicate together.

Tube_State

Tube_State_Local_Pending = 0
The tube is waiting to be accepted/closed locally.
Tube_State_Remote_Pending = 1
The tube is waiting to be accepted/closed remotely.
Tube_State_Open = 2
The tube is open for traffic.

Socket_Address_Type

Socket_Address_Type_Unix = 0
A Unix socket. The variant contains a byte-array, signature 'ay', containing the path of the socket.
Socket_Address_Type_Abstract_Unix = 1
An abstract Unix socket. The variant contains a byte-array, signature 'ay', containing the path of the socket including the leading null byte.
Socket_Address_Type_IPv4 = 2
An IPv4 socket. The variant contains a Socket_Address_IPv4, i.e. a structure with signature (sq) in which the string is an IPv4 dotted-quad address literal (and must not be a DNS name), while the 16-bit unsigned integer is the port number.
Socket_Address_Type_IPv6 = 3
An IPv6 socket. The variant contains a Socket_Address_IPv6, i.e. a structure with signature (sq) in which the string is an IPv6 address literal as specified in RFC2373 (and must not be a DNS name), while the 16-bit unsigned integer is the port number.

Socket_Access_Control

Socket_Access_Control_Localhost = 0
The IP or Unix socket can be accessed by any local user (e.g. a Unix socket that accepts all local connections, or an IP socket listening on 127.0.0.1 (or ::1) or rejecting connections not from that address). The associated variant must be ignored.
Socket_Access_Control_Port = 1
May only be used on IP sockets. The associated variant must contain a struct Socket_Address_IPv4 (or Socket_Address_IPv6) containing the string form of an IP address of the appropriate version, and a port number. The socket can only be accessed if the connecting process has that address and port number; all other connections will be rejected.
Socket_Access_Control_Netmask = 2
May only be used on IP sockets. The associated variant must contain a struct Socket_Netmask_IPv4 (or Socket_Netmask_IPv6) with signature (sy), containing the string form of an IP address of the appropriate version, and a prefix length "n". The socket can only be accessed if the first n bits of the connecting address match the first n bits of the given address.
Socket_Access_Control_Credentials = 3

The connecting process must send a single zero (NUL) byte when it first connects, which is not considered to be part of the data stream. If the operating system uses sendmsg() with SCM_CREDS or SCM_CREDENTIALS to pass credentials over sockets, the connecting process must do so if possible; if not, it must still send the byte.

The listening process will disconnect the connection unless it can determine by OS-specific means that the connecting process has the same user ID as the listening process.

The associated variant must be ignored.

Structure types

Tube_Info − ( u: Identifier, u: Initiator, u: Type, s: Service, a{sv}: Parameters, u: State )

A struct (tube ID, initiator handle, tube type, service name, parameters, state) representing a tube, as returned by ListTubes on the Tubes channel type.

In bindings that need a separate name, arrays of Tube_Info should be called Tube_Info_List.

Members

Identifieru (Tube_ID)
(undocumented)
Initiatoru (Contact_Handle)
(undocumented)
Typeu (Tube_Type)
(undocumented)
Services
(undocumented)
Parametersa{sv} (String_Variant_Map)
(undocumented)
Stateu (Tube_State)
(undocumented)

DBus_Tube_Member − ( u: Handle, s: Unique_Name )

A struct (handle, unique name) representing a participant in a D-Bus tube, as returned by GetDBusNames on the Tubes channel type, and as seen in the DBusNamesChanged signal.

In bindings that need a separate name, arrays of DBus_Tube_Member should be called DBus_Tube_Member_List.

Members

Handleu (Contact_Handle)
(undocumented)
Unique_Names (DBus_Unique_Name)
(undocumented)

Socket_Address_IPv4 − ( s: Address, q: Port )

An IPv4 address and port.

Arrays of Socket_Address_IPv4 don't generally make sense.

Members

Addresss
A dotted-quad IPv4 address literal: four ASCII decimal numbers, each between 0 and 255 inclusive, e.g. "192.168.0.1".
Portq
The TCP or UDP port number.

Socket_Address_IPv6 − ( s: Address, q: Port )

An IPv6 address and port.

Arrays of Socket_Address_IPv6 don't generally make sense.

Members

Addresss
An IPv6 address literal as specified by RFC2373 section 2.2, e.g. "2001:DB8::8:800:200C:4171".
Portq
The TCP or UDP port number.

Socket_Netmask_IPv4 − ( s: Address, y: Prefix_Length )

An IPv4 network or subnet.

Arrays of Socket_Netmask_IPv4 don't generally make sense.

Members

Addresss
A dotted-quad IPv4 address literal: four ASCII decimal numbers, each between 0 and 255 inclusive, e.g. "192.168.0.1".
Prefix_Lengthy
The number of leading bits of the address that must match, for this netmask to be considered to match an address.

Socket_Netmask_IPv6 − ( s: Address, y: Prefix_Length )

An IPv6 network or subnet.

Arrays of Socket_Netmask_IPv6 don't generally make sense.

Members

Addresss
An IPv6 address literal as specified by RFC2373 section 2.2, e.g. "2001:DB8::8:800:200C:4171".
Prefix_Lengthy
The number of leading bits of the address that must match, for this netmask to be considered to match an address.

Mapping types

Supported_Socket_Map − a{ u: Address_Type → au: Access_Control }

The supported socket address and access-control types for tubes. See GetAvailableStreamTubeTypes.

Members

Address_Typeu (Socket_Address_Type)
(undocumented)
Access_Controlau (Socket_Access_Control[])
(undocumented)

org.freedesktop.Telepathy.Channel.Type.FileTransfer.DRAFT

This interface is experimental and is likely to cause havoc to your API/ABI if bindings are generated. Don't include it in libraries that care about compatibility.

Implementations of this interface must also implement:

A channel type for files offered for transferring. The transmission of data between contacts is achieved by reading from or writing to a socket. The type of the socket (local Unix, IPv4, etc.) is decided on when the file transfer is offered or accepted. The Telepathy client should connect to the socket or address that the connection manager has set up and provided back to the clients through the two methods. In order to send a file, one should request a FileTransfer channel for a contact, and fill the mandatory properties (Filename, and Size). After these are set, one should call OfferFile to offer the transfer to the contact. In order to receive an incoming file transfer, one should call AcceptFile and then wait until the state changes to Open. At this point, the receiver must check the InitialOffset property for a difference in offset from the requested value in AcceptFile. If something goes wrong with the transfer, Channel.Close should be called on the channel. The File channel type may be requested for handles of type HANDLE_TYPE_CONTACT. If the channel is requested for any other handle type then the behaviour is undefined.

Methods:

AcceptFile ( u: Address_type, u: Access_control, v: Access_control_param, t: Offset ) → v

Accept a file transfer that's in the Local_Pending state. The file transfer's state becomes Accepted after this method is called. At this point, the receiver must wait for the state to change to Open, and then InitialOffset should be checked in case its value differs from the offset that was specified as an argument to AcceptFile.

Parameters

Address_typeu (Socket_Address_Type)
The type of address the connection manager should listen on.
Access_controlu (Socket_Access_Control)
The type of access control the connection manager should apply to the socket.
Access_control_paramv
A parameter for the access control type, to be interpreted as specified in the documentation for the Socket_Access_Control enum.
Offsett
The desired offset in bytes where the file transfer should start. The offset is taken from the beginning of the file. Specifying an offset of zero will start the transfer from the beginning of the file. The offset that is actually given in the InitialOffset property can differ from this argument where the requested offset is not supported. (For example, some protocols do not support offsets at all so the InitialOffset property will always be 0.)

Returns

Addressv
The address on which the connection manager will listen for connections for this file transfer.

Possible errors

org.freedesktop.Telepathy.Error.NotImplemented
The given address type or access-control mechanism is not supported.
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
The file transfer is not in the Local_Pending state, there isn't or there is a local error with acquiring a socket.

OfferFile ( u: Address_Type, u: Access_Control, v: Access_Control_Param ) → v

Offer a file transfer that's in the Not_Offered state. Open a socket that the client can use to provide a file to the connection manager. The channel MUST be in the Not_Offered state, and will change state to Remote_Pending when this method is called.

Parameters

Address_Typeu (Socket_Address_Type)
The type of address the connection manager should listen on.
Access_Controlu (Socket_Access_Control)
The type of access control the connection manager should apply to the socket.
Access_Control_Paramv
A parameter for the access control type, to be interpreted as specified in the documentation for the Socket_Access_Control enum.

Returns

Addressv
The address on which the connection manager will listen for connections for this file transfer.

Possible errors

org.freedesktop.Telepathy.Error.NotImplemented
The given address type or access-control mechanism is not supported.
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
The file transfer is not in the Not_Offered state, there isn't enough information for the transfer to start, or a local error with acquiring a socket.

Signals:

FileTransferStateChanged ( u: State, u: Reason )

Emitted when the state of a file transfer changes.

Parameters

Stateu (File_Transfer_State)
The new state of the file transfer; see the File_Transfer_State enumeration.
Reasonu (File_Transfer_State_Change_Reason)
The reason for the state change; see the File_Transfer_State_Change_Reason enumeration. The value will always be File_Transfer_State_Change_Reason_None, except when changing state to canceled.

TransferredBytesChanged ( t: Count )

Emitted when the number of transferred bytes changes. This will not be signalled with every single byte change. Instead, the most frequent this signal will be emitted is once a second. This should be sufficient, and the TransferredBytes property SHOULD NOT be polled.

Parameters

Countt
The number of already transferred bytes.

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

Stateu (File_Transfer_State), read-only

The state of the file transfer as described by the File_Transfer_State enum.

ContentTypes, read-only

The file's MIME type. This cannot change once the channel has been created.

This property is mandatory when requesting the channel with the Connection.Interface.Requests.DRAFT.CreateChannel method. Protocols which do not have a content-type property with file transfers should set this value to application/octet-stream.

Filenames, read-only

The name of the file on the sender's side. This is therefore given as a suggested filename for the receiver. This cannot change once the channel has been created.

This property should be the basename of the file being sent. For example, if the sender sends the file /home/user/monkey.pdf then this property should be set to monkey.pdf.

This property is mandatory when requesting the channel with the Connection.Interface.Requests.DRAFT.CreateChannel method. This property cannot be empty and must be set to a sensible value.

Sizet, read-only

The size of the file. If this property is set, then the file transfer is guaranteed to be this size. This cannot change once the channel has been created.

When you are creating a channel with this property, its value MUST be accurate and in bytes. However, when receiving a file, this property still must be in bytes but might not be entirely accurate to the byte.

This property is mandatory when requesting the channel with the Connection.Interface.Requests.DRAFT.CreateChannel method. If this property is UINT64_MAX, then its value is unspecified.

ContentHashTypeu (File_Hash_Type), read-only

The type of the ContentHash property.

This property is optional when requesting the channel with the Connection.Interface.Requests.DRAFT.CreateChannel method. However, if you wish to include the ContentHash property you MUST also include this property. If you omit this property from a Connection.Interface.Requests.DRAFT.CreateChannel method call then its value will be assumed to be File_Hash_Type_None.

ContentHashs, read-only

Hash of the contents of the file transfer, of type described in the value of the ContentHashType property.

This property is optional when requesting the channel with the Connection.Interface.Requests.DRAFT.CreateChannel method. Its value MUST correspond to the appropriate type of the ContentHashType property. If the ContentHashType property is not set, or set to File_Hash_Type_None, then this property will not even be looked at.

Descriptions, read-only

Description of the file transfer. This cannot change once the channel has been created.

This property is optional when requesting the channel with the Connection.Interface.Requests.DRAFT.CreateChannel method. If this property is an empty string, then its value is unspecified.

AvailableSocketTypesa{uau} (Supported_Socket_Map), read-only

A mapping from address types (members of Socket_Address_Type) to arrays of access-control type (members of Socket_Access_Control) that the connection manager supports for sockets with that address type. For simplicity, if a CM supports offering a particular type of file transfer, it is assumed to support accepting it.

A typical value for a host that supports only Unix sockets:

          {
            Socket_Address_Type_Unix:
              [Socket_Access_Control_Localhost, Socket_Access_Control_Credentials]
            Socket_Address_Type_Abstract_Unix:
              [Socket_Access_Control_Localhost, Socket_Access_Control_Credentials]
          }
        
TransferredBytest, read-only

The number of bytes that have been transferred at the time of requesting the property. This will be updated as the file transfer continues.

InitialOffsett, read-only

The offset in bytes from where the file should be sent. This MUST be checked by both the receiver and the sender after the state becomes Open, but before any data is sent or received. Until the state changes to Open, this property is undefined.

Before setting the State property to Open, the connection manager MUST set the InitialOffset property, possibly to 0.

This property MUST NOT change after the state of the transfer has changed to Open.

Enumerated types:

File_Transfer_State

File_Transfer_State_None = 0
An invalid state type used as a null value. This value MUST NOT appear in the State property.
File_Transfer_State_Not_Offered = 1
The transfer is waiting for the local client to call the OfferFile method, in order to offer a file to be transferred.
File_Transfer_State_Accepted = 2
The client has accepted the incoming file transfer, but the transfer is not open. The client should now wait for the state to change to Open and check the offset value.
File_Transfer_State_Local_Pending = 3
The file transfer is waiting to be accepted/closed locally.
File_Transfer_State_Remote_Pending = 4
The file transfer is waiting to be accepted/closed remotely.
File_Transfer_State_Open = 5
The file transfer is open for traffic.
File_Transfer_State_Completed = 6
The file transfer has been completed successfully.
File_Transfer_State_Canceled = 7
The file transfer has been canceled.

File_Transfer_State_Change_Reason

File_Transfer_State_Change_Reason_None = 0
No reason was specified.
File_Transfer_State_Change_Reason_Requested = 1
The change in state was requested.
File_Transfer_State_Change_Reason_Local_Stopped = 1
The file transfer was canceled by the local user.
File_Transfer_State_Change_Reason_Remote_Stopped = 2
The file transfer was canceled by the remote user.
File_Transfer_State_Change_Reason_Local_Error = 3
The file transfer was canceled because of a local error.
File_Transfer_State_Change_Reason_Remote_Error = 4
The file transfer was canceled because of a remote error.

File_Hash_Type

File_Hash_Type_None = 0
No hash.
File_Hash_Type_MD5 = 1
MD5 digest as a string of 32 ASCII hex digits, which SHOULD be lower-case if they are letters.
File_Hash_Type_SHA1 = 2
SHA1 digest as a string of ASCII hex digits, which SHOULD be lower-case if they are letters.
File_Hash_Type_SHA256 = 3
SHA256 digest as a string of ASCII hex digits, which SHOULD be lower-case if they are letters.

org.freedesktop.Telepathy.Channel.Interface.CallMerging

This interface is not yet API-stable and is likely to cause havoc to your API/ABI if bindings are generated. Don't include it in libraries that care about compatibility.

Implementations of this interface must also implement:

Interface for streamed media channels that can be merged and split in the same sort of way as in GSM or PBX telephony.

Added in version 0.17.1.

Methods:

Merge ( o: Other ) → nothing

Request that the given channel be merged into this one. This means that the other channel is closed, and all its participants are added to the channel on which this method was called.

Parameters

Othero
The other channel to merge into this one

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)

Split ( u: Contact ) → o

Request that the given contact is removed from this channel, and a new channel is created to communicate with them privately instead. This is the inverse of Merge.

Parameters

Contactu (Contact_Handle)
The handle of the contact to split off a conversation with, who must be a member in the channel's Group interface

Returns

Channelo
The new channel

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)

Interface has no signals.

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

org.freedesktop.Telepathy.Channel.Interface.CallState

Implementations of this interface must also implement:

An interface for streamed media channels that can indicate call progress or call states. The presence of this interface is no guarantee that call states will actually be signalled (for instance, SIP implementations are not guaranteed to generate status 180 Ringing, so a call can be accepted without the Ringing flag ever having been set).

Added in version 0.17.2.

Methods:

GetCallStates ( ) → a{uu}

Get the current call states for all contacts involved in this call.

Returns

Statesa{uu} (Channel_Call_State_Map)
The current call states. Participants where the call state flags would be 0 (all unset) may be omitted from this mapping.

Signals:

CallStateChanged ( u: contact, u: state )

Emitted when the state of a member of the channel has changed.

Parameters

contactu (Contact_Handle)
An integer handle for the contact.
stateu (Channel_Call_State_Flags)
The new state for this contact.

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Sets of flags:

Channel_Call_State_Flags

A set of flags representing call states.
Channel_Call_State_Ringing = 1
The contact has been alerted about the call but has not responded (e.g. 180 Ringing in SIP).
Channel_Call_State_Queued = 2
The contact is temporarily unavailable, and the call has been placed in a queue (e.g. 182 Queued in SIP, or call-waiting in telephony).
Channel_Call_State_Held = 4
The contact has placed the call on hold, and will not receive media from the local user or any other participants until they unhold the call again.

Mapping types

Channel_Call_State_Map − a{ u: Contact → u: State }

A map from contacts to call states.

Members

Contactu (Contact_Handle)
A contact involved in this call.
Stateu (Channel_Call_State_Flags)
State flags for the given contact.

org.freedesktop.Telepathy.Channel.Interface.ChatState

Implementations of this interface must also implement:

An interface for channels for receiving notifications of remote contacts' state, and for notifying remote contacts of the local state. Clients should assume that a contact's state is Channel_Chat_State_Inactive unless they receive a notification otherwise. The Channel_Chat_State_Gone state is treated differently to other states: It may not be used for multi-user chats It may not be explicitly sent It should be automatically sent when the channel is closed It must not be sent to the peer if a channel is closed without being used Receiving it must not cause a new channel to be opened The different states are defined by XEP-0085, but may be applied to any suitable protocol.

Methods:

SetChatState ( u: state ) → nothing

Set the local state and notify other members of the channel that it has changed.

Parameters

stateu (Channel_Chat_State)
The new state: one of the values of ChannelChatState.

Possible errors

org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)

Signals:

ChatStateChanged ( u: contact, u: state )

Emitted when the state of a member of the channel has changed. This includes local state.

Parameters

contactu (Contact_Handle)
An integer handle for the contact.
stateu (Channel_Chat_State)
The new state of this contact: one of the values of ChannelChatState.

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Enumerated types:

Channel_Chat_State

Channel_Chat_State_Gone = 0
The contact has effectively ceased participating in the chat.
Channel_Chat_State_Inactive = 1
The contact has not been active for some time.
Channel_Chat_State_Active = 2
The contact is actively participating in the chat.
Channel_Chat_State_Paused = 3
The contact has paused composing a message.
Channel_Chat_State_Composing = 4
The contact is composing a message to be sent to the chat.

org.freedesktop.Telepathy.Channel.Interface.DeliveryReporting.DRAFT

This interface is experimental and is likely to cause havoc to your API/ABI if bindings are generated. Don't include it in libraries that care about compatibility.

Implementations of this interface must also implement:

This interface extends the Text and Messages interfaces with improved sent-message status reporting.

This interface replaces Text.SendError, adding support for protocols where the message content is not echoed back to the sender on failure. It also adds support for receiving positive acknowledgements, and uses the Messages queue for state-recovery (ensuring that incoming delivery reports are not lost if there is not currently a process handling them).

If this interface and the Messages interface are both present, clients that support it SHOULD listen for the MessageReceived signal to get delivery reports, and ignore the SendError signal on the Text interface.

Delivery reports appear as messages of type Channel_Text_Message_Type_Delivery_Report in the Text and Messages interfaces. The message in the Text interface SHOULD have the Non_Text_Content flag.

Whenever a message of type Channel_Text_Message_Type_Delivery_Report is signalled for a delivery error report, Channel.Type.Text.SendError SHOULD also be emitted; whenever Channel.Type.Text.SendError is emitted by a channel which supports this interface, a message of type Channel_Text_Message_Type_Delivery_Report MUST also be emitted.

The corresponding message in the Messages interface MUST contain "headers" for the delivery report, as specified below, in its first Message_Part.

interface (s - DBus_Interface, as defined in the Messages interface)
MUST be the name of this interface.
message-sender (u - Contact_Handle, as defined in the Messages interface)
MUST be the intended recipient of the original message, if available (zero or omitted otherwise), even if the delivery report actually came from an intermediate server.
message-type (u - Channel_Text_Message_Type, as defined in the Messages interface)
MUST be Channel_Text_Message_Type_Delivery_Report.
delivery-status (u - Delivery_Status)
The status of the message. All delivery reports MUST contain this key in the first Message_Part.
delivery-token (s - Sent_Message_Token)

An identifier for the message to which this delivery report refers. MUST NOT be an empty string. Omitted if not available.

Clients may match this against the token produced by the SendMessage method and MessageSent signal on the Messages interface. A status report with no token could match any sent message, and a sent message with an empty token could match any status report. If multiple sent messages match, clients SHOULD use some reasonable heuristic.

In an ideal world, we could unambiguously match reports against messages; however, deployed protocols are not ideal, and not all reports and messages can be matched.
delivery-error (u - Channel_Text_Send_Error)
The reason for the failure. MUST be omitted if this was a successful delivery; SHOULD be omitted if it would be Channel_Text_Send_Error_Unknown.
delivery-echo (aa{sv} - Message_Part[])

The message content, as defined by the Messages interface. Omitted if no content is available. Content MAY have been truncated, message parts MAY have been removed, and message parts MAY have had their content removed (i.e. the message part metadata is present, but the 'content' key is not).

Some protocols, like XMPP, echo the failing message back to the sender. This is sometimes the only way to match it against the sent message, so we include it here.

Unlike in the Messages interface, content not visible in the value for this key cannot be retrieved by another means, so the connection manager SHOULD be more aggressive about including (possibly truncated) message content in the 'content' key.

The Messages interface needs to allow all content to be retrieved, but in this interface, the content we provide is merely a hint; so some is better than none, and it doesn't seem worth providing an API as complex as Messages' GetPendingMessageContent for the echoed message.

The second and subsequent Message_Part dictionaries, if present, are a human-readable report from the IM service.

It is an error for this interface to appear on channels of type other than Text, or on Text channels without the Messages interface. Clients MUST recover from this error by ignoring the presence of the DeliveryReporting interface.

Some example delivery reports in a Python-like syntax (in which arrays are indicated by [a, b] and dictionaries by {k1: v1, k2: v2}) follow.

A minimal delivery report indicating permanent failure of the sent message whose token was b9a991bd-8845-4d7f-a704-215186f43bb4 for an unknown reason
[{
# header
'interface': 'org.freedesktop.Telepathy.Channel.Interface.DeliveryReporting',
'message-sender': 123,
'message-type': Channel_Text_Message_Type_Delivery_Report,
'delivery-status': Delivery_Status_Permanently_Failed,
'delivery-token': 'b9a991bd-8845-4d7f-a704-215186f43bb4',
}
# no body
]
A delivery report where the failed message is echoed back to the sender rather than being referenced by ID, and the failure reason is that this protocol cannot send messages to offline contacts such as the contact with handle 123
[{ # header
'interface': 'org.freedesktop.Telepathy.Channel.Interface.DeliveryReporting',
'message-sender': 123,
'message-type': Channel_Text_Message_Type_Delivery_Report,
'delivery-status': Delivery_Status_Temporarily_Failed,
'delivery-error': Channel_Text_Send_Error_Offline,
'delivery-echo':
    [{ # header of original message
    'message-sender': 1,
    'message-sent': 1210067943,
    },
    { # body of original message
    'type': 'text/plain',
    'content': 'Hello, world!',
    }]
  ],

# no body
]
A maximally complex delivery report: the server reports a bilingual human-readable failure message because the user sent a message "Hello, world!" with token b9a991bd-8845-4d7f-a704-215186f43bb4 to a contact with handle 123, but that handle represents a contact who does not actually exist
[{ # header
'interface': 'org.freedesktop.Telepathy.Channel.Interface.DeliveryReporting',
'message-sender': 123,
'message-type': Channel_Text_Message_Type_Delivery_Report,
'delivery-status': Delivery_Status_Permanently_Failed,
'delivery-error': Channel_Text_Send_Error_Invalid_Contact,
'delivery-token': 'b9a991bd-8845-4d7f-a704-215186f43bb4',
'delivery-echo':
    [{ # header of original message
    'message-sender': 1,
    'message-sent': 1210067943,
    },
    { # body of original message
    'type': 'text/plain',
    'content': 'Hello, world!',
    }]
  ],
},
{ # message from server (alternative in English)
'alternative': '404',
'type': 'text/plain',
'lang': 'en',
'content': 'I have no contact with that name',
},
{ # message from server (alternative in German)
'alternative': '404'.
'type': 'text/plain',
'lang': 'de',
'content', 'Ich habe keinen Kontakt mit diesem Namen',
}
]
A minimal delivery report indicating successful delivery of the sent message whose token was b9a991bd-8845-4d7f-a704-215186f43bb4
[{
# header
'interface': 'org.freedesktop.Telepathy.Channel.Interface.DeliveryReporting',
'message-sender': 123,
'message-type': Channel_Text_Message_Type_Delivery_Report,
'delivery-status': Delivery_Status_Delivered,
'delivery-token': 'b9a991bd-8845-4d7f-a704-215186f43bb4',
}
# no body
]

Added in version 0.17.5. (draft version, not API-stable)

Methods:

SendDeliveryReport ( au: Messages, u: Status, u: Reason ) → nothing

Request that a delivery report is sent for the specified pending incoming message. Delivery reports cannot currently be sent for messages that have already been acknowledged.

The only use-case I can see for delivery reports on non-pending messages is a "read receipt" like in email's RFC 3798. Delivery reports on non-pending messages will also need a more complex API.

If they turn out to be needed, we can add a method like SendDeliveryReportByContent(aa{sv}: message) and add a flag to Delivery_Reporting_Support_Flags indicating that this method is implemented.

Clients SHOULD NOT attempt to send delivery reports that are not indicated to be supported using the DeliveryReportingSupport property.

Clients MUST NOT attempt to send delivery reports using the SendMessage method in the Messages API, and connection managers MUST NOT allow this to be done.

Parameters

Messagesau (Message_ID[])
The IDs of one or more unacknowledged messages.
Statusu (Delivery_Status)
The status to be reported.
Reasonu (Channel_Text_Send_Error)
If the status to be reported is a failure, the reason for that failure. If the status to be reported is not an error, this MUST be Channel_Text_Send_Error_Unknown.

Possible errors

org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
One of the specified message IDs was invalid. No delivery reports were sent.
org.freedesktop.Telepathy.Error.NotAvailable
The requested message status could not be reported to the sender (for instance, this will be raised if a positive delivery report is requested on a protocol that only supports negative delivery reports). Clients MUST treat this error as non-fatal.
org.freedesktop.Telepathy.Error.NotImplemented
This channel cannot report message status back to the sender at all. Do not call this method on this channel again.

Interface has no signals.

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

DeliveryReportingSupportu (Delivery_Reporting_Support_Flags), read-only
A bitfield indicating features supported by this channel.

Enumerated types:

Delivery_Status

The status of a message as indicated by a delivery report. If this enum is extended in future specifications, this should only be to add new, non-overlapping conditions (i.e. all failures should still be signalled as either Temporarily_Failed or Permanently_Failed). If additional detail is required (e.g. distinguishing between the various types of permanent failure) this will be done using additional keys in the Message_Part.
Delivery_Status_Unknown = 0
The message's disposition is unknown. Clients SHOULD consider all messages to have status Delivery_Status_Unknown unless otherwise specified; connection managers SHOULD NOT signal this delivery status explicitly.
Delivery_Status_Delivered = 1
The message has been delivered to the intended recipient.
Delivery_Status_Temporarily_Failed = 2
Delivery of the message has failed. Clients SHOULD notify the user, but MAY automatically try sending another copy of the message.
Similar to errors with type="wait" in XMPP; analogous to 4xx errors in SMTP.
Delivery_Status_Permanently_Failed = 3
Delivery of the message has failed. Clients SHOULD NOT try again unless by specific user action. If the user does not modify the message or alter configuration before re-sending, this error is likely to happen again.
Similar to errors with type="cancel", type="modify" or type="auth" in XMPP; analogous to 5xx errors in SMTP.

Sets of flags:

Delivery_Reporting_Support_Flags

Flags indicating the level of support for delivery reporting on this channel. Any future flags added to this set will conform to the convention that the presence of an extra flag implies that more operations will succeed.
Delivery_Reporting_Support_Flag_Receive_Failures = 1
Clients MAY expect to receive negative delivery reports if Message_Sending_Flag_Report_Delivery is specified when sending.
If senders want delivery reports, they should ask for them. If they don't want delivery reports, they can just ignore them, so there's no need to have capability discovery for what will happen if a delivery report isn't requested.
Delivery_Reporting_Support_Flag_Receive_Successes = 2
Clients MAY expect to receive positive delivery reports if Message_Sending_Flag_Report_Delivery is specified when sending.
Same rationale as Receive_Failures.
Delivery_Reporting_Support_Flag_Send_Failures = 4
Clients MAY expect that sending a negative delivery report will succeed, and will actually get a message to the sender.
Delivery_Reporting_Support_Flag_Send_Successes = 8
Clients MAY expect that sending a positive delivery report will succeed, and will actually get a message to the sender.

org.freedesktop.Telepathy.Channel.Interface.DTMF

Implementations of this interface must also implement:

An interface that gives a Channel the ability to send DTMF events over audio streams which have been established using the StreamedMedia channel type. The event codes used are in common with those defined in RFC4733, and are listed in the DTMF_Event enumeration.

Methods:

StartTone ( u: stream_id, y: event ) → nothing

Start sending a DTMF tone on this stream. Where possible, the tone will continue until StopTone is called. On certain protocols, it may only be possible to send events with a predetermined length. In this case, the implementation may emit a fixed-length tone, and the StopTone method call should return NotAvailable.

Parameters

stream_idu (Stream_ID)
A stream ID as defined in the StreamedMedia channel type.
eventy (DTMF_Event)
A numeric event code from the DTMF_Event enum.

Possible errors

org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
The given stream ID was invalid.
org.freedesktop.Telepathy.Error.NotAvailable
The requested event is not available on this stream.

StopTone ( u: stream_id ) → nothing

Stop sending any DTMF tone which has been started using the StartTone method. If there is no current tone, this method will do nothing.

Parameters

stream_idu (Stream_ID)
A stream ID as defined in the StreamedMedia channel type.

Possible errors

org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
The given stream ID was invalid.
org.freedesktop.Telepathy.Error.NotAvailable
Continuous tones are not supported by this stream.

Interface has no signals.

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Enumerated types:

DTMF_Event

DTMF_Event_Digit_0 = 0
0
DTMF_Event_Digit_1 = 1
1
DTMF_Event_Digit_2 = 2
2
DTMF_Event_Digit_3 = 3
3
DTMF_Event_Digit_4 = 4
4
DTMF_Event_Digit_5 = 5
5
DTMF_Event_Digit_6 = 6
6
DTMF_Event_Digit_7 = 7
7
DTMF_Event_Digit_8 = 8
8
DTMF_Event_Digit_9 = 9
9
DTMF_Event_Asterisk = 10
*
DTMF_Event_Hash = 11
#
DTMF_Event_Letter_A = 12
A
DTMF_Event_Letter_B = 13
B
DTMF_Event_Letter_C = 14
C
DTMF_Event_Letter_D = 15
D

org.freedesktop.Telepathy.Channel.Interface.Group

Implementations of this interface must also implement:

Interface for channels which have multiple members, and where the members of the channel can change during its lifetime. Your presence in the channel cannot be presumed by the channel's existence (for example, a channel you may request membership of but your request may not be granted).

This interface implements three lists: a list of current members, and two lists of local pending and remote pending members. Contacts on the remote pending list have been invited to the channel, but the remote user has not accepted the invitation. Contacts on the local pending list have requested membership of the channel, but the local user of the framework must accept their request before they may join. A single contact should never appear on more than one of the three lists. The lists are empty when the channel is created, and the MembersChanged signal should be emitted when information is retrieved from the server, or changes occur.

Addition of members to the channel may be requested by using AddMembers. If remote acknowledgement is required, use of the AddMembers method will cause users to appear on the remote pending list. If no acknowledgement is required, AddMembers will add contacts to the member list directly. If a contact is awaiting authorisation on the local pending list, AddMembers will grant their membership request.

Removal of contacts from the channel may be requested by using RemoveMembers. If a contact is awaiting authorisation on the local pending list, RemoveMembers will refuse their membership request. If a contact is on the remote pending list but has not yet accepted the invitation, RemoveMembers will rescind the request if possible.

It should not be presumed that the requester of a channel implementing this interface is immediately granted membership, or indeed that they are a member at all, unless they appear in the list. They may, for instance, be placed into the remote pending list until a connection has been established or the request acknowledged remotely.

If the local user joins a Group channel whose members or other state cannot be discovered until the user joins (e.g. many chat room implementations), the connection manager should ensure that the channel is, as far as possible, in a consistent state before adding the local contact to the members set; until this happens, the local contact should be in the remote-pending set. For instance, if the connection manager queries the server to find out the initial members list for the channel, it should leave the local contact in the remote-pending set until it has finished receiving the initial members list.

If the protocol provides no reliable way to tell whether the complete initial members list has been received yet, the connection manager should make a best-effort attempt to wait for the full list (in the worst case, waiting for a suitable arbitrary timeout) rather than requiring user interfaces to do so on its behalf.

Methods:

AddMembers ( au: contacts, s: message ) → nothing

Invite all the given contacts into the channel, or accept requests for channel membership for contacts on the pending local list.

A message may be provided along with the request, which will be sent to the server if supported. See the CHANNEL_GROUP_FLAG_MESSAGE_ADD and CHANNEL_GROUP_FLAG_MESSAGE_ACCEPT flags to see in which cases this message should be provided.

Attempting to add contacts who are already members is allowed; connection managers must silently accept this, without error.

Parameters

contactsau (Contact_Handle[])
An array of contact handles to invite to the channel
messages
A string message, which can be blank if desired

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)
org.freedesktop.Telepathy.Error.Channel.Full
The channel is full. (generic description)
org.freedesktop.Telepathy.Error.Channel.InviteOnly
The requested channel is invite-only. (generic description)
org.freedesktop.Telepathy.Error.Channel.Banned
You are banned from the channel. (generic description)

GetAllMembers ( ) → au, au, au

Returns arrays of all current, local and remote pending channel members.

Deprecated since version 0.17.6. Use GetAll on the D-Bus Properties D-Bus interface to get properties including Members, RemotePendingMembers and LocalPendingMembers instead, falling back to this method and GetLocalPendingMembers if necessary.

Returns

au (Contact_Handle[])
array of handles of current members
au (Contact_Handle[])
array of handles of local pending members
au (Contact_Handle[])
array of handles of remote pending members

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

GetGroupFlags ( ) → u

Returns the value of the GroupFlags property.

Deprecated since version 0.17.6. Use GetAll on the D-Bus Properties D-Bus interface to get properties including GroupFlags instead, falling back to this method if necessary.

Returns

u (Channel_Group_Flags)
The value of the GroupFlags property

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

GetHandleOwners ( au: handles ) → au

If the CHANNEL_GROUP_FLAG_CHANNEL_SPECIFIC_HANDLES flag is set on the channel, then the handles of the group members are specific to this channel, and are not meaningful in a connection-wide context such as contact lists. This method allows you to find the owner of the handle if it can be discovered in this channel, or 0 if the owner is not available.

Deprecated since version 0.17.6. Clients should use the HandleOwners property and HandleOwnersChanged signal if Channel_Group_Flag_Properties is present.

Parameters

handlesau (Contact_Handle[])
A list of integer handles representing members of the channel

Returns

au (Contact_Handle[])
An array of integer handles representing the owner handles of the given room members, in the same order, or 0 if the owner is not available

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
This channel doesn't have the CHANNEL_SPECIFIC_HANDLES flag, so handles in this channel are globally meaningful and calling this method is not necessary
org.freedesktop.Telepathy.Error.InvalidArgument
One of the given handles is not a member

GetLocalPendingMembers ( ) → au

Returns the To_Be_Added handle (only) for each structure in the LocalPendingMembers property.

Deprecated since version 0.17.6. Use the LocalPendingMembers property, if Channel_Group_Flag_Properties is present.

Returns

au (Contact_Handle[])

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

GetLocalPendingMembersWithInfo ( ) → a(uuus)

Returns the LocalPendingMembers property.

Added in version 0.15.0.

Deprecated since version 0.17.6. Use the LocalPendingMembers property, if Channel_Group_Flag_Properties is present.

Returns

a(uuus) (Local_Pending_Info[])
An array of structs containing: A handle representing the contact requesting channel membership A handle representing the contact making the request, or 0 if unknown The reason for the request: one of the values of ChannelGroupChangeReason A string message containing the reason for the request if any (or blank if none)

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

GetMembers ( ) → au

Returns the Members property.

Deprecated since version 0.17.6. Use the Members property, if Channel_Group_Flag_Properties is present.

Returns

au (Contact_Handle[])

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

GetRemotePendingMembers ( ) → au

Returns an array of handles representing contacts who have been invited to the channel and are awaiting remote approval.

Deprecated since version 0.17.6. Use the RemotePendingMembers property, if Channel_Group_Flag_Properties is present.

Returns

au (Contact_Handle[])

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

GetSelfHandle ( ) → u

Returns the value of the SelfHandle property.

Deprecated since version 0.17.6. Clients should retrieve the SelfHandle property using GetAll instead, if Channel_Group_Flag_Properties is present.

Returns

u (Contact_Handle)

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

RemoveMembers ( au: contacts, s: message ) → nothing

Requests the removal of contacts from a channel, reject their request for channel membership on the pending local list, or rescind their invitation on the pending remote list. A message may be provided along with the request, which will be sent to the server if supported. See the CHANNEL_GROUP_FLAG_MESSAGE_REMOVE, CHANNEL_GROUP_FLAG_MESSAGE_REJECT and CHANNEL_GROUP_FLAG_MESSAGE_RESCIND flags to see in which cases this message should be provided.

Parameters

contactsau (Contact_Handle[])
An array of contact handles to remove from the channel
messages
A string message, which can be blank if desired

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)

RemoveMembersWithReason ( au: contacts, s: message, u: reason ) → nothing

As RemoveMembers, but a reason code may be provided where appropriate. The reason code may be ignored if the underlying protocol is unable to represent the given reason.

Parameters

contactsau (Contact_Handle[])
An array of contact handles to remove from the channel
messages
A string message, which can be blank if desired
reasonu (Channel_Group_Change_Reason)
A reason for the change: one of the values of ChannelGroupChangeReason

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.InvalidHandle
The contact name specified is unknown on this channel or connection. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
The provided reason code was invalid.

Signals:

HandleOwnersChanged ( a{uu}: Added, au: Removed )

Emitted whenever the HandleOwners property changes.

Added in version 0.17.6. This signal should not be relied on unless Channel_Group_Flag_Properties is present.

Parameters

Addeda{uu} (Handle_Owner_Map)
A map from channel-specific handles to their owners, in which the keys include all the handles that were added to the keys of the HandleOwners property, and all the handles in that property whose owner has changed
Removedau (Contact_Handle[])
The channel-specific handles that were removed from the keys of the HandleOwners property, as a result of the contact leaving this group in a previous MembersChanged signal

SelfHandleChanged ( u: Self_Handle )

Emitted whenever the SelfHandle property changes.

Added in version 0.17.6. This signal should not be relied on unless Channel_Group_Flag_Properties is present.

Parameters

Self_Handleu (Contact_Handle)
The new value of the SelfHandle property.

GroupFlagsChanged ( u: added, u: removed )

Emitted when the flags as returned by GetGroupFlags are changed. The user interface should be updated as appropriate.

Parameters

addedu (Channel_Group_Flags)
A bitwise OR of the flags which have been set
removedu (Channel_Group_Flags)
A bitwise OR of the flags which have been cleared

MembersChanged ( s: message, au: added, au: removed, au: local_pending, au: remote_pending, u: actor, u: reason )

Emitted when contacts join any of the three lists (members, local pending or remote pending) or when they leave any of the three lists. There may also be a message from the server regarding this change, which may be displayed to the user if desired.

All channel-specific handles that are mentioned in this signal MUST be represented in the value of the HandleOwners property. In practice, this will mean that HandleOwnersChanged is emitted before emitting a MembersChanged signal in which channel-specific handles are added, but that it is emitted after emitting a MembersChanged signal in which channel-specific handles are removed.

Parameters

messages
A string message from the server, or blank if not
addedau (Contact_Handle[])
A list of members added to the channel
removedau (Contact_Handle[])
A list of members removed from the channel
local_pendingau (Contact_Handle[])
A list of members who are pending local approval
remote_pendingau (Contact_Handle[])
A list of members who are pending remote approval
actoru (Contact_Handle)
The contact handle of the person who made the change, or 0 if not known
reasonu (Channel_Group_Change_Reason)
A reason for the change: one of the values of ChannelGroupChangeReason

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

GroupFlagsu (Channel_Group_Flags), read-only
An integer representing the bitwise-OR of flags on this channel. The user interface can use this to present information about which operations are currently valid. Change notification is via the GroupFlagsChanged signal.

Added in version 0.17.6. For backwards compatibility, clients should fall back to calling GetGroupFlags if Channel_Group_Flag_Properties is not present.

HandleOwnersa{uu} (Handle_Owner_Map), read-only
A map from channel-specific handles to their owners, including at least all of the channel-specific handles in this channel's members, local-pending or remote-pending sets as keys. Any handle not in the keys of this mapping is not channel-specific in this channel. Handles which are channel-specific, but for which the owner is unknown, MUST appear in this mapping with 0 as owner. Change notification is via the HandleOwnersChanged signal.

Added in version 0.17.6.

LocalPendingMembersa(uuus) (Local_Pending_Info[]), read-only
An array of structs containing handles representing contacts requesting channel membership and awaiting local approval with AddMembers.

Added in version 0.17.6. If Channel_Group_Flag_Properties is not present, clients should fall back to using the deprecated GetLocalPendingMembersWithInfo method, or fall back from that to the deprecated GetAllMembers method.

Membersau (Contact_Handle[]), read-only
The members of this channel.

Added in version 0.17.6. If Channel_Group_Flag_Properties is not set, fall back to calling GetAllMembers.

RemotePendingMembersau (Contact_Handle[]), read-only
An array of handles representing contacts who have been invited to the channel and are awaiting remote approval.

Added in version 0.17.6. If Channel_Group_Flag_Properties is not set, fall back to calling GetAllMembers.

SelfHandleu (Contact_Handle), read-only
The handle for the user on this channel (which can also be a local or remote pending member), or 0 if the user is not a member at all (which is likely to be the case, for instance, on ContactList channels). Note that this is different from the connection GetSelfHandle on some protocols, so the value of this handle should always be used with the methods of this interface.

Added in version 0.17.6. For backwards compatibility, clients should fall back to calling GetSelfHandle if Channel_Group_Flag_Properties is not present.

Enumerated types:

Channel_Group_Change_Reason

Channel_Group_Change_Reason_None = 0
No reason was provided for this change.
Channel_Group_Change_Reason_Offline = 1
The change is due to a user going offline. Also used when user is already offline, but this wasn't known previously.
Channel_Group_Change_Reason_Kicked = 2
The change is due to a kick operation.
Channel_Group_Change_Reason_Busy = 3
The change is due to a busy indication.
Channel_Group_Change_Reason_Invited = 4
The change is due to an invitation.
Channel_Group_Change_Reason_Banned = 5
The change is due to a kick+ban operation.
Channel_Group_Change_Reason_Error = 6
The change is due to an error occurring.
Channel_Group_Change_Reason_Invalid_Contact = 7
The change is because the requested contact does not exist.
Channel_Group_Change_Reason_No_Answer = 8
The change is because the requested contact did not respond.
Channel_Group_Change_Reason_Renamed = 9
The change is because a contact's unique identifier changed. There must be exactly one handle in the removed set and exactly one handle in one of the added sets. The Renamed signal on the Renaming interface will have been emitted for the same handles, shortly before this MembersChanged signal is emitted.
Channel_Group_Change_Reason_Permission_Denied = 10
The change is because there was no permission to contact the requested handle.
Channel_Group_Change_Reason_Separated = 11

If members are removed with this reason code, the change is because the group has split into unconnected parts which can only communicate within themselves (e.g. netsplits on IRC use this reason code).

If members are added with this reason code, the change is because unconnected parts of the group have rejoined. If this channel carries messages (e.g. Text or Tubes channels) applications must assume that the contacts being added are likely to have missed some messages as a result of the separation, and that the contacts in the group are likely to have missed some messages from the contacts being added.

Note that from the added contacts' perspective, they have been in the group all along, and the contacts we indicate to be in the group (including the local user) have just rejoined the group with reason Separated. Application protocols in Tubes should be prepared to cope with this situation.

Sets of flags:

Channel_Group_Flags

Channel_Group_Flag_Can_Add = 1
The AddMembers method can be used to add or invite members who are not already in the local pending list (which is always valid).
Channel_Group_Flag_Can_Remove = 2
The RemoveMembers method can be used to remove channel members (removing those on the pending local list is always valid).
Channel_Group_Flag_Can_Rescind = 4
The RemoveMembers method can be used on people on the remote pending list.
Channel_Group_Flag_Message_Add = 8
A message may be sent to the server when calling AddMembers on contacts who are not currently pending members.
Channel_Group_Flag_Message_Remove = 16
A message may be sent to the server when calling RemoveMembers on contacts who are currently channel members.
Channel_Group_Flag_Message_Accept = 32
A message may be sent to the server when calling AddMembers on contacts who are locally pending.
Channel_Group_Flag_Message_Reject = 64
A message may be sent to the server when calling RemoveMembers on contacts who are locally pending.
Channel_Group_Flag_Message_Rescind = 128
A message may be sent to the server when calling RemoveMembers on contacts who are remote pending.
Channel_Group_Flag_Channel_Specific_Handles = 256

The members of this group have handles which are specific to this channel, and are not valid as general-purpose handles on the connection. Depending on the channel, it may be possible to call GetHandleOwners to find the owners of these handles, which should be done if you wish to eg subscribe to the contact's presence.

Connection managers must ensure that any given handle is not simultaneously a general-purpose handle and a channel-specific handle.

Channel_Group_Flag_Only_One_Group = 512
Placing a contact in multiple groups of this type is not allowed and will raise NotAvailable (on services where contacts may only be in one user-defined group, user-defined groups will have this flag).
Channel_Group_Flag_Handle_Owners_Not_Available = 1024
In rooms with channel specific handles (ie Channel_Specific_Handles flag is set), this flag indicates that no handle owners are available, apart from the owner of the SelfHandle.
This used to be an important optimization to avoid repeated GetHandleOwners calls, before we introduced the HandleOwner property and HandleOwnerChanged signal.
Channel_Group_Flag_Properties = 2048
This flag indicates that all the properties introduced in specification 0.17.6 are fully supported.

Structure types

Local_Pending_Info − ( u: To_Be_Added, u: Actor, u: Reason, s: Message )

A structure representing a contact whose attempt to join a group is to be confirmed by the local user using AddMembers.

In bindings that need a separate name, arrays of Local_Pending_Info should be called Local_Pending_Info_List.

Members

To_Be_Addedu (Contact_Handle)
The contact to be added to the group
Actoru (Contact_Handle)
The contact requesting or causing the change
Reasonu (Channel_Group_Change_Reason)
The reason for the change
Messages
A human-readable message from the Actor, or an empty string if there is no message

Mapping types

Handle_Owner_Map − a{ u: Channel_Specific_Handle → u: Global_Handle }

A map from channel-specific handles to their owners.

Members

Channel_Specific_Handleu (Contact_Handle)
A nonzero channel-specific handle
Global_Handleu (Contact_Handle)
The global handle that owns the corresponding channel-specific handle, or 0 if this could not be determined

org.freedesktop.Telepathy.Channel.Interface.Hold

Implementations of this interface must also implement:

Interface for channels where you may put the channel on hold. This only makes sense for channels where you are streaming media to or from the members.

If you place a channel on hold, this indicates that you do not wish to be sent media streams by any of its members and will be ignoring any media streams you continue to receive. It also requests that the connection manager free up any resources that are only needed for an actively used channel (e.g. in a GSM or PBX call, it will be necessary to place an active call on hold before you can start another call).

Changed in version 0.17.4: first API-stable version

Methods:

GetHoldState ( ) → u, u

Return whether the local user has placed the channel on hold.

Returns

HoldStateu (Local_Hold_State)
The state of the channel
Reasonu (Local_Hold_State_Reason)
The reason why the channel is in that state

RequestHold ( b: Hold ) → nothing

Request that the channel be put on hold (be instructed not to send any media streams to you) or be taken off hold.

If the connection manager can immediately tell that the requested state change could not possibly succeed, this method SHOULD return the NotAvailable error. If the requested state is the same as the current state, this method SHOULD return successfully without doing anything.

Otherwise, this method SHOULD immediately set the hold state to Local_Hold_State_Pending_Hold or Local_Hold_State_Pending_Unhold (as appropriate), emitting HoldStateChanged if this is a change, and return successfully.

The eventual success or failure of the request is indicated by a subsequent HoldStateChanged signal, changing the hold state to Local_Hold_State_Held or Local_Hold_State_Unheld.

If the channel has multiple streams, and the connection manager succeeds in changing the hold state of one stream but fails to change the hold state of another, it SHOULD attempt to revert all streams to their previous hold states.

The following state transitions SHOULD be used, where appropriate:

Parameters

Holdb
A boolean indicating whether or not the channel should be on hold

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
The requested hold state cannot be achieved; for example, if only a limited number of channels can be in the "not on hold" state, attempts to exceed this number will raise NotAvailable.

Signals:

HoldStateChanged ( u: HoldState, u: Reason )

Emitted to indicate that the hold state has changed for this channel. This may occur as a consequence of you requesting a change with RequestHold, or the state changing as a result of a request from another process.

Parameters

HoldStateu (Local_Hold_State)
The state of the channel
Reasonu (Local_Hold_State_Reason)
The reason for the state change

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Enumerated types:

Local_Hold_State

The hold state of a channel.
Local_Hold_State_Unheld = 0
All streams are unheld (the call is active). New channels SHOULD have this hold state.
Local_Hold_State_Held = 1
All streams are held (the call is on hold)
Local_Hold_State_Pending_Hold = 2
The connection manager is attempting to move to state Held, but has not yet completed that operation. It is unspecified whether any, all or none of the streams making up the channel are on hold.
Local_Hold_State_Pending_Unhold = 3
The connection manager is attempting to move to state Held, but has not yet completed that operation. It is unspecified whether any, all or none of the streams making up the channel are on hold.

Local_Hold_State_Reason

The reason for a change to the Local_Hold_State. Clients MUST treat unknown values as equivalent to Local_Hold_State_Reason_None.
Local_Hold_State_Reason_None = 0
The reason cannot be described by any of the predefined values (connection managers SHOULD avoid this reason, but clients MUST handle it gracefully)
Local_Hold_State_Reason_Requested = 1
The change is in response to a user request
Local_Hold_State_Reason_Resource_Not_Available = 2
The change is because some resource was not available

org.freedesktop.Telepathy.Channel.Interface.HTML.DRAFT

This interface is unfinished and is likely to cause havoc to your API/ABI if bindings are generated. Don't include it in libraries that care about compatibility.

Implementations of this interface must also implement:

This interface extends the Messages interface to support capability discovery, so clients can decide what subset of HTML is supported.

(However, the capability discovery mechanism has not been written yet, so this interface MUST NOT be used. It exists only to indicate what direction we intend to go in.)

XMPP supports all of XHTML-IM, and SIP (at least theoretically) supports all of XHTML. However, many protocols are more limited - for instance, in MSN you can only set font properties for a whole message at a time. We should not mislead users into thinking they can send MSN messages where individual words are emphasized.

If this interface is present, clients MAY send XHTML formatted text in message parts with type "text/html", and SHOULD interpret "text/html" message parts received in reply.

Client authors SHOULD pay careful attention to the security considerations in XEP-0071, "XHTML-IM", to avoid exposing client users to security risks. Clients MUST NOT assume that connection managers will filter messages to remove unsafe HTML.

Connection managers are the components in Telepathy that are most likely to be exploitable by a remote attacker to run malicious code (since they are network-facing), so any filtering that the CM does might be subverted.

To avoid misleading users, clients SHOULD only present UI for the subset of HTML that is indicated to be supported by this interface. It follows that clients SHOULD NOT send unsupported markup to the connection manager. However, even if the connection manager cannot send arbitrary XHTML, it MUST cope gracefully with being given arbitrary XHTML by a client.

Connection managers should be lenient in what they receive.

Clients MUST NOT send HTML that is not well-formed XML, but connection managers MAY signal HTML that is malformed or invalid. Clients SHOULD attempt to parse messages as XHTML, but fall back to using a permissive "tag-soup" HTML parser if that fails. (FIXME: or should the presence of this interface imply that the CM fixes up "text/html" to be XHTML? In practice that would result in all the CMs having to link against libxml2 or something... the rationale above no longer applies here, since dropping a malformed message is "safe")

Added in version 0.17.5. (draft version, not API-stable)

Interface has no methods.

Interface has no signals.

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

org.freedesktop.Telepathy.Channel.Interface.Password

Implementations of this interface must also implement:

Interface for channels that may have a password set that users need to provide before being able to join, or may be able to view or change once they have joined the channel.

The GetPasswordFlags method and the associated PasswordFlagsChanged signal indicate whether the channel has a password, whether the user must now provide it to join, and whether it can be viewed or changed by the user.

Methods:

GetPasswordFlags ( ) → u

Returns the bitwise-OR of the flags relevant to the password on this channel. The user interface can use this to present information about which operations are currently valid.

Returns

u (Channel_Password_Flags)
An integer with the logical OR of all the flags set (values of ChannelPasswordFlags)

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

ProvidePassword ( s: password ) → b

Provide the password so that the channel can be joined. Must be called with the correct password in order for channel joining to proceed if the 'provide' password flag is set.

Parameters

passwords
The password

Returns

b

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)

Signals:

PasswordFlagsChanged ( u: added, u: removed )

Emitted when the flags as returned by GetPasswordFlags are changed. The user interface should be updated as appropriate.

Parameters

addedu (Channel_Password_Flags)
A bitwise OR of the flags which have been set
removedu (Channel_Password_Flags)
A bitwise OR of the flags which have been cleared

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Sets of flags:

Channel_Password_Flags

Channel_Password_Flag_Provide = 8
The ProvidePassword method must be called now for the user to join the channel

org.freedesktop.Telepathy.Channel.Interface.MediaSignalling

Implementations of this interface must also implement:

An interface for signalling a channel containing synchronised media sessions which can contain an arbitrary number of streams. The negotiation interface is based closely around the API of the Farsight library (http://farsight.sourceforge.net/). This in turn is based upon the IETF MMusic ICE drafts where connections are established by signalling potential connection candidates to the peer until a usable connection is found, and codecs are negotiated with an SDP-style offer and answer. However, the principles should be applicable to other media streaming methods and the API re-used without difficulty.

Methods:

GetSessionHandlers ( ) → a(os)

Returns all currently active session handlers on this channel as a list of (session_handler_path, type).

Returns

a(os) (Media_Session_Handler_Info[])

Signals:

NewSessionHandler ( o: Session_Handler, s: Session_Type )

Signal that a session handler object has been created. The client should create a session object and create streams for the streams within.

Parameters

Session_Handlero
Object path of the new MediaSessionHandler object
Session_Types (Media_Session_Type)
String indicating type of session, eg "rtp"

Telepathy Properties:

Accessed using the Telepathy Properties interface.

nat-traversals

A string indicating the NAT traversal techniques employed by the streams within this channel. Can be protocol-specific values, but the following values should be used if appropriate:

none
No attempt should be made at NAT traversal.
stun
If appropriate, a STUN request should be made to the given server to open a UDP port mapping and determine the external IP.
gtalk-p2p
Google Talk peer-to-peer connectivity establishment should be used, as implemented in libjingle 0.3.
stun-servers
The IP address or hostname of the STUN server to use for NAT traversal.
stun-portq
The UDP port number to use on the provided STUN server.
gtalk-p2p-relay-tokens
The authentication token for use with the Google Talk peer-to-peer relay server.

Interface has no D-Bus core properties.

Simple types

Media_Session_Type − s

The type of a media session. Currently, the only supported value is "rtp".

Structure types

Media_Session_Handler_Info − ( o: Session_Handler, s: Media_Session_Type )

A struct representing a active session handler.

In bindings that need a separate name, arrays of Media_Session_Handler_Info should be called Media_Session_Handler_Info_List.

Members

Session_Handlero
The object path of the session handler, which is on the same bus name as the channel.
Media_Session_Types (Media_Session_Type)
The media session's type

org.freedesktop.Telepathy.Channel.Interface.Messages.DRAFT

This interface is experimental and is likely to cause havoc to your API/ABI if bindings are generated. Don't include it in libraries that care about compatibility.

Implementations of this interface must also implement:

This interface extends the Text interface to support more general messages, including:

It also provides a hook for improved sent message status notification, to be used by the DeliveryReporting interface.

Although this specification supports formatted (rich-text) messages with unformatted alternatives, implementations SHOULD NOT attempt to send formatted messages until the Telepathy specification has also been extended to cover capability discovery for message formatting.

We intend to expose all rich-text messages as XHTML-IM, but on some protocols, formatting is an extremely limited subset of that format (e.g. there are protocols where foreground/background colours, font and size can be set, but only for entire messages). Until we can tell UIs what controls to offer to the user, it's unfriendly to offer the user controls that may have no effect.

If this interface is present, clients that support it SHOULD listen for the MessageSent and MessageReceived signals, and ignore the Sent and Received signal on the Text interface (which are guaranteed to duplicate signals from this interface).

Added in version 0.17.5. (draft version, not API-stable)

Methods:

SendMessage ( aa{sv}: Message, u: Flags ) → s

Submit a message to the server for sending. If this method returns successfully, the message has been submitted to the server and the MessageSent signal is emitted. A corresponding Sent signal on the Text interface MUST also be emitted.

If this method fails, message submission to the server has failed and no signal on this interface (or the Text interface) is emitted.

Parameters

Messageaa{sv} (Message_Part[])
The message content, including any attachments or alternatives
Flagsu (Message_Sending_Flags)
Flags affecting how the message is sent.

Returns

s (Sent_Message_Token)
An opaque token used to match any incoming delivery or failure reports against this message, or an empty string if the message is not readily identifiable.

Possible errors

org.freedesktop.Telepathy.Error.InvalidArgument
The requested message is malformed and cannot be sent.
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

GetPendingMessageContent ( u: Message_ID, au: Parts ) → a{uv}

Retrieve the content of one or more parts of a pending message. Note that this function may take a considerable amount of time to return if the part's 'needs-retrieval' flag is true; consider extending the default D-Bus method call timeout. Additional API is likely to be added in future, to stream large message parts.

Parameters

Message_IDu (Message_ID)
The ID of a pending message
Partsau
The desired entries in the array of message parts, identified by their position. The "headers" part (which is not a valid argument to this method) is considered to be part 0, so the valid part numbers start at 1 (for the second Message_Part).

Returns

Contenta{uv}

The content of the requested parts. The keys in this mapping are positions in the array of message parts; the values are either of type 's' or 'ay' (UTF-8 text string, or byte array), following the same rules as for the value of the 'content' key in the Message_Part mappings.

If the one of the requested part numbers was greater than zero but referred to a part that had no content (i.e. it had no 'type' key or no 'content' key), it is simply omitted from this mapping; this is not considered to be an error condition.

Possible errors

org.freedesktop.Telepathy.Error.InvalidArgument
Either there is no pending message with the given message ID, or one of the part numbers given was 0 or too large.
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

Signals:

MessageSent ( aa{sv}: Content, s: Message_Token )

Signals that a message has been submitted for sending. This MUST be emitted exactly once per emission of the Sent signal on the Text interface.
This signal allows a process that is not the caller of SendMessage to log sent messages. The double signal-emission means that clients can safely follow the following rule: if the channel has the Messages interface, listen for Messages.MessageSent only; otherwise, listen for Text.Sent only.

Parameters

Contentaa{sv} (Message_Part[])
The message content (see Message_Part for full details). If the message that was passed to SendMessage has a formatted text part that the connection manager recognises, but no text/plain alternative, the CM MUST use the formatted text part to generate a text/plain alternative which is also included in this signal argument.
Message_Tokens (Sent_Message_Token)
An opaque token used to match any incoming delivery or failure reports against this message, or an empty string if the message is not readily identifiable.

PendingMessagesRemoved ( au: Message_IDs )

The messages with the given IDs have been removed from the PendingMessages list. Clients SHOULD NOT attempt to acknowledge those messages.
This completes change notification for the PendingMessages property (previously, there was change notification when pending messages were added, but not when they were removed).

Parameters

Message_IDsau (Message_ID[])
The messages that have been removed from the pending message list.

MessageReceived ( aa{sv}: Message )

Signals that a message has been received and added to the pending messages queue. This MUST be emitted exactly once per emission of the Received signal on the Text interface.
The double signal-emission means that clients can safely follow the following rule: if the channel has the Messages interface, listen for Messages.MessageReceived only; otherwise, listen for Text.Received only.

Parameters

Messageaa{sv} (Message_Part[])
The message content, including any attachments or alternatives

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

SupportedContentTypesas, read-only
A list of MIME types supported by this channel, with more preferred MIME types appearing earlier in the list. The list MAY include "*/*" to indicate that attachments with arbitrary MIME types can be sent. If the list is empty, this indicates that messages may only include a single "text/plain" part.
MessagePartSupportFlagsu (Message_Part_Support_Flags), read-only
Flags indicating the level of support for message parts on this channel.
PendingMessagesaaa{sv} (Message_Part[][]), read-only
A list of incoming messages that have neither been acknowledged nor rejected. This list is a superset of the one returned by ListPendingMessages on the Text interface; its items can be removed using AcknowledgePendingMessages on that interface.

Simple types

Sent_Message_Token − s

An opaque token used to identify sent messages. As a special case, the empty string indicates that there is no particular identification for a message.

CM implementations SHOULD use an identifier expected to be unique, such as a UUID, if possible.

Some protocols can only track a limited number of sent messages in a small message-ID space. As a result, clients MUST NOT assume that message tokens will not be re-used, and SHOULD use some reasonable heuristic to assign delivery reports to messages, such as matching on message content or timestamp (if available), or assuming that the delivery report refers to the most recent message with that ID.

This is a hook for the DeliveryReporting interface, to avoid having to introduce a SendMultiPartMessageAndReturnToken method in that interface.

Sets of flags:

Message_Part_Support_Flags

Flags indicating the level of support for message parts on this channel. They are designed such that setting more flags always implies that the channel has more capabilities.

It is assumed that messages containing a textual message body (only), like the messages the Text interface was designed for, are always supported.

There is no flag indicating support for alternatives. This is because the SendMessage implementation can always accept messages containing alternatives, even if the underlying protocol does not, by deleting all alternatives except the first (most preferred) that is supported.

Each of the flags 1, 2, 4 implies the previous flag, so we could have used a simple enumeration here; however, we've defined the message-part support indicator as a flag set for future expansion.
Message_Part_Support_Flag_Data_Only = 1
SendMessage will accept messages containing a single part of any type listed in the SupportedContentTypes property, with no accompanying text.
Message_Part_Support_Flag_One_Attachment = 2
SendMessage will accept messages containing a textual message body, plus a single attachment of any type listed in the SupportedContentTypes property. It does not make sense for this flag to be set if Message_Part_Support_Flag_Data_Only is not also set (because the connection manager can trivially provide an empty text part if necessary).
Message_Part_Support_Flag_Multiple_Attachments = 4
SendMessage will accept messages containing a textual message body, plus an arbitrary number of attachments of any type listed in the SupportedContentTypes property. It does not make sense for this flag to be set if Message_Part_Support_Flag_One_Attachment is not also set.

Message_Sending_Flags

Flags altering the way a message is sent. The "most usual" action should always be to have these flags unset.
Message_Sending_Flag_Report_Delivery = 1
Provide a delivery report via the DeliveryReporting interface, if possible, even if this is not the default for this protocol. Ignored if delivery reports are not possible on this protocol.
In some protocols, like XMPP, it is not conventional to request or send delivery notifications.

Mapping types

Message_Part − a{ s: Key → v: Value }

Part of a message's content. In practice, this mapping never appears in isolation - messages are represented by a list of Message_Part mappings.

An example of how a message might look, in a Python-like syntax:

[
  {
    'message-sender': 42,
    'message-sent': 1210067943,
    'message-received': 1210067947,
    'message-type': 0,
    'pending-message-id': 437,
  },
  { 'alternative': 'main',
    'type': 'text/html',
    'content': 'Here is a photo of my cat:<br />' +
               '<img src="cid:catphoto" alt="lol!" />' +
               '<br />Isn't it cute?',
  },
  { 'alternative': 'main',
    'type': 'text/plain',
    'content': 'Here is a photo of my cat:\n[IMG: lol!]\nIsn't it cute?',
  },
  { 'identifier': 'catphoto',
    'type': 'image/jpeg',
    'size': 101000,
    'needs-retrieval': True,
  },
]
          

The first part of the message contains "headers" which refer to the entire message.

It is an error for a connection manager to put keys referring to the message as a whole in the second or subsequent Message_Part, but clients MUST recover from this error by ignoring these keys in the second and subsequent parts.

Well-known keys for the message as a whole, and the corresponding value types, include:

message-sent (u - Unix_Timestamp)
The time the message was sent (if unavailable, the time it arrived at a central server MAY be used). Omitted if no reasonable approximation is available
message-received (u - Unix_Timestamp)
The time the message was received locally. SHOULD always be present.
message-sender (u - Contact_Handle)
The contact who sent the message. If 0 or omitted, the contact who sent the message could not be determined.
message-type (u - Channel_Text_Message_Type)
The type of message; if omitted, Channel_Text_Message_Type_Normal MUST be assumed. SHOULD be omitted for normal chat messages.
pending-message-id (u - Message_ID)
The incoming message ID. This MUST NOT be present on outgoing messages. Clients SHOULD NOT store this key - it is only valid for as long as the message remains unacknowledged.
interface (s - DBus_Interface)
This message is specific to the given interface, which is neither Text nor Messages. It SHOULD be ignored if that interface is not supported. (Note that an 'interface' key can also appear on the second and subsequent parts, where it indicates that that part (only) should be ignored if unsupported.)

The second and subsequent parts contain the message's content, including plain text, formatted text and/or attached files.

In any group of parts with the same non-empty value for the "alternative" key (which represent alternative versions of the same content), more faithful versions of the intended message MUST come before less faithful versions (note that this order is the opposite of MIME "multipart/alternative" parts). Clients SHOULD display the first alternative that they understand.

Specifying the preference order means that if the underlying protocol doesn't support alternatives, the CM can safely delete everything apart from the first supported alternative when sending messages.

Clients SHOULD present all parts that are not redundant alternatives in the order they appear in this array, possibly excluding parts that are referenced by another displayed part. It is implementation-specific how the parts are presented to the user.

This allows CMs to assume that all parts are actually shown to the user, even if they are not explicitly referenced - we do not yet recommend formatted text, and there is no way for plain text to reference an attachment since it has no concept of markup or references. This also forces clients to do something sensible with messages that consist entirely of "attachments", with no "body" at all.

For instance, when displaying the above example, a client that understands the HTML part should display the JPEG image once, between the two lines "Here is a photo of my cat:" and "Isn't it cute?"; it may additionally present the image in some way for a second time, after "Isn't it cute?", or may choose not to.

A client that does not understand HTML, displaying the same message, should display the plain-text part, followed by the JPEG image.

Well-known keys for the second and subsequent parts, and the corresponding value types, include:

identifier (s)
An opaque identifier for this part. Parts of a message MAY reference other parts by treating this identifier as if it were a MIME Content-ID and using the cid: URI scheme.
alternative (s)

If present, this part of the message is an alternative for all other parts with the same value for "alternative". Clients SHOULD only display one of them (this is expected to be used for XHTML messages in a future version of this specification).

If omitted, this part is not an alternative for any other part.

Parts of a message MAY reference the group of alternatives as a whole (i.e. a reference to whichever of them is chosen) by treating this identifier as if it were the MIME Content-ID of a multipart/alternative part, and using the cid: URI scheme.

type (s)

The MIME type of this part. See the documentation for ReceivedMessage for notes on the special status of "text/plain" parts.

Connection managers MUST NOT signal parts without a 'type' key; if a protocol provides no way to determine the MIME type, the connection manager is responsible for guessing it, but MAY fall back to "text/plain" for text and "application/octet-stream" for non-text.

Clients MUST ignore parts without a 'type' key, which are reserved for future expansion.

lang (s)
The natural language of this part, identified by a RFC 3066 language tag.
XMPP allows alternative-selection by language as well as by content-type.
size (u)
The size in bytes (if needs-retrieval is true, this MAY be an estimated or approximate size). SHOULD be omitted if 'content' is provided.
There's no point in providing the size if you're already providing all the content.
needs-retrieval (b)
If false or omitted, the connection manager already holds this part in memory. If present and true, this part will be retrieved on demand (like MIME's message/external-body), so clients should expect retrieval to take time; if this specification is later extended to provide a streaming version of GetPendingMessageContent, clients should use it for parts with this flag.
truncated (b)
The content available via the 'content' key or GetPendingMessageContent has been truncated by the server or connection manager (equivalent to Channel_Text_Message_Flag_Truncated in the Text interface).
content (s or ay)
The part's content, if it is available and sufficiently small to include here (implies that 'needs-retrieval' is false or omitted). Otherwise, omitted. If the part is human-readable text or HTML, the value for this key MUST be a UTF-8 string (D-Bus signature 's'). If the part is not text, the value MUST be a byte-array (D-Bus signature 'ay'). If the part is a text-based format that is not the main body of the message (e.g. an iCalendar or an attached XML document), the value SHOULD be a UTF-8 string, transcoding from another charset to UTF-8 if necessary, but MAY be a byte-array (of unspecified character set) if transcoding fails or the source charset is not known.
interface (s - DBus_Interface)
This part is specific to the given interface, which is neither Text nor Messages. It SHOULD be ignored if that interface is not supported. (Note that an 'interface' key can also appear on the first part, where it indicates that the entire message should be ignored if unsupported.)

It is an error for a connection manager to put these keys in the first Message_Part, but clients MUST be able to recover from this error by ignoring these keys in the first part.

In bindings that need a separate name, arrays of Message_Part should be called Message_Part_List.

Members

Keys
A key, which SHOULD be one of the well-known keys specified, if possible.
Valuev
The value corresponding to the given key, which must be of one of the types indicated.

org.freedesktop.Telepathy.Media.SessionHandler

An media session handler is an object that handles a number of synchronised media streams.

Methods:

Error ( u: errno, s: message ) → nothing

THIS METHOD IS DEPRECATED AND SHOULD NOT BE USED. Instead the Error function should be used on the relevant MediaStreamHandler objects. Informs the connection manager that an error occured in this session. If used, the connection manager must terminate the session and all of the streams within it, and may also emit a StreamError signal on the channel for each stream within the session.

Parameters

errnou
messages

Ready ( ) → nothing

Inform the connection manager that a client is ready to handle this session handler (i.e. that it has connected to the NewStreamHandler signal and done any other necessary setup).

Signals:

NewStreamHandler ( o: stream_handler, u: id, u: media_type, u: direction )

Emitted when a new stream handler has been created for this session.

Parameters

stream_handlero
An object path to a new MediaStreamHandler
idu
The unique ID of the new stream
media_typeu (Media_Stream_Type)
Enum for type of media that this stream should handle (a value from MediaStreamType)
directionu (Media_Stream_Direction)
Enum for direction of this stream (a value from MediaStreamDirection)

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

org.freedesktop.Telepathy.Media.StreamHandler

Handles signalling the information pertaining to a specific media stream. A client should provide information to this handler as and when it is available.

Methods:

CodecChoice ( u: codec_id ) → nothing

Inform the connection manager of the current codec choice.

Parameters

codec_idu

Error ( u: errno, s: message ) → nothing

Inform the connection manager that an error occured in this stream. The connection manager should emit the StreamError signal for the stream on the relevant channel, and remove the stream from the session.

Parameters

errnou (Media_Stream_Error)
ID of error, from the MediaStreamError enumeration
messages
String describing the error

NativeCandidatesPrepared ( ) → nothing

Informs the connection manager that all possible native candisates have been discovered for the moment.

NewActiveCandidatePair ( s: native_candidate_id, s: remote_candidate_id ) → nothing

Informs the connection manager that a valid candidate pair has been discovered and streaming is in progress.

Parameters

native_candidate_ids
remote_candidate_ids

NewNativeCandidate ( s: candidate_id, a(usuussduss): transports ) → nothing

Inform this MediaStreamHandler that a new native transport candidate has been ascertained.

Parameters

candidate_ids
String identifier for this candidate
transportsa(usuussduss) (Media_Stream_Handler_Transport[])
Array of transports for this candidate, with fields:
  • component number
  • IP address (as a string)
  • port
  • base network protocol (one of the values of MediaStreamBaseProto)
  • proto subtype (e.g. RTP)
  • proto profile (e.g. AVP)
  • our preference value of this transport (double in range 0.0-1.0 inclusive); 1 signals the most preferred transport
  • transport type, one of the values of MediaStreamTransportType
  • username if authentication is required
  • password if authentication is required

Ready ( a(usuuua{ss}): codecs ) → nothing

Inform the connection manager that a client is ready to handle this StreamHandler. Also provide it with info about all supported codecs.

Parameters

codecsa(usuuua{ss}) (Media_Stream_Handler_Codec[])
As for SupportedCodecs.

SetLocalCodecs ( a(usuuua{ss}): codecs ) → nothing

Used to provide codecs after Ready(), so the media client can go ready for an incoming call and exchange candidates/codecs before knowing what local codecs are available.

Parameters

codecsa(usuuua{ss}) (Media_Stream_Handler_Codec[])
Codecs in the same format as for SupportedCodecs, which have the same semantics as the local codecs passed to Ready

StreamState ( u: state ) → nothing

Informs the connection manager of the stream's current state, as as specified in Channel.Type.StreamedMedia::ListStreams.

Parameters

stateu (Media_Stream_State)

SupportedCodecs ( a(usuuua{ss}): codecs ) → nothing

Inform the connection manager of the supported codecs for this session. This is called after the connection manager has emitted SetRemoteCodecs to notify what codecs are supported by the peer, and will thus be an intersection of all locally supported codecs (passed to Ready) and those supported by the peer.

Parameters

codecsa(usuuua{ss}) (Media_Stream_Handler_Codec[])
List of codec info structures, each containing: ID of codec Codec name Media type Clock rate of codec Number of supported channels String key-value pairs for supported optional parameters

HoldState ( b: Held ) → nothing

Notify the connection manager that the stream's hold state has been changed successfully in response to SetStreamHeld.

Added in version 0.17.3.

Parameters

Heldb
If true, the stream is now on hold.

UnholdFailure ( ) → nothing

Notify the connection manager that an attempt to reacquire the necessary hardware or software resources to unhold the stream, in response to SetStreamHeld, has failed.

Added in version 0.17.3.

Signals:

AddRemoteCandidate ( s: candidate_id, a(usuussduss): transports )

Signal emitted when the connection manager wishes to inform the client of a new remote candidate.

Parameters

candidate_ids
String identifier for this candidate
transportsa(usuussduss) (Media_Stream_Handler_Transport[])
Array of transports for this candidate with fields, as defined in NewNativeCandidate

Close ( )

Signal emitted when the connection manager wishes the stream to be closed.

RemoveRemoteCandidate ( s: candidate_id )

Signal emitted when the connection manager wishes to inform the client that the remote end has removed a previously usable candidate.

Parameters

candidate_ids
String identifier for remote candidate to drop

SetActiveCandidatePair ( s: native_candidate_id, s: remote_candidate_id )

Emitted by the connection manager to inform the client that a valid candidate pair has been discovered by the remote end and streaming is in progress.

Parameters

native_candidate_ids
remote_candidate_ids

SetRemoteCandidateList ( a(sa(usuussduss)): remote_candidates )

Signal emitted when the connection manager wishes to inform the client of all the available remote candidates at once.

Parameters

remote_candidatesa(sa(usuussduss)) (Media_Stream_Handler_Candidate[])
A list of candidate id and a list of transports as defined in NewNativeCandidate

SetRemoteCodecs ( a(usuuua{ss}): codecs )

Signal emitted when the connection manager wishes to inform the client of the codecs supported by the remote end.

Parameters

codecsa(usuuua{ss}) (Media_Stream_Handler_Codec[])
As for SupportedCodecs

SetStreamPlaying ( b: playing )

Signal emitted when the connection manager wishes to set the stream playing or stopped.

Parameters

playingb

SetStreamSending ( b: sending )

Signal emitted when the connection manager wishes to set whether or not the stream sends to the remote end.

Parameters

sendingb

StartTelephonyEvent ( y: event )

Request that a telephony event (as defined by RFC 4733) is transmitted over this stream until StopTelephonyEvent is called.

Parameters

eventy
A telephony event code as defined by RFC 4733.

StopTelephonyEvent ( )

Request that any ongoing telephony events (as defined by RFC 4733) being transmitted over this stream are stopped.

SetStreamHeld ( b: Held )

Emitted when the connection manager wishes to place the stream on hold (so the streaming client should free hardware or software resources) or take the stream off hold (so the streaming client should reacquire the necessary resources).

When placing a channel's streams on hold, the connection manager SHOULD notify the remote contact that this will be done (if appropriate in the protocol) before it emits this signal.

It is assumed that relinquishing a resource will not fail. If it does, the call is probably doomed anyway.

When unholding a channel's streams, the connection manager SHOULD emit this signal and wait for success to be indicated via HoldState before it notifies the remote contact that the channel has been taken off hold.

This means that if a resource is unavailable, the remote contact will never even be told that we tried to acquire it.

Added in version 0.17.3.

Parameters

Heldb
If true, the stream is to be placed on hold.

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Enumerated types:

Media_Stream_Error

Media_Stream_Error_Unknown = 0
An unknown error occured.
Media_Stream_Error_EOS = 1
The end of the stream was reached.

Media_Stream_Base_Proto

Media_Stream_Base_Proto_UDP = 0
UDP (User Datagram Protocol)
Media_Stream_Base_Proto_TCP = 1
TCP (Transmission Control Protocol)

Media_Stream_Transport_Type

Media_Stream_Transport_Type_Local = 0
A local address
Media_Stream_Transport_Type_Derived = 1
An external address derived by a method such as STUN
Media_Stream_Transport_Type_Relay = 2
An external stream relay

Structure types

Media_Stream_Handler_Candidate − ( s: Name, a(usuussduss): Transports )

In bindings that need a separate name, arrays of Media_Stream_Handler_Candidate should be called Media_Stream_Handler_Candidate_List.

Members

Names
(undocumented)
Transportsa(usuussduss) (Media_Stream_Handler_Transport[])
(undocumented)

Media_Stream_Handler_Transport − ( u: Component_Number, s: IP_Address, u: Port, u: Protocol, s: Subtype, s: Profile, d: Preference_Value, u: Transport_Type, s: Username, s: Password )

In bindings that need a separate name, arrays of Media_Stream_Handler_Transport should be called Media_Stream_Handler_Transport_List.

Members

Component_Numberu
(undocumented)
IP_Addresss
(undocumented)
Portu
(undocumented)
Protocolu (Media_Stream_Base_Proto)
(undocumented)
Subtypes
(undocumented)
Profiles
(undocumented)
Preference_Valued
(undocumented)
Transport_Typeu (Media_Stream_Transport_Type)
(undocumented)
Usernames
(undocumented)
Passwords
(undocumented)

Media_Stream_Handler_Codec − ( u: Codec_ID, s: Name, u: Media_Type, u: Clock_Rate, u: Number_Of_Channels, a{ss}: Parameters )

In bindings that need a separate name, arrays of Media_Stream_Handler_Codec should be called Media_Stream_Handler_Codec_List.

Members

Codec_IDu
(undocumented)
Names
(undocumented)
Media_Typeu (Media_Stream_Type)
(undocumented)
Clock_Rateu
(undocumented)
Number_Of_Channelsu
(undocumented)
Parametersa{ss} (String_String_Map)
(undocumented)

org.freedesktop.Telepathy.Properties

Interface for channels and other objects, to allow querying and setting properties. ListProperties returns which properties are valid for the given channel, including their type, and an integer handle used to refer to them in GetProperties, SetProperties, and the PropertiesChanged signal. The values are represented by D-Bus variant types, and are accompanied by flags indicating whether or not the property is readable or writable.

Each property also has a flags value to indicate what methods are available. This is a bitwise OR of PropertyFlags values.

Methods:

GetProperties ( au: properties ) → a(uv)

Returns an array of (identifier, value) pairs containing the current values of the given properties.

Parameters

propertiesau (Property_ID[])
An array of property identifiers

Returns

a(uv) (Property_Value[])

An array of structs containing:

  • integer identifiers
  • variant boxed values

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Some property identifier requested is invalid
org.freedesktop.Telepathy.Error.PermissionDenied
Some property requested does not have the PROPERTY_FLAG_READ flag

ListProperties ( ) → a(ussu)

Returns a dictionary of the properties available on this channel.

Returns

a(ussu) (Property_Spec[])
An array of structs containing: an integer identifier a string property name a string representing the D-Bus signature of this property a bitwise OR of the flags applicable to this property

SetProperties ( a(uv): properties ) → nothing

Takes an array of (identifier, value) pairs containing desired values to set the given properties. In the case of any errors, no properties will be changed. When the changes have been acknowledged by the server, the PropertiesChanged signal will be emitted.

All properties given must have the PROPERTY_FLAG_WRITE flag, or PermissionDenied will be returned. If any variants are of the wrong type, NotAvailable will be returned. If any given property identifiers are invalid, InvalidArgument will be returned.

Parameters

propertiesa(uv) (Property_Value[])
A dictionary mapping integer identifiers to boxed values

Possible errors

org.freedesktop.Telepathy.Error.Disconnected
The connection is not currently connected and cannot be used. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)
org.freedesktop.Telepathy.Error.NotAvailable
Raised when the requested functionality is temporarily unavailable. (generic description)
org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.NetworkError
Raised when there is an error reading from or writing to the network. (generic description)

Signals:

PropertiesChanged ( a(uv): properties )

Emitted when the value of readable properties has changed.

Parameters

propertiesa(uv) (Property_Value[])

An array of structs containing:

  • integer identifiers
  • variant boxed values

The array should contain only properties whose values have actually changed.

PropertyFlagsChanged ( a(uu): properties )

Emitted when the flags of some room properties have changed.

Parameters

propertiesa(uu) (Property_Flags_Change[])

An array of structs containing:

  • integer identifiers
  • a bitwise OR of the current flags

The array should contain only properties whose flags have actually changed.

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Simple types

Property_ID − u

An unsigned integer used to represent a Telepathy property.

Sets of flags:

Property_Flags

Property_Flag_Read = 1
The property can be read
Property_Flag_Write = 2
The property can be written

Structure types

Property_Spec − ( u: Property_ID, s: name, s: signature, u: Flags )

A struct (property ID, property name, D-Bus signature, flags) representing a property, as returned by ListProperties on the Properties interface.

In bindings that need a separate name, arrays of Property_Spec should be called Property_Spec_List.

Members

Property_IDu
(undocumented)
names
(undocumented)
signatures (DBus_Signature)
(undocumented)
Flagsu (Property_Flags)
(undocumented)

Property_Flags_Change − ( u: Property_ID, u: New_Flags )

A struct (property ID, flags) representing a change to a property's flags, as seen in the PropertyFlagsChanged signal on the Properties interface.

In bindings that need a separate name, arrays of Property_Flags_Change should be called Property_Flags_Change_List.

Members

Property_IDu
(undocumented)
New_Flagsu
(undocumented)

Property_Value − ( u: Identifier, v: Value )

A struct (property ID, value) representing a property's value, as seen in the PropertiesChanged signal on the Properties interface, returned by the GetProperties method and passed to the SetProperties method.

In bindings that need a separate name, arrays of Property_Value should be called Property_Value_List.

Members

Identifieru (Property_ID)
(undocumented)
Valuev
(undocumented)

org.freedesktop.Telepathy.AccountManager

The account manager is a central service used to store account details.

The current account manager is defined to be the process that owns the well-known bus name org.freedesktop.Telepathy.AccountManager on the session bus. This process must export an /org/freedesktop/Telepathy/AccountManager object with the AccountManager interface.

Added in version 0.17.2.

Methods:

CreateAccount ( s: Connection_Manager, s: Protocol, s: Display_Name, a{sv}: Parameters ) → o

Request the creation of a new account. The account manager SHOULD NOT allow invalid accounts to be created. Accounts created through this API SHOULD have an empty PresetParameters property.

Parameters

Connection_Managers (Connection_Manager_Name)
The name of the connection manager, e.g. "salut".
Protocols (Protocol)
The protocol, e.g. "local-xmpp".
Display_Names
The initial value of the new account's DisplayName property. The account manager MAY modify this to make it unique, for instance by appending a number or the 'account' parameter.
Parametersa{sv}
Initial parameter values, as would be passed to RequestConnection.

Returns

Accounto
The new account.

Possible errors

org.freedesktop.Telepathy.Error.NotImplemented
The connection manager is not installed or does not implement that protocol.
org.freedesktop.Telepathy.Error.InvalidArgument
The parameters provided omit a required argument or provide unsupported arguments.

Signals:

AccountRemoved ( o: Account )

The given account has been removed.
This is effectively change notification for the valid and invalid accounts lists.

Parameters

Accounto
An Account, which must not be used any more.

AccountValidityChanged ( o: Account, b: Valid )

The validity of the given account has changed. New accounts are also indicated by this signal, as an account validity change (usually to True) on an account that did not previously exist.
This is effectively change notification for the valid and invalid accounts lists.

Parameters

Accounto
An Account.
Validb
True if the account is now valid.

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

Interfacesas, read-only
A list of the interfaces provided by the account manager object.
ValidAccountsao, read-only
A list of the valid (complete, usable) accounts. Change notification is via AccountValidityChanged.
This split between valid and invalid accounts makes it easy to ignore the invalid ones. The only things that should be manipulating invalid accounts are account-editing UIs, which might be able to rescue them.
InvalidAccountsao, read-only
A list of incomplete or otherwise unusable accounts. Change notification is via AccountValidityChanged.

org.freedesktop.Telepathy.Account

An Account object encapsulates the necessary details to make a Telepathy connection.

Accounts are uniquely identified by object path. The object path of an Account MUST take the form /org/freedesktop/Telepathy/Account/cm/proto/acct, where:

This API avoids specifying the "profiles" used in Mission Control 4.x or the "presets" that have been proposed to replace them. An optional interface will be provided for AM implementations that want to provide presets.

There is deliberately no functionality here for opening channels; we intend to provide that in the channel dispatcher.

Other missing features which would be better in their own interfaces:

Added in version 0.17.2.

Changed in version 0.17.6: moved the Avatar property to a separate interface

Methods:

Remove ( ) → nothing

Delete the account.

Possible errors

org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)

UpdateParameters ( a{sv}: Set, as: Unset ) → nothing

Change the value of the Parameters property. Any changes will not take effect until the next time the account is disconnected and reconnected.
Migration tools that twiddle the settings of all accounts shouldn't cause an automatic disconnect and reconnect, probably. I could be persuaded otherwise, though. Or we could add a Reconnect() method.

Parameters

Seta{sv}
A mapping from parameter names to their values. These parameters should be stored for future use.
Unsetas
A list of the names of parameters to be removed from the set of stored values, allowing the default values to be used. If the given parameters were not, in fact, stored, or even if they do not exist at all, the account manager MUST accept this without error.

Possible errors

org.freedesktop.Telepathy.Error.PermissionDenied
The user is not permitted to perform the requested operation. (generic description)
org.freedesktop.Telepathy.Error.InvalidArgument
Raised when one of the provided arguments is invalid. (generic description)

Signals:

Removed ( )

This account has been removed.
This is redundant with AccountRemoved, but it's still worth having, to avoid having to bind to AccountManager.AccountRemoved to tell you whether your Account is valid - ideally, an account-editing UI should only care about a single Account.

AccountPropertyChanged ( a{sv}: Properties )

The values of one or more properties on this interface (that do not specify that this signal does not apply to them) may have changed. This does not cover properties of other interfaces, which must provide their own change notification if appropriate.

Parameters

Propertiesa{sv}
A map from property names in this namespace (e.g. Nickname) to values. Properties whose values have not changed SHOULD be omitted, but this need not be done.

Interface has no Telepathy properties.

D-Bus core Properties:

Accessed using the org.freedesktop.DBus.Properties interface.

Interfacesas, read-only
A list of the extra interfaces provided by this account.
DisplayNames, read/write
The user-visible name of this account. This SHOULD be chosen by the user at account creation time. The account creation user interface is responsible for setting a reasonable default value in the user's locale; something like "Jabber (bob@example.com)" would be sensible.
This approximately corresponds to "display name" in NMC 4.x and Decibel.
Icons, read/write
The name of an icon in the system's icon theme, such as "im-msn", or the empty string to not specify an icon. If the icon is set to an empty string, the account manager or any client MAY derive a default icon, for instance from the protocol.
This approximately corresponds to mc_profile_get_icon_name (or possibly mc_profile_get_branding_icon_name) in NMC 4.x. It's accessed via the account rather than the profile because we no longer have profiles as a core concept.
Validb, read-only
If true, this account is considered by the account manager to be complete and usable. If false, user action is required to make it usable, and it will never attempt to connect (for instance, this might be caused by the absence of a required parameter).
For connection managers with a plugin architecture, like telepathy-haze, we have little or no control over the parameters offered; for platforms with package management, we have little or no control over the CMs offered. NMC 4.x would just pretend the account didn't exist in these circumstances, but silent data loss is bad, and UIs with CM-specific knowledge (or a user filling in newly-required parameters) might be able to rescue a broken account.
Enabledb, read/write

This property gives the users the possibility to prevent an account from being used. This flag does not change the validity of the account.

A disabled account can never be put online.

Use cases:

  • user has two or more accounts capable of calling contact X, but he doesn't want the UI to prompt him everytime about which one he wants to use for the call. He can then disable all the equivalent accounts but one.
  • There is some temporary server error and the user doesn't want to be be bother by error messages, or change the account configuration: temporarily disabling the account is quicker.

The AccountManager SHOULD allow this property to be set on invalid accounts, but MUST NOT attempt to put invalid accounts online even if they become Enabled.

There doesn't seem to be any good reason not to allow this.

Nicknameas, read/write
The nickname to set on this account for display to other contacts, as set by the user. When the account becomes connected, the account manager SHOULD set this as the user's alias using SetAliases if appropriate.
In a later specification revision, we plan to separate the concepts of a contact's nickname as set by themselves, and the local name for them in our contact list (a "handle" or "pet name" as described in XEP-0165 and its references). The terminology change from alias to nickname here is a step in that direction. This corresponds to NMC 4.x mc_account_get_alias.
Parametersa{sv}, read-only

A map from connection manager parameter names (as in the ConnectionManager interface) to their values. This property includes only those parameters that are stored for this account, and SHOULD only include those parameters that the user has explicitly set.

This property cannot be altered using Set() - use UpdateParameters instead.

This avoids NMC being tied to gconf as a matter of API.
AutomaticPresence(uss) (Simple_Presence), read/write

The presence status that this account should have if it is brought online.

Setting this property MUST NOT actually change the account's status until the next time it is (re)connected for some reason.

The Connection_Presence_Type in the structure SHOULD NOT be Offline or Unset.

In ITOS2007 and ITOS2008 this is a global preference, not visible on D-Bus (the "default presence"). "Automatic presence" better describes when it is used.
ConnectAutomaticallyb, read/write
If true, the account manager SHOULD attempt to put this account online with the AutomaticPresence whenever possible (in the base Account interface this is deliberately left vague). If false, it MUST NOT put the account online automatically in response to, for instance, connectivity changes, but SHOULD still put the account online with the AutomaticPresence if requested by the user (for instance, if the user tries to start a conversation using this account).
This approximately corresponds to NMC 4.x "enabled" and Decibel "autoreconnect".
Connections, read-only
Either the well-known bus name of the connection to this account, or the empty string if there is no connection.
ConnectionStatusu, read-only
If the Connection property is non-empty, the status of that connection. If the Connection property is the empty string, this property may either be Disconnected (indicating that the account manager is not attempting to bring it online), or Connecting (indicating that the account manager is attempting to connect). The account manager is expected to set this by observing signals from the Connection.
If the AM is doing some sort of backoff/delay on reconnection attempts, the account's status is conceptually "Connecting" even though there is no Connection. This vaguely corresponds to GetCurrentStatus in NMC 4.x.
ConnectionStatusReasonu, read-only
The reason for the last change to ConnectionStatus. The account manager is expected to set this by observing signals from the Connection.
If you weren't watching the Connection at the time it failed, you can't tell why - unless the AM can tell you. This is part of GetCurrentStatus in NMC 4.x.
CurrentPresence(uss) (Simple_Presence), read-only
The actual presence. If the connection is not online, this should be (Connection_Presence_Type_Offline, "", ""). If the connection is online but does not support the Presence interface, this should be (Connection_Presence_Type_Unset, "", ""). The account manager is expected to set this by observing signals from the Connection.
This corresponds to GetPresenceActual in NMC 4.x.
RequestedPresence(uss) (Simple_Presence), read/write

The requested presence for this account. When this is changed, the account manager should attempt to manipulate the connection manager to make CurrentPresence match RequestedPresence as closely as possible. It should not be saved to any sort of persistent storage.

When the account manager automatically connects an account, it must signal this by setting the RequestedPresence to the same thing as the AutomaticPresence.

This corresponds to e.g. GetPresence and GetPresenceMessage in NMC 4.x.
NormalizedNames, read-only

The normalized user ID of the local user on this account (i.e. the string returned when the InspectHandle method is called on the result of GetSelfHandle() for an active connection).

It is unspecified whether this user ID is globally unique.

As currently implemented, IRC user IDs are only unique within the same IRCnet. On some saner protocols, the user ID includes a DNS name which provides global uniqueness.

If this value is not known yet (which will always be the case for accounts that have never been online), it will be an empty string.

It is possible that this value will change if the connection manager's normalization algorithm changes, although this SHOULD be avoided.

It's not always completely clear what normalization algorithm should be used; for instance, in Gabble, we currently use JIDs, but it would also have been reasonable to use xmpp URIs.

org.freedesktop.Telepathy.ChannelHandler

An interface exported by client applications which are able to handle incoming channels.

Added in version 0.17.0.

Methods:

HandleChannel ( s: Bus_Name, o: Connection, s: Channel_Type, o: Channel, u: Handle_Type, u: Handle ) → nothing

Called when a channel handler should handle a new channel.

Added in version 0.17.0.

Parameters

Bus_Names (DBus_Bus_Name)
The bus name of the connection and channel
Connectiono
The object-path of the connection that owns the channel
Channel_Types (DBus_Interface)
The channel type
Channelo
The object-path of the channel
Handle_Typeu (Handle_Type)
The type of the handle that the channel communicates with, or 0 if there is no associated handle
Handleu (Handle)
The handle that the channel communicates with, or 0 if there is no associated handle

Interface has no signals.

Interface has no Telepathy properties.

Interface has no D-Bus core properties.

Generic types

Simple types

Unix_Timestamp − u

An unsigned 32-bit integer representing time since 1970

DBus_Bus_Name − s

A string representing a D-Bus bus name - either a well-known name like "org.freedesktop.Telepathy.MissionControl" or a unique name like ":1.123"

DBus_Unique_Name − s

A string representing a D-Bus unique name, such as ":1.123"

DBus_Interface − s

An ASCII string representing a D-Bus interface - two or more elements separated by dots, where each element is a non-empty string of ASCII letters, digits and underscores, not starting with a digit. The maximum total length is 255 characters. For example, "org.freedesktop.DBus.Peer".

DBus_Signature − s

A string representing a D-Bus signature (the 'g' type isn't used because of poor interoperability, particularly with dbus-glib)

DBus_Member − s

An ASCII string representing a D-Bus method, signal or property name - a non-empty string of ASCII letters, digits and underscores, not starting with a digit, with a maximum length of 255 characters. For example, "Ping".

DBus_Qualified_Member − s

A string representing the full name of a D-Bus method, signal or property, consisting of a DBus_Interface, followed by a dot, followed by a DBus_Member. For example, "org.freedesktop.DBus.Peer.Ping".

Mapping types

Qualified_Property_Value_Map − a{ s: Key → v: Value }

A mapping from strings representing D-Bus properties (by their namespaced names) to their values.

Members

Keys (DBus_Qualified_Member)
A D-Bus interface name, followed by a dot and a D-Bus property name.
Valuev
The value of the property.

String_Variant_Map − a{ s: Key → v: Value }

A mapping from strings to variants representing extra key-value pairs.

Members

Keys
(undocumented)
Valuev
(undocumented)

String_String_Map − a{ s: Key → s: Value }

A mapping from strings to strings representing extra key-value pairs.

Members

Keys
(undocumented)
Values
(undocumented)

Errors

org.freedesktop.Telepathy.Error.NetworkError

Raised when there is an error reading from or writing to the network.

org.freedesktop.Telepathy.Error.NotImplemented

Raised when the requested method, channel, etc is not available on this connection.

org.freedesktop.Telepathy.Error.InvalidArgument

Raised when one of the provided arguments is invalid.

org.freedesktop.Telepathy.Error.NotAvailable

Raised when the requested functionality is temporarily unavailable.

org.freedesktop.Telepathy.Error.PermissionDenied

The user is not permitted to perform the requested operation.

org.freedesktop.Telepathy.Error.Disconnected

The connection is not currently connected and cannot be used.

org.freedesktop.Telepathy.Error.InvalidHandle

The contact name specified is unknown on this channel or connection.

org.freedesktop.Telepathy.Error.Channel.Banned

You are banned from the channel.

org.freedesktop.Telepathy.Error.Channel.Full

The channel is full.

org.freedesktop.Telepathy.Error.Channel.InviteOnly

The requested channel is invite-only.

Index

Index of interfaces

Index of types