MenuItemInvokeParams

Since: BlackBerry 10.0.0

#include <bb/system/MenuItemInvokeParams>

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

The parameters required to invoke an action related to a MenuItem.


Overview

Public Functions Index

Public Functions

MenuItemInvokeParams ()

Creates a new MenuItemInvokeParams object.

Since:

BlackBerry 10.0.0

MenuItemInvokeParams (

Creates a copy of an existing MenuItemInvokeParams object.

Parameters
other

The source MenuItemInvokeParams object to copy.

Since:

BlackBerry 10.0.0

~MenuItemInvokeParams ()

Destructor.

Since:

BlackBerry 10.0.0

QString action ()

Returns the action to be performed by the target of the invocation request.

Return:

The action to be performed by the target, or an empty string if this instance is not valid (see isValid()).

Since:

BlackBerry 10.0.0

QByteArray data ()

Returns the data that is to be sent to the target upon invocation.

Return:

The data to send to the target, or an empty QByteArray if this instance is not valid (see isValid()).

Since:

BlackBerry 10.0.0

bb::system::FileTransferMode::Type fileTransferMode ()

Returns the file transfer mode that will be applied to the invocation.

The file transfer mode will be applied if the scheme of the URI is "file:///" and the path references a file that is not in the shared area. Note that the third forward slash in file:/// represents the file path.

Return:

the file transfer mode that will be applied to the invocation. See bb::system::FileTransferMode for the list of transfer modes.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates if this object contains valid invocation data.

Return:

true if this object is valid, false otherwise.

Since:

BlackBerry 10.0.0

QVariantMap metadata ()

Returns the metadata associated with the invocation.

Metadata is optional and can be included to pass additional information to the target. It will be encoded as a JSON object and sent to the target.

Return:

The metadata.

Since:

BlackBerry 10.0.0

QString mimeType ()

Returns the MIME type of the data to be acted on.

Return:

The MIME type of the data, or the empty string if this instance is not valid (see isValid()).

Since:

BlackBerry 10.0.0

MenuItemInvokeParams & operator= (

Copies the data from an existing MenuItemInvokeParams object to this object.

Parameters
other

The source MenuItemInvokeParams object to copy.

Return:

The MenuItemInvokeParams instance.

Since:

BlackBerry 10.0.0

bb::system::SecurityPerimeter::Type perimeter ()

Returns the perimeter in which the action will be invoked.

Return:

The perimeter in which the action will be invoked. See bb::system::SecurityPerimeter::Type for the list of perimeters.

Since:

BlackBerry 10.0.0

QString target ()

Returns the identity of the target (as stated in its BAR manifest).

Use this value with bb::system::InvokeRequest::setTarget().

Return:

The identity of the target, or an empty string if this instance is not valid (see isValid()).

Since:

BlackBerry 10.0.0

InvokeTarget::Type type ()

Returns the type of the target.

Return:

The kind of process represented by the target. The value returned is valid only if the instance is valid (see isValid()). See bb::system::InvokeTarget::Type for the list of possible targets.

Since:

BlackBerry 10.0.0

QUrl uri ()

Returns the URI that references the data to be passed into the invocation request.

If the URI is not present, then it is assumed that any required data is passed in-band in the invocation request.

Return:

The URI of the invocation data, or a default (invalid) QUrl if this instance is not valid (see isValid()).

Since:

BlackBerry 10.0.0

QUrl uriMatch ()

Returns the URI pattern of the target's filter that matched the URI in the query.

The URI pattern can be used when additional information about the invocation target is needed.

Return:

The URI pattern that matched, or a default (invalid) QUrl if this instance is not valid (see isValid()).

Since:

BlackBerry 10.2.0

Last modified: 2014-09-30



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

comments powered by Disqus