QContactAction Class Reference

Member Function Documentation

QContactAction::~QContactAction () [pure virtual]

Clears any memory in use by this instance of the action implementation

QContactAction * QContactAction::action ( const QContactActionDescriptor & descriptor ) [static]

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. The caller is able to delete the action at any time, however doing so prior to when the action transitions to a finished state may have an undefined outcome depending on the implementation of the action.

QList<QContactActionDescriptor> QContactAction::actionDescriptors ( const QString & actionName = QString() ) [static]

Returns a list of QContactActionDescriptor instances which identified implementations of the given actionName. The action name may either be one of the default action names, or any other arbitrary string.

Example:

 QList<QContactActionDescriptor> availableCallActions = QContactAction::actionDescriptors(QContactAction::ActionCall);

Example 2:

 QList<QContactActionDescriptor> customActions = QContactAction::actionDescriptors("customActionName");

The actions which are available depend on which action plugins have been installed. For more information on this topic (for example, if you are interested in providing an action plugin for third-party developers to use) please see the relevant documentation for action providers.

QStringList QContactAction::availableActions ( const QString & serviceName = QString() ) [static]

Returns a list of identifiers of the available actions which are provided by the service provider with the given serviceName. If serviceName is empty, actions from all service providers and of any implementation version are returned.

bool QContactAction::invokeAction ( const QList<QContactActionTarget> & targets, const QVariantMap & parameters = QVariantMap() ) [pure virtual]

This is an overloaded function.

Initiates the action on the specified list of targets with the optional supplied parameters.

At some point after invocation, one or more resultsAvailable() signals will be emitted by the action instance. The results of the action (if any) may be retrieved by calling results(). When the state of the action changes, the stateChanged() signal will be emitted.

Returns true if the action was invoked successfully, otherwise false. The return value says nothing about whether the action which was invoked was successful or not, only whether it was initiated or the request for it to be initiated was sent successfully (e.g., if the action is implemented as a one-way RPC call).

See also results() and stateChanged().

bool QContactAction::invokeAction ( const QContact & contact, const QContactDetail & detail = QContactDetail(), const QVariantMap & parameters = QVariantMap() )

This is an overloaded function.

This is a convenience function.

Initiates the 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, with the given parameters specified.

See also results() and stateChanged().

bool QContactAction::invokeAction ( const QContactActionTarget & target, const QVariantMap & parameters = QVariantMap() )

This is an overloaded function.

This is a convenience function,

Initiates the action on the specified target with the given parameters specified.

See also results() and stateChanged().

QVariantMap QContactAction::results () const [pure virtual]

Returns the result of the action, if any exists. Calling this function prior to receiving the resultsAvailable() signal will not return a meaningful result.

void QContactAction::resultsAvailable () [signal]

This signal is emitted by an action instance whose functionality has been initiated with invokeAction() when results of the action are available. Not all actions will have results, and these actions will not emit the resultsAvailable() signal.

If the action implementation is incapable of reporting results of the operation (for example, the action is implemented via a one-way IPC call) it should transition to the QContactAction::FinishedDetachedState state immediately upon invocation.

State QContactAction::state () const [pure virtual]

Returns the current state of the action.

See also stateChanged().

void QContactAction::stateChanged ( QContactAction::State newState ) [signal]

This signal is emitted when the state of an action changes to the given newState.

See also state().