AttendeeInEvents

Since: BlackBerry 10.0.0

#include <bb/pim/calendar/AttendeeInEvents>

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

The AttendeeInEvents class represents a participant of an event.

This class includes information about an event participant, such as the attendee type, name, email address, and so on. This class is very similar to the Attendee class, but an AttendeeInEvents object contains information that specifies what events that attendee participates in. You can use functions such as AttendeeInEvents::events() and AttendeeInEvents::addEvent() to retrieve and manipulate the events that this attendee participates in.

You can retrieve a list of an event's participants by calling CalendarService::attendees(). This function returns a list of AttendeeInEvents objects, each of which corresponds to a participant of an event.

See also:

CalendarService


Overview

Public Functions Index

AttendeeInEvents ()
AttendeeInEvents (const AttendeeInEvents &other)
~AttendeeInEvents ()
voidaddEvent (const EventKey &event)
QStringemail () const
QList< EventKey >events () const
boolisValid () const
QStringname () const
AttendeeInEvents &operator= (const AttendeeInEvents &other)
voidresetEvents ()
voidsetEmail (const QString &email)
voidsetEvents (const QList< EventKey > &events)
voidsetName (const QString &name)

Public Functions

AttendeeInEvents ()

Constructs a new AttendeeInEvents.

Since:

BlackBerry 10.0.0

AttendeeInEvents (

Copy constructor.

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

Parameters
other

The AttendeeInEvents to be copied.

Since:

BlackBerry 10.0.0

~AttendeeInEvents ()

Destructor.

Since:

BlackBerry 10.0.0

void addEvent (

Adds an event key to this AttendeeInEvents.

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

Parameters
event

The event key to add.

Since:

BlackBerry 10.0.0

QString email ()

Retrieves the email address of this AttendeeInEvents.

Return:

The email address of this AttendeeInEvents.

Since:

BlackBerry 10.0.0

QList< EventKey > events ()

Retrieves the list of events that this AttendeeInEvents participates in.

This function returns a list of event keys, each of which represents an event that this attendee participates in. An event key contains the primary key for an event in the calendar database.

Return:

The list of events that this AttendeeInEvents participates in.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this AttendeeInEvents is valid.

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

Return:

true if this AttendeeInEvents is valid, false otherwise.

Since:

BlackBerry 10.0.0

QString name ()

Retrieves the name of this AttendeeInEvents.

Return:

The name of this AttendeeInEvents.

Since:

BlackBerry 10.0.0

AttendeeInEvents & operator= (

Assignment operator.

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

Parameters
other

The AttendeeInEvents from which to copy all values.

Return:

A reference to this AttendeeInEvents.

Since:

BlackBerry 10.0.0

void resetEvents ()

Clears the event keys for this AttendeeInEvents.

This function removes all event keys from this AttendeeInEvents object.

Since:

BlackBerry 10.0.0

void setEmail (

Sets the email address of this AttendeeInEvents.

Parameters
email

The new email address.

Since:

BlackBerry 10.0.0

void setEvents (

Sets the list of event keys for this AttendeeInEvents.

This function clears the list of event keys for this AttendeeInEvents 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

void setName (

Sets the name of this AttendeeInEvents.

Parameters
name

The new name.

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