InvokeQueryTargetsRequest

Since: BlackBerry 10.0.0

#include <bb/system/InvokeQueryTargetsRequest>

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

Encapsulates a request to query invokable targets that match a set of search criteria.

Clients discover available targets by creating an instance of InvokeQueryTargetsRequest, populating it with data, and passing the object to InvokeManager::queryTargets(). Query messages must contain a target type, and must further contain either a MIME type or a uniform resource identifier (URI) or both. All other fields are optional and can be used to restrict the set of search results further.


Overview

Public Functions Index

InvokeQueryTargetsRequest ()
InvokeQueryTargetsRequest (const InvokeQueryTargetsRequest &other)
~InvokeQueryTargetsRequest ()
QStringaction () const
InvokeAction::TypeactionType () const
QStringmimeType () const
InvokeQueryTargetsRequest &operator= (const InvokeQueryTargetsRequest &other)
voidsetAction (const QString &name)
voidsetActionType (InvokeAction::Type type)
voidsetMimeType (const QString &type)
voidsetTargetTypes (InvokeTarget::Types types)
voidsetUri (const QUrl &uri)
voidsetUri (const QString &uri)
InvokeTarget::TypestargetTypes () const
QUrluri () const

Public Functions

InvokeQueryTargetsRequest ()

Creates a new InvokeQueryTargetsRequest object.

Since:

BlackBerry 10.0.0

InvokeQueryTargetsRequest (

Creates a copy of an existing InvokeQueryTargetsRequest object.

Parameters
other

The source InvokeQueryTargetsRequest object to copy.

Since:

BlackBerry 10.0.0

~InvokeQueryTargetsRequest ()

Destructor.

Since:

BlackBerry 10.0.0

QString action ()

Returns the operation to be performed by the target.

Valid values are target-specific. If omitted, search results are not filtered by action.

Required: NO.

Return:

The operation to be performed by the target or an empty string to select all available actions.

Since:

BlackBerry 10.0.0

InvokeAction::Type actionType ()

Returns the class of actions used to filter the search results.

The default value is bb::system::InvokeAction::All.

Required: YES.

See also:

bb::system::InvokeAction::Type for the list of actions.

Return:

The class of actions used to filter the search results.

Since:

BlackBerry 10.0.0

QString mimeType ()

Returns the format of the data sent to the target.

The MIME type must be a valid Internet media type, such as "image/png". If omitted, the MIME type will be inferred from the URI.

Required: NO if a URI is provided, YES if no URI is specified.

Return:

The Internet media type of the data or an empty string to select all available types.

Since:

BlackBerry 10.0.0

InvokeQueryTargetsRequest & operator= (

Copies the data of an existing InvokeQueryTargetsRequest object to this object.

Parameters
other

The source InvokeQueryTargetsRequest object to copy.

Return:

The InvokeQueryTargetsRequest instance.

Since:

BlackBerry 10.0.0

void setAction (

Sets the operation to be performed by the target.

Valid values are target-specific. If omitted, search results are not filtered by action.

Required: NO.

Parameters
name

The operation to be performed by the target or an empty string to select all available actions.

Since:

BlackBerry 10.0.0

void setActionType (

Sets the class of actions used to filter the search results.

The default value is bb::system::InvokeAction::All.

Required: YES.

Parameters
type

The class of actions used to filter the search results. See bb::system::InvokeAction::Type for the list of actions.

Since:

BlackBerry 10.0.0

void setMimeType (

Returns the format of the data sent to the target.

The supplied type must be a valid Internet media type, such as "image/png". If omitted, search results are not filtered by MIME type.

Required: NO if a URI is provided, YES if no URI is specified.

Parameters
type

The Internet media type of the data or an empty string to select all available types.

Since:

BlackBerry 10.0.0

void setTargetTypes (
  • InvokeTarget::Typestypes)

Sets the class of targets used to filter the search results.

Required: YES.

Parameters
types

The class of targets used to filter the search results. See bb::system::InvokeTarget::Type for the list of individual target types.

Since:

BlackBerry 10.0.0

void setUri (

Sets the uniform resource identifier (URI) sent to the target.

If omitted, the search results are not filtered by URI handler.

Required: NO if a MIME type is provided, YES if no MIME type is specified.

Parameters
uri

The uniform resource identifier (URI) sent to the target or an empty URI to select all available URI handlers.

Since:

BlackBerry 10.0.0

void setUri (

Sets the uniform resource identifier (URI) sent to the target.

If omitted, the search results are not filtered by URI handler.

Required: NO if a MIME type is provided, YES if no MIME type is specified.

Parameters
uri

A string representing the uniform resource identifier (URI) sent to the target, or an empty string to select all available URI handlers.

Since:

BlackBerry 10.0.0

InvokeTarget::Types targetTypes ()

Returns the class of targets used to filter the search results.

Required: YES.

See also:

bb::system::InvokeTarget::Type for the list of individual target types.

Return:

The class of targets used to filter the search results.

Since:

BlackBerry 10.0.0

QUrl uri ()

Returns the uniform resource identifier (URI) sent to the target.

If omitted, the search results are not filtered by URI handler.

Required: NO if a MIME type is provided, YES if no MIME type is specified.

Return:

The uniform resource identifier (URI) sent to the target or an empty URI to select all available URI handlers.

Since:

BlackBerry 10.0.0

Last modified: 2013-12-21

comments powered by Disqus