Home · Modules · All Classes · All Namespaces
Public Member Functions | List of all members
Tp::AbstractClient Class Reference

The AbstractClient class represents a Telepathy client. More...

#include <TelepathyQt/AbstractClient>

Inherits Tp::RefCounted.

Inherited by Tp::AbstractClientApprover [virtual], Tp::AbstractClientHandler [virtual], and Tp::AbstractClientObserver [virtual].

Public Member Functions

 AbstractClient ()
 
virtual ~AbstractClient ()
 
bool isRegistered () const
 
- Public Member Functions inherited from Tp::RefCounted
 RefCounted ()
 
virtual ~RefCounted ()
 

Detailed Description

The AbstractClient class represents a Telepathy client.

Clients are programs used to process channels, approving, handling or observing them. User interface processes are the obvious example of clients, but they can provide other functionality, such as address-book synchronization, message logging, etc.

Each client is either an observer, an approver, a handler, or some combination of these.

Clients can be activatable services (those with a D-Bus .service file) so that they can run in response to channel creation, or non-activatable services (those that do not register a D-Bus .service file for their well-known name, but do request it at runtime) so that they can process channels, but only if they are already running - for instance, a full-screen media center application might do this.

As an optimization, service-activatable clients should install a file $XDG_DATA_DIRS/telepathy/clients/clientname.client containing a cached version of their immutable properties. The syntax of these files is documented in the Telepathy specification.

Non-activatable clients may install a .client file, but there's not much point in them doing so.

This is a base class and should not be used directly, use the specialized classes AbstractClientObserver, AbstractClientApprover and AbstractClientHandler instead.

If the same process wants to be either a mix of observer, approver and handler, or a combination of those it can multiple inherit the specialized abstract classes.

See also
AbstractClientObserver, AbstractClientApprover, AbstractClientHandler

Constructor & Destructor Documentation

◆ AbstractClient()

Tp::AbstractClient::AbstractClient ( )

Construct a new AbstractClient object.

Note that this is a base class and should not be used directly, use the specialized classes AbstractClientObserver, AbstractClientApprover and AbstractClientHandler instead.

◆ ~AbstractClient()

Tp::AbstractClient::~AbstractClient ( )
virtual

Class destructor.

Member Function Documentation

◆ isRegistered()

bool Tp::AbstractClient::isRegistered ( ) const

Return whether this client is registered.

Returns
true if registered, false otherwise.