AnalyticsParams
#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.
BlackBerry 10.0.0
Public Functions Index
| AnalyticsParams () | |
| ~AnalyticsParams () | |
| AnalyticsParams (const AnalyticsParams &other) | |
| AnalyticsParams & | operator= (const AnalyticsParams &other) |
| bool | isVisibleOnly () const |
| int | limit () const |
| QMap< QString, QVariant > | emails () const |
| void | setVisibleOnly (bool visibleOnly) |
| void | setLimit (int limit) |
| void | setEmails (QMap< QString, QVariant > emails) |
| bool | isValid () const |
Public Functions
Destructor.
BlackBerry 10.0.0
Copy constructor.
This function constructs an AnalyticsParams containing exactly the same values as the provided AnalyticsParams.
| Parameters | |
|---|---|
| other |
The AnalyticsParams to be copied. |
BlackBerry 10.0.0
AnalyticsParams &
Assignment operator.
This operator copies all values from the provided AnalyticsParams into this AnalyticsParams.
| Parameters | |
|---|---|
| other |
The AnalyticsParams from which to copy all values. |
A reference to this AnalyticsParams.
BlackBerry 10.0.0
bool
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().
true if this AnalyticsParams includes only entries in calendars that are visible, false otherwise.
BlackBerry 10.0.0
int
Retrieves the maximum number of results for this AnalyticsParams.
The maximum number of results.
BlackBerry 10.0.0
QMap< QString, QVariant >
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.
The map of keys and emails.
BlackBerry 10.0.0
void
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. |
BlackBerry 10.0.0
void
Sets the maximum number of results for this AnalyticsParams.
| Parameters | |
|---|---|
| limit |
The new maximum number of results. |
BlackBerry 10.0.0
void
Sets the map of keys and emails for this AnalyticsParams.
| Parameters | |
|---|---|
| emails |
The new map of keys and emails. |
BlackBerry 10.0.0
bool
Indicates whether this AnalyticsParams is valid.
This function determines whether the attributes of this AnalyticsParams object have acceptable values.
true if this AnalyticsParams is valid, false otherwise.
BlackBerry 10.0.0