InvokeTargetReply

Since: BlackBerry 10.0.0

#include <bb/system/InvokeTargetReply>

To link against this class, add the following line to your .pro file: LIBS += -lbbsystem

Encapsulates the result from an invocation request.

When a client sends an invocation request to the invocation service it subsequently receives a reply message indicating the success of the request. To handle the reply message connect to the InvokeTargetReply::finished() signal of the object returned by InvokeManager::invoke(). This method is asynchronous and returns immediately, using the returned InvokeTargetReply object as a future. Consequently, the values returned by the error(), target() and targetType() methods are not valid until the reply message arrives (when finished() is emitted).


Overview

Inheritance

bb::system::InvokeReply
bb::system::InvokeTargetReply

Public Functions Index

InvokeTargetReply (QObject *parent=0)
virtual ~InvokeTargetReply ()
QStringtarget () const
bb::system::InvokeTarget::TypetargetType () const
bb::system::InvokeReplyError::Typeerror () const Inherited
interrorCode () const Inherited
InvokeReply (QObject *parent=0)Inherited
boolisFinished () const Inherited

Signals Index

Only has inherited signals

voidfinished ()Inherited

Public Functions

InvokeTargetReply (

Creates a new InvokeTargetReply object.

Parameters
parent

If not 0, the supplied parent will be responsible for deleting this instance.

Since:

BlackBerry 10.0.0

virtual~InvokeTargetReply ()

Destructor.

Since:

BlackBerry 10.0.0

QString target ()

Returns the target that has been invoked.

An empty QString is returned if the request includes a specific target.

Return:

The invoked target.

Since:

BlackBerry 10.0.0

bb::system::InvokeTarget::Type targetType ()

Returns the type of the target that has been invoked.

Return:

The invoked target type. See bb::system::InvokeTarget::Type for this list of target types.

Since:

BlackBerry 10.0.0

bb::system::InvokeReplyError::Type error ()Inherited

Returns the error type from the reply message.

The return value is not valid until a reply message has been received. The error code can be retrieved via errorCode().

Return:

The error type from the reply message. See bb::system::InvokeReplyError for the list of possible results.

Since:

BlackBerry 10.0.0

int errorCode ()Inherited

Returns the error code from the reply message.

The return value is not valid until a reply message has been received. The error type can be retrieved via error().

Return:

The error code from the reply message.

InvokeReply (Inherited

Creates a new InvokeReply object.

Parameters
parent

If not 0, the supplied parent will be responsible for deleting this instance.

Since:

BlackBerry 10.0.0

bool isFinished ()Inherited

Checks whether a reply message has been received.

The value returned by the error() method is not valid until a reply message has been received.

Return:

true if a reply message has been received, false otherwise.

Since:

BlackBerry 10.0.0

Signals

(Only has inherited signals)

void finished ()Inherited

Emitted when a reply message is received.

The value returned by the error() method is not valid until a reply message has been received.

Since:

BlackBerry 10.0.0

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus