AttendeeSearchParameters

Since: BlackBerry 10.0.0

#include <bb/pim/calendar/AttendeeSearchParameters>

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

The AttendeeSearchParameters class represents parameters for attendee search.

This class encapsulates the arguments that are required when you call CalendarService::attendees(). This function retrieves a list of people who are participating in the specified set of meetings.

You can use an AttendeeSearchParameters to store a set of meetings that you want to use in an attendee search. For example, if you wanted to retrieve the list of attendees for all meetings that occur on a particular date, you can add the meetings to an AttendeeSearchParameters object and then provide this object as an argument when you call CalendarService::attendees().

See also:

CalendarService


Overview

Public Functions Index

AttendeeSearchParameters ()
AttendeeSearchParameters (const AttendeeSearchParameters &other)
~AttendeeSearchParameters ()
voidaddEvent (const EventKey &event)
QList< EventKey >events () const
boolisValid () const
AttendeeSearchParameters &operator= (const AttendeeSearchParameters &other)
voidresetEvents ()
voidsetEvents (const QList< EventKey > &events)

Public Functions

AttendeeSearchParameters ()

Constructs a new AttendeeSearchParameters.

Since:

BlackBerry 10.0.0

AttendeeSearchParameters (

Copy constructor.

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

Parameters
other

The AttendeeSearchParameters to be copied.

Since:

BlackBerry 10.0.0

~AttendeeSearchParameters ()

Destructor.

Since:

BlackBerry 10.0.0

void addEvent (

Adds an event key to this AttendeeSearchParameters.

This function appends a new event key to the list of event keys for this AttendeeSearchParameters object.

Parameters
event

The event key to add.

Since:

BlackBerry 10.0.0

QList< EventKey > events ()

Retrieves the list of events keys for this AttendeeSearchParameters.

An event key is a unique identifier for an event in the calendar database. This function returns a list of event keys, and the corresponding events are searched when you call CalendarService::attendees() with this AttendeeSearchParameters object.

Return:

The list of events for this AttendeeSearchParameters.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this AttendeeSearchParameters is valid.

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

Return:

true if this AttendeeSearchParameters is valid, false otherwise.

Since:

BlackBerry 10.0.0

AttendeeSearchParameters & operator= (

Assignment operator.

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

Parameters
other

The AttendeeSearchParameters from which to copy all values.

Return:

A reference to this AttendeeSearchParameters.

Since:

BlackBerry 10.0.0

void resetEvents ()

Clears the event keys for this AttendeeSearchParameters.

This function removes all event keys from this AttendeeSearchParameters object.

Since:

BlackBerry 10.0.0

void setEvents (

Sets the list of event keys for this AttendeeSearchParameters.

This function clears the list of event keys for this AttendeeSearchParameters object and then populates it with EventKey objects from the provided list.

Parameters
events

The new list of event keys.

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