|
Home · All Classes · All Functions · | |
The QContactAction class provides an interface for performing an action on a QContact or QContactDetail. More...
#include <QContactAction>
Inherits QObject.
| enum | State { InactiveState, AutonomousState, ActiveState, FinishedState, FinishedWithErrorState } |
| virtual | ~QContactAction () = 0 |
| virtual QContactActionDescriptor | actionDescriptor () const = 0 |
| virtual QContactFilter | contactFilter ( const QVariant & value = QVariant() ) const = 0 |
| virtual void | invokeAction ( const QContact & contact, const QContactDetail & detail = QContactDetail() ) = 0 |
| virtual QVariantMap | metaData () const = 0 |
| virtual QVariantMap | result () const = 0 |
| virtual QList<QContactDetail> | supportedDetails ( const QContact & contact ) const |
| virtual bool | supportsDetail ( const QContactDetail & detail ) const = 0 |
| void | progress ( QContactAction::State state, const QVariantMap & result ) |
| QContactAction * | action ( const QContactActionDescriptor & descriptor ) |
| QList<QContactActionDescriptor> | actionDescriptors ( const QString & actionName = QString(), const QString & vendorName = QString(), int implementationVersion = -1 ) |
| QStringList | availableActions ( const QString & vendor = QString(), int implementationVersion = -1 ) |
The QContactAction class provides an interface for performing an action on a QContact or QContactDetail.
An action is anything that can be performed on a contact, or a detail of a contact. An example of an action might be "Send Email" or "Dial" or "Plot Navigation Route". One action may be implemented by multiple vendors, and indeed one vendor may provide multiple implementations of the same action. The name of an action identifies its semantics, while its implementation version distinguishes it from other implementations of the action by the same vendor.
Invocation of an action is asynchronous; at some stage after calling invokeAction() the action instance will emit the progress() signal. Any results of the action may be retrieved by calling result().
Each instance of a QContactAction is created by a QContactActionFactory when QContactActionFactory::instance() is called; the caller takes ownership of the action instance.
See also QContactActionFactory and QContactActionFilter.
Describes the current status of the asynchronous action operation
| Constant | Value | Description |
|---|---|---|
| QContactAction::InactiveState | 0 | The operation has not yet been initiated |
| QContactAction::AutonomousState | 1 | The operation was initiated but no further information is or will be available |
| QContactAction::ActiveState | 2 | The operation was initiated and is not yet finished |
| QContactAction::FinishedState | 3 | The operation successfully completed |
| QContactAction::FinishedWithErrorState | 4 | The operation has finished, but an error occurred |
Clears any memory in use by this instance of the action implementation
Returns a pointer to a new instance of the action implementation identified by the given descriptor. The caller takes ownership of the action implementation and must delete it to avoid leaking memory.
Returns the descriptor which uniquely identifies this action implementation. A descriptor consists of an action name, a vendor name and an implementation version. The name of the action identifies the action provided; different implementations of an action with the same name must provide the same functionality, but may differ in implementation semantics. Hence, the action name includes the major version of the interface definition implemented. The vendor name is the identification string of the vendor which has provided this implementation. The implementation version is the (minor) version of the implementation, and is vendor-specific.
See also QContactActionDescriptor.
Returns a list of QContactActionDescriptor instances which identified implementations of the given actionName which are provided by the given vendorName and are of the given implementationVersion. If actionName is empty, descriptors for implementations of all actions are returned; if vendorName is empty, descriptors for implementations provided by any vendor and of any implementation version are returned; if implementationVersion is empty, descriptors for any implementations provided by the given vendorName of the given actionName are returned.
Returns a list of identifiers of the available actions which are provided by the given vendor and of the given implementationVersion. If vendor is empty, actions from all vendors and of any implementation version are returned; if implementationVersion is empty, any actions from the given vendor (regardless of implementation version) are returned.
Returns a filter which may be used to filter contacts by the availability of this action implementation for them. If value is valid, only contacts which have a detail with the given value and for which the action is available are returned
Initiates the implemented action on the specified detail of the given contact, or on the first eligible detail saved in the contact if the given detail is empty. At some point after invocation, one or more progress() signals will be emitted by the action instance. The results of the action (if any) may be retrieved by calling result().
See also result() and progress().
Returns the meta-data associated with this action, such as icons, labels or sound cues
This signal is emitted by an action instance whose functionality has been initiated with invokeAction(). It provides clients with the current state of the action, and any result associated with the action. This signal must be emitted at least once by every action instance after invokeAction() is called.
If the action implementation is incapable of reporting the status of the operation (for example, the action is implemented via a one-way IPC call) it should emit the progress signal with state set to QContactAction::AutonomousState.
Returns the result of the action, if any exists. Calling this function prior to receiving the progress() signal will not return a meaningful result.
Returns a list of the details saved in the given contact which contain the fields required for this action to be performed on them.
The default implementation of this function simply tests all the details in the contact using supportsDetail()
Returns true if the provided detail contains the fields required for this action to be performed on it; otherwise, returns false
| Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies) | Trademarks | Qt Mobility Project 1.0.0 |