Home · All Classes · All Namespaces · Modules · Functions · Files |
#include <TelepathyQt4/Client>
Inherits Tp::AbstractInterface.
Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Client.Observer."
Tp::Client::ClientObserverInterface::ClientObserverInterface | ( | const QString & | busName, |
const QString & | objectPath, | ||
QObject * | parent = 0 |
||
) |
Creates a ClientObserverInterface associated with the given object on the session bus.
busName | Name of the service the object is on. |
objectPath | Path to the object on the service. |
parent | Passed to the parent class constructor. |
Tp::Client::ClientObserverInterface::ClientObserverInterface | ( | const QDBusConnection & | connection, |
const QString & | busName, | ||
const QString & | objectPath, | ||
QObject * | parent = 0 |
||
) |
Creates a ClientObserverInterface associated with the given object on the given bus.
connection | The bus via which the object can be reached. |
busName | Name of the service the object is on. |
objectPath | Path to the object on the service. |
parent | Passed to the parent class constructor. |
Tp::Client::ClientObserverInterface::ClientObserverInterface | ( | Tp::DBusProxy * | proxy | ) |
Creates a ClientObserverInterface associated with the same object as the given proxy.
proxy | The proxy to use. It will also be the QObject::parent() for this object. |
Tp::Client::ClientObserverInterface::ClientObserverInterface | ( | const Tp::Client::ClientInterface & | mainInterface | ) | [explicit] |
Creates a ClientObserverInterface associated with the same object as the given proxy. Additionally, the created proxy will have the same parent as the given proxy.
mainInterface | The proxy to use. |
Tp::Client::ClientObserverInterface::ClientObserverInterface | ( | const Tp::Client::ClientInterface & | mainInterface, |
QObject * | parent | ||
) |
Creates a ClientObserverInterface associated with the same object as the given proxy. However, a different parent object can be specified.
mainInterface | The proxy to use. |
parent | Passed to the parent class constructor. |
static QLatin1String Tp::Client::ClientObserverInterface::staticInterfaceName | ( | ) | [inline, static] |
Returns the name of the interface "org.freedesktop.Telepathy.Client.Observer", which this class represents.
Tp::PendingVariant* Tp::Client::ClientObserverInterface::requestPropertyObserverChannelFilter | ( | ) | const [inline] |
Asynchronous getter for the remote object property "ObserverChannelFilter" of type Tp::ChannelClassList.
A specification of the channels in which this observer is interested. The <tp:member-ref>ObserveChannels</tp:member-ref> method should be called by the channel dispatcher whenever any of the new channels in a <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface.Requests">NewChannels</tp:dbus-ref> signal match this description.
Only certain D-Bus types have useful semantics for matching like this, so only certain types are allowed:
Matched by numeric value, regardless of type (e.g. 42 as a 16-bit signed integer 'n' is considered equal to 42 as a 32-bit unsigned integer 'u')
Matched by equality in the obvious way; not considered equal to any other type
Matched by equality in the obvious way; not considered equal to any other type
Matched by equality in the obvious way; not considered equal to any other type
This property never changes while the observer process owns its Client bus name. For activatable processes, the filter can change due to an upgrade - the channel dispatcher SHOULD observe changes to .client files using a mechanism like inotify.
<tp:rationale>
Not allowing this property to change is a simplification, particularly for activatable processes (we reject the possibility that a process with a .client file, when activated, has a filter that differs from what its .client file said).
If an Observer wants to add extra channels to its list of interests at runtime, it can register an additional Client bus name (for instance, the org.freedesktop.Telepathy.Client.Empathy process with unique name :1.42 could additionally register org.freedesktop.Telepathy.Client.Empathy._1_42) with additional filters. To remove those filters, it can release the bus name; it could even re-claim the bus name immediately, with different filters.
The same principle is applied to Approvers and Handlers. </tp:rationale>
For observers that have a .client file, the channel dispatcher may discover this property from keys of the form "propertyname type
", in groups in the .client file whose name is the name of this interface followed by .ObserverChannelFilter
, a space and an ASCII decimal number starting from 0.
Values in the .client file are encoded in exactly the same way as the default-p
keys in .manager files, as described in the <tp:dbus-ref namespace="org.freedesktop.Telepathy">ConnectionManager</tp:dbus-ref> interface (but note that not all types supported in .manager files can appear in .client files).
For instance, a .client file for an observer that is only interested in Text channels, with CONTACT or ROOM handles, that were requested by a local client:
[org.freedesktop.Telepathy.Client] Interfaces=org.freedesktop.Telepathy.Client.Observer;
[org.freedesktop.Telepathy.Client.Observer.ObserverChannelFilter 0] org.freedesktop.Telepathy.Channel.ChannelType s=org.freedesktop.Telepathy.Channel.Type.Text org.freedesktop.Telepathy.Channel.TargetHandleType u=1 org.freedesktop.Telepathy.Channel.Requested b=true
[org.freedesktop.Telepathy.Client.Observer.ObserverChannelFilter 1] org.freedesktop.Telepathy.Channel.ChannelType s=org.freedesktop.Telepathy.Channel.Type.Text org.freedesktop.Telepathy.Channel.TargetHandleType u=2 org.freedesktop.Telepathy.Channel.Requested b=true
Tp::PendingVariant* Tp::Client::ClientObserverInterface::requestPropertyRecover | ( | ) | const [inline] |
Asynchronous getter for the remote object property "Recover" of type bool.
If true, upon the startup of this observer, <tp:dbus-ref namespace="org.freedesktop.Telepathy.Client.Observer">ObserveChannels</tp:dbus-ref> will be called for every already existing channel matching its <tp:dbus-ref namespace="org.freedesktop.Telepathy.Client.Observer">ObserverChannelFilter</tp:dbus-ref>
When an activatable client having this property disappears from the bus and there are channels matching its ObserverChannelFilter, ObserveChannels will be called immediately to reactivate it again. Such clients should specify this property in their .client
file as follows:
[org.freedesktop.Telepathy.Client.Observer] Recover=true
<tp:rationale>
This means that if an activatable Observer crashes, it will be restarted as soon as possible; while there is an unavoidable possibility that it will miss some events during this process (particularly <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel.Type">Text</tp:dbus-ref> messages), this window of event loss is kept to a minimum.
Non-activatable observers can't take advantage of this mechanism, but setting this property on a non-activatable observer does allow it to "catch up" on channels that are currently active at the time that it starts up. </tp:rationale>
When the ObserveChannels method is called due to observer recovery, the Observer_Info dictionary will contain one extra item mapping the key "recovering"
to True
.
Tp::PendingVariant* Tp::Client::ClientObserverInterface::requestPropertyDelayApprovers | ( | ) | const [inline] |
Asynchronous getter for the remote object property "DelayApprovers" of type bool.
If true, the channel dispatcher will wait for <tp:member-ref>ObserveChannels</tp:member-ref> to return before calling <tp:dbus-ref namespace="ofdT.Client">Approver.AddDispatchOperation</tp:dbus-ref> on appropriate Approvers.
This property SHOULD be false unless there is a reason why a channel should not be given to approvers. An example of this is if an Observer is also a Handler and wants to <tp:dbus-ref namespace="ofdT.ChannelDispatchOperation">Claim</tp:dbus-ref> a channel so that it becomes its handler and doesn't want any approver to be called, this property should be true.
Observers and Approvers should be called at the same time in normal operation (with this property set to false) to improve responsiveness. For example, if an incoming call appears, the approver should get the channel as fast as possible to show a dialog, but if an approver has to make round-trips to set itself up, then the approval of the channel is delayed. As a result, it is recommended for this property to remain false unless absolutely necessary.
For service-activatable clients, this property should be specified in the observer's .client
file as follows:
If this property is not implemented (telepathy-mission-control 5.7.5 and older), the channel dispatcher SHOULD consider it as being false.
[org.freedesktop.Telepathy.Client.Observer] DelayApprovers=true
Tp::PendingVariantMap* Tp::Client::ClientObserverInterface::requestAllProperties | ( | ) | const [inline] |
Request all of the DBus properties on the interface.
QDBusPendingReply Tp::Client::ClientObserverInterface::ObserveChannels | ( | const QDBusObjectPath & | account, |
const QDBusObjectPath & | connection, | ||
const Tp::ChannelDetailsList & | channels, | ||
const QDBusObjectPath & | dispatchOperation, | ||
const Tp::ObjectPathList & | requestsSatisfied, | ||
const QVariantMap & | observerInfo, | ||
int | timeout = -1 |
||
) | [inline, slot] |
Begins a call to the D-Bus method "ObserveChannels" on the remote object.
Called by the channel dispatcher when channels in which the observer has registered an interest are announced in a <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface.Requests">NewChannels</tp:dbus-ref> signal.
If the same NewChannels signal announces some channels that match the filter, and some that do not, then only a subset of the channels (those that do match the filter) are passed to this method.
If the channel dispatcher will split up the channels from a single NewChannels signal and dispatch them separately (for instance because no installed Handler can handle all of them), it will call ObserveChannels several times.
The observer MUST NOT return from this method call until it is ready for a handler for the channel to run (which may change the channel's state).
<tp:rationale>
The channel dispatcher must wait for observers to start up, to avoid the following race: text channel logger (observer) gets ObserveChannels, text channel handler gets <tp:dbus-ref namespace="org.freedesktop.Telepathy.Client.Handler">HandleChannels</tp:dbus-ref> channel handler starts up faster and acknowledges messages, logger never sees those messages. </tp:rationale>
The channel dispatcher SHOULD NOT change its behaviour based on whether this method succeeds or fails: there are no defined D-Bus errors for this method, and if it fails, this only indicates that an Observer is somehow broken.
<tp:rationale>
The expected error response in the channel dispatcher is to log a warning, and otherwise continue as though this method had succeeded. </tp:rationale>
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
account | The Account with which the channels are associated. The well-known bus name to use is that of the AccountManager. |
connection | The Connection with which the channels are associated. The well-known bus name to use can be derived from this object path by removing the leading '/' and replacing all subsequent '/' by '.'. |
channels | The Channels and their properties. Their well-known bus names are all the same as that of the Connection. |
dispatchOperation |
The path to the <tp:dbus-ref namespace="org.freedesktop.Telepathy">ChannelDispatchOperation</tp:dbus-ref> for these channels, or the special value '/' if there is no ChannelDispatchOperation (because the channels were requested, not incoming).
If the Observer calls <tp:dbus-ref namespace="org.freedesktop.Telepathy.ChannelDispatchOperation">Claim</tp:dbus-ref> or <tp:dbus-ref namespace="org.freedesktop.Telepathy.ChannelDispatchOperation">HandleWith</tp:dbus-ref> on the dispatch operation, it MUST be careful to avoid deadlock, since these methods cannot return until the Observer has returned from <tp:member-ref>ObserveChannels</tp:member-ref>.
<tp:rationale>
This allows an Observer to <tp:dbus-ref namespace="org.freedesktop.Telepathy.ChannelDispatchOperation">Claim</tp:dbus-ref> a set of channels without having to match up calls to this method with calls to <tp:dbus-ref namespace="org.freedesktop.Telepathy.Client.Approver">AddDispatchOperation</tp:dbus-ref>. </tp:rationale>
requestsSatisfied | The ChannelRequests satisfied by these channels. If the same process is an Observer and a Handler, it can be useful to be given this information as soon as possible (it will also be passed to Handler.HandleChannels). |
observerInfo |
Additional information about these channels. Currently defined keys are:
recovering
- b True
if ObserveChannels was called for an existing channel (due to the <tp:member-ref>Recover</tp:member-ref> property being True
); False
or omitted otherwise.
<tp:rationale> This allows observers to distinguish between new channels (the normal case), and existing channels that were given to the observer in order to catch up on previous events (perhaps after a previous instance of the same observer crashed). </tp:rationale>
request-properties
- a{oa{sv}} All defined keys for this dictionary are optional; observers MAY safely ignore any entry in this dictionary.
timeout | The timeout in milliseconds. |
void Tp::Client::ClientObserverInterface::invalidate | ( | Tp::DBusProxy * | proxy, |
const QString & | error, | ||
const QString & | message | ||
) | [protected, virtual] |
Reimplemented from Tp::AbstractInterface.
Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation | Telepathy-Qt4 0.7.1 |