InvokeUpdateTargetFiltersRequest

Since: BlackBerry 10.0.0

#include <bb/system/InvokeUpdateTargetFiltersRequest>

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

Encapsulates a request to update a target's list of filters.

Targets declare filters to describe the kinds of unbound invocations they support. A target may specify a list of filters. Through unbound invocation (or query) a target will only receive invocations that match one of its filters. However, it may also receive bound invocations that do not match any of its filters. A filter describes the action/MIME type/URI combinations for which the target supports unbound invocation.

Invoke targets can specify filters by declaring them in their BAR manifest. In addition, a client that has ownership of a target can update the list of filters by creating the desired filters using InvokeTargetFilter, creating a request to update a target's filters (InvokeUpdateTargetFiltersRequest) and sending the request with InvokeManager::updateTargetFilters().


Overview

Public Functions Index

InvokeUpdateTargetFiltersRequest ()
InvokeUpdateTargetFiltersRequest (const InvokeUpdateTargetFiltersRequest &other)
~InvokeUpdateTargetFiltersRequest ()
QList< InvokeTargetFilter >filters () const
InvokeUpdateTargetFiltersRequest &operator= (const InvokeUpdateTargetFiltersRequest &other)
voidsetTarget (const QString &target)
boolsetTargetFilters (QList< InvokeTargetFilter > filters)
QStringtarget () const

Public Functions

InvokeUpdateTargetFiltersRequest ()

Creates a new InvokeUpdateTargetFiltersRequest object.

Since:

BlackBerry 10.0.0

InvokeUpdateTargetFiltersRequest (

Creates a copy of an existing InvokeUpdateTargetFiltersRequest object.

Parameters
other

The source InvokeUpdateTargetFiltersRequest object to copy.

Since:

BlackBerry 10.0.0

~InvokeUpdateTargetFiltersRequest ()

Destructor.

Since:

BlackBerry 10.0.0

QList< InvokeTargetFilter > filters ()

Returns the updated list of filters for the target.

Return:

The updated list of filters for the target.

Since:

BlackBerry 10.0.0

InvokeUpdateTargetFiltersRequest & operator= (

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

Parameters
other

The source InvokeUpdateTargetFiltersRequest object to copy.

Return:

The InvokeUpdateTargetFiltersRequest instance.

Since:

BlackBerry 10.0.0

void setTarget (

Sets the target that will be updated with the new list of target filters.

The client must own the target to update the target's list of filters.

Parameters
target

The target to be updated with the new list of target filters.

Since:

BlackBerry 10.0.0

bool setTargetFilters (

Sets the updated list of filters for the target.

If any filter in the list is invalid, false is returned, but the operation succeeds. See InvokeTargetFilter::isValid() for details on valid target filters. If filters is an empty list, the list of filters will be set and true will be returned.

Parameters
filters

The updated list of filters for the target.

Return:

Return true if the filter list is valid, false otherwise.

Since:

BlackBerry 10.0.0

QString target ()

Returns the target for which the list of filters is to be updated.

Return:

The target for which the list of filters will be updated.

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