AnalyticsParams

Since: BlackBerry 10.0.0

#include <bb/pim/calendar/AnalyticsParams>

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

The AnalyticsParams class provides parameters for analytics queries.

This class encapsulates the parameters that are used for analytics functions in the CalendarService class. These analytics functions include CalendarService::lastEvents(), CalendarService::nextEvents(), CalendarService::commonAttendees(), and CalendarService::commonLocations(). The emails in an AnalyticsParams object (which you can retrieve using emails()) represent attendees that participate in the current user's meetings.

See also:

CalendarService


Overview

Public Functions Index

AnalyticsParams ()
AnalyticsParams (const AnalyticsParams &other)
~AnalyticsParams ()
QMap< QString, QVariant >emails () const
boolisValid () const
boolisVisibleOnly () const
intlimit () const
AnalyticsParams &operator= (const AnalyticsParams &other)
voidsetEmails (QMap< QString, QVariant > emails)
voidsetLimit (int limit)
voidsetVisibleOnly (bool visibleOnly)

Public Functions

AnalyticsParams ()

Constructs a new AnalyticsParams.

Since:

BlackBerry 10.0.0

AnalyticsParams (

Copy constructor.

This function constructs an AnalyticsParams containing exactly the same values as the provided AnalyticsParams.

Parameters
other

The AnalyticsParams to be copied.

Since:

BlackBerry 10.0.0

~AnalyticsParams ()

Destructor.

Since:

BlackBerry 10.0.0

QMap< QString, QVariant > emails ()

Retrieves a list of emails that identify attendees that participate in the user's meetings.

This map associates keys with QList objects that should have one email. The key shows up in the maps that are returned by the CalendarService functions that use AnalyticsParams (lastEvents(), nextEvents(), commonAttendees(), and commonLocations()). The email identifies an attendee that participates in the user's meetings.

It's possible to have multiple pairs of keys and emails. The maps returned by the CalendarService functions will associate each key to the result set produced with the corresponding email.

Return:

The map of keys and emails.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this AnalyticsParams is valid.

This function determines whether the attributes of this AnalyticsParams object have acceptable values.

Return:

true if this AnalyticsParams is valid, false otherwise.

Since:

BlackBerry 10.0.0

bool isVisibleOnly ()

Indicates whether this AnalyticsParams should include only entries in calendars that are visible.

In the Calendar application, users can choose which calendars are visible. If this function returns true, then this AnalyticsParams doesn't include entries that correspond to invisible calendars.

You can change the visibility of a calendar by using CalendarFolder::setVisible() and CalendarService::updateFolder().

Return:

true if this AnalyticsParams includes only entries in calendars that are visible, false otherwise.

Since:

BlackBerry 10.0.0

int limit ()

Retrieves the maximum number of results for this AnalyticsParams.

Return:

The maximum number of results.

Since:

BlackBerry 10.0.0

AnalyticsParams & operator= (

Assignment operator.

This operator copies all values from the provided AnalyticsParams into this AnalyticsParams.

Parameters
other

The AnalyticsParams from which to copy all values.

Return:

A reference to this AnalyticsParams.

Since:

BlackBerry 10.0.0

void setEmails (

Sets the map of keys and emails for this AnalyticsParams.

Parameters
emails

The new map of keys and emails.

Since:

BlackBerry 10.0.0

void setLimit (
  • intlimit)

Sets the maximum number of results for this AnalyticsParams.

Parameters
limit

The new maximum number of results.

Since:

BlackBerry 10.0.0

void setVisibleOnly (
  • boolvisibleOnly)

Sets whether this AnalyticsParams should include only entries in calendars that are visible.

Parameters
visibleOnly

If true this AnalyticsParams includes only entries in calendars that are visible, if false this AnalyticsParams includes all entries for both visible and invisible calendars.

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus