CommonLocation

Since: BlackBerry 10.0.0

#include <bb/pim/calendar/CommonLocation>

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

The CommonLocation class represents a meeting location that is common between the user and a specified person.

You can use the CalendarService::commonLocations() function to retrieve a list of meeting locations where both the user and a person that you specify were present. You use the emails attribute of an AnalyticsParams object to identify the person that should have participate in meetings along with the user at a location.

The commonLocations() function returns a list of CommonLocation objects. Each CommonLocation object includes information such as the location itself and statistics about the common location.

See also:

CalendarService


Overview

Public Functions Index

CommonLocation ()
CommonLocation (const CommonLocation &other)
~CommonLocation ()
boolisValid () const
QStringlocation () const
CommonLocation &operator= (const CommonLocation &other)
voidsetLocation (const QString &location)
voidsetStats (const AnalyticsStats &stats)
AnalyticsStatsstats () const

Public Functions

CommonLocation ()

Constructs a new CommonLocation.

Since:

BlackBerry 10.0.0

CommonLocation (

Copy constructor.

This function constructs a CommonLocation containing exactly the same values as the provided CommonLocation.

Parameters
other

The CommonLocation to be copied.

Since:

BlackBerry 10.0.0

~CommonLocation ()

Destructor.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this CommonLocation is valid.

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

Return:

true if this CommonLocation is valid, false otherwise.

Since:

BlackBerry 10.0.0

QString location ()

Retrieves the location of this CommonLocation.

This function returns the place where the user and the person identified in the CalendarService::commonLocations() call met.

Return:

The location of this CommonLocation.

Since:

BlackBerry 10.0.0

CommonLocation & operator= (

Assignment operator.

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

Parameters
other

The CommonLocation from which to copy all values.

Return:

A reference to this CommonLocation.

Since:

BlackBerry 10.0.0

void setLocation (

Sets the location for this CommonLocation.

Parameters
location

The new location.

Since:

BlackBerry 10.0.0

void setStats (

Sets the statistics for this CommonLocation.

Parameters
stats

The statistics to set.

Since:

BlackBerry 10.0.0

AnalyticsStats stats ()

Retrieves statistics for this CommonLocation.

This function returns an AnalyticsStats object that contains information such as the total number of meetings between the user and the attendee provided to CalendarService::commonLocations() and the date of their last meeting.

Return:

Statistics for this CommonLocation.

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus