InvokeQueryTargetsReply

Since: BlackBerry 10.0.0

#include <bb/system/InvokeQueryTargetsReply>

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

Encapsulates the set of results from a query request.

When a client sends a query message to the invocation service it subsequently receives a reply message indicating the success of the request and the results of the search. To handle the reply message, connect to the InvokeQueryTargetsReply::finished() signal of the object returned by InvokeManager::queryTargets(). This method is asynchronous returning immediately and using InvokeQueryTargetsReply as a future. Consequently, the values returned by the error() and actions() methods are not valid until the reply message arrives (when finished() is emitted).


Overview

Inheritance

bb::system::InvokeReply
bb::system::InvokeQueryTargetsReply

Public Functions Index

InvokeQueryTargetsReply (QObject *parent=0)
virtual ~InvokeQueryTargetsReply ()
QList< InvokeAction >actions () 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

InvokeQueryTargetsReply (

Creates a new InvokeQueryTargetsReply object.

Parameters
parent

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

Since:

BlackBerry 10.0.0

virtual~InvokeQueryTargetsReply ()

Destructor.

Since:

BlackBerry 10.0.0

QList< InvokeAction > actions ()

Returns the list of matching targets, grouped by action, from the reply message.

Return:

The list of matching targets from the reply message.

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-09-30



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

comments powered by Disqus