CommonAttendee

Since: BlackBerry 10.0.0

#include <bb/pim/calendar/CommonAttendee>

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

The CommonAttendee class represents an attendee that is common between the user and a specified person.

You can use the CalendarService::commonAttendees() function to retrieve a list of people that have attended meetings with both the user and a person that you specify. You use the emails attribute of an AnalyticsParams object to identify the person that should have participated in meetings along with the user.

The commonAttendees() function returns a list of CommonAttendee objects. Each CommonAttendee object includes information such as the actual attendee data (represented by an Attendee object) and statistics for the common attendee.


Overview

Public Functions Index

CommonAttendee ()
CommonAttendee (const CommonAttendee &other)
~CommonAttendee ()
Attendeeattendee () const
boolisValid () const
CommonAttendee &operator= (const CommonAttendee &other)
voidsetAttendee (const Attendee &attendee)
voidsetStats (const AnalyticsStats &stats)
AnalyticsStatsstats () const

Public Functions

CommonAttendee ()

Constructs a new CommonAttendee.

Since:

BlackBerry 10.0.0

CommonAttendee (

Copy constructor.

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

Parameters
other

The CommonAttendee to be copied.

Since:

BlackBerry 10.0.0

~CommonAttendee ()

Destructor.

Since:

BlackBerry 10.0.0

Attendee attendee ()

Retrieves the Attendee object that's associated with this CommonAttendee.

This function returns an Attendee object that contains the actual attendee data.

Return:

The Attendee object that's associated with this CommonAttendee.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this CommonAttendee is valid.

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

Return:

true if this CommonAttendee is valid, false otherwise.

Since:

BlackBerry 10.0.0

CommonAttendee & operator= (

Assignment operator.

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

Parameters
other

The CommonAttendee from which to copy all values.

Return:

A reference to this CommonAttendee.

Since:

BlackBerry 10.0.0

void setAttendee (

Sets the Attendee object that's associated with this CommonAttendee.

Parameters
attendee

The Attendee object to associate.

Since:

BlackBerry 10.0.0

void setStats (

Sets the statistics for this CommonAttendee.

Parameters
stats

The statistics to set.

Since:

BlackBerry 10.0.0

AnalyticsStats stats ()

Retrieves statistics for this CommonAttendee.

This function returns an AnalyticsStats object that contains information such as the number of meetings with the user and date of the most recent meeting.

Return:

Statistics for this CommonAttendee.

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus