InvokeAction

Since: BlackBerry 10.0.0

#include <bb/system/InvokeAction>

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

An operation that a remote target can perform.


Overview

Public Types Index

enum Type

All = 0, Menu = 1

Public Functions Index

InvokeAction ()
InvokeAction (const InvokeAction &other)
~InvokeAction ()
QStringdefaultTarget () const
QUrlicon () const
QStringlabel () const
QStringname () const
InvokeAction &operator= (const InvokeAction &other)
QList< InvokeTarget >targets () const

Public Types

Type

The kinds of actions that can be queried.

Since:

BlackBerry 10.0.0

All = 0

All possible actions.

Some actions may not have an icon and label.

Since:

BlackBerry 10.0.0

Menu = 1

Actions with an icon and label that are suitable for display in a menu.

Since:

BlackBerry 10.0.0

Public Functions

InvokeAction ()

Creates a new InvokeAction object.

Since:

BlackBerry 10.0.0

InvokeAction (

Creates a copy of an existing InvokeAction object.

Parameters
other

The source InvokeAction object to copy.

Since:

BlackBerry 10.0.0

~InvokeAction ()

Destructor.

Since:

BlackBerry 10.0.0

QString defaultTarget ()

Returns the identity of the target (as stated in its BAR manifest) that handles this action for an unbounded invocation.

If omitted, this action has no default handler.

Return:

The identity of the target that handles this action for an unbounded invocation or an empty string if no default exists.

Since:

BlackBerry 10.0.0

QUrl icon ()

Returns a path to a localized icon file that represents the action.

Return:

A path to a localized icon file that represents the action.

Since:

BlackBerry 10.0.0

QString label ()

Returns the localized name of the action.

Return:

The localized name of the action.

Since:

BlackBerry 10.0.0

QString name ()

Returns the operation the client can ask the target to perform.

Use this value with InvokeRequest::setAction().

Return:

The operation the client can ask the target to perform.

Since:

BlackBerry 10.0.0

InvokeAction & operator= (

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

Parameters
other

The source InvokeAction object to copy.

Return:

The InvokeAction instance.

Since:

BlackBerry 10.0.0

QList< InvokeTarget > targets ()

Returns the list of targets that support this action.

Return:

The list of targets that support this action.

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus