Home · Modules · All Classes · All Namespaces |
The ChannelRequest class represents a Telepathy channel request. More...
#include <TelepathyQt/ChannelRequest>
Inherits Tp::StatefulDBusProxy, and Tp::OptionalInterfaceFactory< ChannelRequest >.
Signals | |
void | failed (const QString &errorName, const QString &errorMessage) |
void | succeeded (const Tp::ChannelPtr &channel) |
Signals inherited from Tp::DBusProxy | |
void | invalidated (Tp::DBusProxy *proxy, const QString &errorName, const QString &errorMessage) |
Signals inherited from Tp::Object | |
void | propertyChanged (const QString &propertyName) |
Public Member Functions | |
virtual | ~ChannelRequest () |
AccountPtr | account () const |
QDateTime | userActionTime () const |
QString | preferredHandler () const |
QualifiedPropertyValueMapList | requests () const |
ChannelRequestHints | hints () const |
QVariantMap | immutableProperties () const |
PendingOperation * | cancel () |
ChannelPtr | channel () const |
Public Member Functions inherited from Tp::StatefulDBusProxy | |
StatefulDBusProxy (const QDBusConnection &dbusConnection, const QString &busName, const QString &objectPath, const Feature &featureCore) | |
virtual | ~StatefulDBusProxy () |
Public Member Functions inherited from Tp::DBusProxy | |
DBusProxy (const QDBusConnection &dbusConnection, const QString &busName, const QString &objectPath, const Feature &featureCore) | |
virtual | ~DBusProxy () |
QDBusConnection | dbusConnection () const |
QString | busName () const |
QString | objectPath () const |
bool | isValid () const |
QString | invalidationReason () const |
QString | invalidationMessage () const |
Public Member Functions inherited from Tp::Object | |
virtual | ~Object () |
Public Member Functions inherited from Tp::RefCounted | |
RefCounted () | |
virtual | ~RefCounted () |
Public Member Functions inherited from Tp::ReadyObject | |
ReadyObject (RefCounted *object, const Feature &featureCore) | |
ReadyObject (DBusProxy *proxy, const Feature &featureCore) | |
virtual | ~ReadyObject () |
virtual bool | isReady (const Features &features=Features()) const |
virtual PendingReady * | becomeReady (const Features &requestedFeatures=Features()) |
virtual Features | requestedFeatures () const |
virtual Features | actualFeatures () const |
virtual Features | missingFeatures () const |
Public Member Functions inherited from Tp::OptionalInterfaceFactory< ChannelRequest > | |
OptionalInterfaceFactory (ChannelRequest *this_) | |
~OptionalInterfaceFactory () | |
QStringList | interfaces () const |
bool | hasInterface (const QString &name) const |
Interface * | optionalInterface (InterfaceSupportedChecking check=CheckInterfaceSupported) const |
Interface * | interface () const |
Static Public Member Functions | |
static ChannelRequestPtr | create (const QDBusConnection &bus, const QString &objectPath, const QVariantMap &immutableProperties, const AccountFactoryConstPtr &accountFactory, const ConnectionFactoryConstPtr &connectionFactory, const ChannelFactoryConstPtr &channelFactory, const ContactFactoryConstPtr &contactFactory) |
static ChannelRequestPtr | create (const AccountPtr &account, const QString &objectPath, const QVariantMap &immutableProperties) |
Static Public Member Functions inherited from Tp::StatefulDBusProxy | |
static QString | uniqueNameFrom (const QDBusConnection &bus, const QString &wellKnownOrUnique) |
static QString | uniqueNameFrom (const QDBusConnection &bus, const QString &wellKnownOrUnique, QString &error, QString &message) |
Static Public Attributes | |
static const Feature | FeatureCore |
Protected Member Functions | |
ChannelRequest (const QDBusConnection &bus, const QString &objectPath, const QVariantMap &immutableProperties, const AccountFactoryConstPtr &accountFactory, const ConnectionFactoryConstPtr &connectionFactory, const ChannelFactoryConstPtr &channelFactory, const ContactFactoryConstPtr &contactFactory) | |
ChannelRequest (const AccountPtr &account, const QString &objectPath, const QVariantMap &immutableProperties) | |
Client::ChannelRequestInterface * | baseInterface () const |
Protected Member Functions inherited from Tp::DBusProxy | |
void | setBusName (const QString &busName) |
void | invalidate (const QString &reason, const QString &message) |
void | invalidate (const QDBusError &error) |
Protected Member Functions inherited from Tp::Object | |
Object () | |
void | notify (const char *propertyName) |
Protected Member Functions inherited from Tp::ReadyObject | |
ReadinessHelper * | readinessHelper () const |
Protected Member Functions inherited from Tp::OptionalInterfaceFactory< ChannelRequest > | |
void | setInterfaces (const QStringList &interfaces) |
Additional Inherited Members | |
Public Types inherited from Tp::OptionalInterfaceFactory< ChannelRequest > | |
enum | InterfaceSupportedChecking |
The ChannelRequest class represents a Telepathy channel request.
A channel request is an object in the channel dispatcher representing an ongoing request for some channels to be created or found. There can be any number of channel request objects at the same time.
A channel request can be cancelled by any client (not just the one that requested it). This means that the channel dispatcher will close the resulting channel, or refrain from requesting it at all, rather than dispatching it to a handler.
|
virtual |
Class destructor.
|
protected |
Construct a new channel request object using the given bus and the given factories.
bus | QDBusConnection to use. |
objectPath | The channel request object path. |
accountFactory | The account factory to use. |
connectionFactory | The connection factory to use. |
channelFactory | The channel factory to use. |
contactFactory | The contact factory to use. |
immutableProperties | The immutable properties of the channel request. |
|
protected |
Construct a new channel request object using the given account.
The constructed instance will use the factories from the account.
account | Account to use. |
objectPath | The channel request object path. |
immutableProperties | The immutable properties of the channel request. |
|
static |
Create a new channel request object using the given bus and the given factories.
bus | QDBusConnection to use. |
objectPath | The channel request object path. |
immutableProperties | The channel request immutable properties. |
accountFactory | The account factory to use. |
connectionFactory | The connection factory to use. |
channelFactory | The channel factory to use. |
contactFactory | The contact factory to use. |
|
static |
Create a new channel request object for the given account.
The returned instance will use factories from the account.
account | The account that the request was made through. |
objectPath | The channel request object path. |
immutableProperties | The channel request immutable properties. |
AccountPtr Tp::ChannelRequest::account | ( | ) | const |
Return the account on which this request was made.
This method can be used even before the ChannelRequest is ready, in which case the account object corresponding to the immutable properties is returned. In this case, the Account object is not necessarily ready either. This is useful for eg. matching ChannelRequests from ClientHandlerInterface::addRequest() with existing accounts in the application: either by object path, or if account factories are in use, even by object identity.
If the account is not provided in the immutable properties, this will only return a non-NULL
AccountPtr once ChannelRequest::FeatureCore is ready on this object.
QDateTime Tp::ChannelRequest::userActionTime | ( | ) | const |
Return the time at which the user action occurred, or 0 if this channel request is for some reason not involving user action.
Unix developers: this corresponds to the _NET_WM_USER_TIME property in EWMH.
This property is set when the channel request is created, and can never change.
This method can be used even before the ChannelRequest is ready: in this case, the user action time from the immutable properties, if any, is returned.
QString Tp::ChannelRequest::preferredHandler | ( | ) | const |
Return either the well-known bus name (starting with org.freedesktop.Telepathy.Client.) of the preferred handler for this channel, or an empty string to indicate that any handler would be acceptable.
This property is set when the channel request is created, and can never change.
This method can be used even before the ChannelRequest is ready: in this case, the preferred handler from the immutable properties, if any, is returned.
QualifiedPropertyValueMapList Tp::ChannelRequest::requests | ( | ) | const |
Return the desirable properties for the channel or channels to be created, as specified when placing the request in the first place.
This property is set when the channel request is created, and can never change.
This method can be used even before the ChannelRequest is ready: in this case, the requested channel properties from the immutable properties, if any, are returned. This is useful for e.g. matching ChannelRequests from ClientHandlerInterface::addRequest() with existing requests in the application (by the target ID or handle, most likely).
ChannelRequestHints Tp::ChannelRequest::hints | ( | ) | const |
Return the dictionary of metadata provided by the channel requester when requesting the channel.
This property is set when the channel request is created, and can never change.
This method can be used even before the ChannelRequest is ready: in this case, the requested channel properties from the immutable properties, if any, are returned. This is useful for e.g. matching ChannelRequests from ClientHandlerInterface::addRequest() with existing requests in the application (by the target ID or handle, most likely).
QVariantMap Tp::ChannelRequest::immutableProperties | ( | ) | const |
Return all of the immutable properties passed to this object when created.
This is useful for e.g. getting to domain-specific properties of channel requests.
PendingOperation * Tp::ChannelRequest::cancel | ( | ) |
Cancel the channel request.
If failed() is emitted in response to this method, the error will be TP_QT_ERROR_CANCELLED.
If the channel has already been dispatched to a handler, then it's too late to call this method, and the channel request will no longer exist.
ChannelPtr Tp::ChannelRequest::channel | ( | ) | const |
Return the Channel which this request succeeded with, if any.
This will only ever be populated if Account::requestsSucceedWithChannel() is true
, and succeeded() has already been emitted on this ChannelRequest. Note that a PendingChannelRequest being successfully finished already implies succeeded() has been emitted.
|
signal |
Emitted when the channel request has failed. No further methods must not be called on it.
errorName | The name of a D-Bus error. |
errorMessage | The error message. |
|
signal |
Emitted when the channel request has succeeded. No further methods must not be called on it.
The channel parameter can be used to observe the channel resulting from the request (e.g. for it getting closed). The pointer may be NULL if the Channel Dispatcher implementation is too old. Whether a non-NULL channel can be expected can be checked with Account::requestsSucceedWithChannel().
If there is a channel, it will be of the subclass determined by and made ready (or not) according to the settings of the ChannelFactory on the Account the request was made through.
channel | Pointer to a proxy for the resulting channel, if the Channel Dispatcher reported it. |
|
protected |
Return the ChannelRequestInterface for this ChannelRequest class. This method is protected since the convenience methods provided by this class should always be used instead of the interface by users of the class.
|
static |
Feature representing the core that needs to become ready to make the ChannelRequest object usable.
Note that this feature must be enabled in order to use most ChannelRequest methods.
When calling isReady(), becomeReady(), this feature is implicitly added to the requested features.
TelepathyQt 0.9.8 | Generated by 1.8.15 |