Attendee

Since: BlackBerry 10.0.0

#include <bb/pim/calendar/Attendee>

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

The Attendee class represents a participant of a meeting.

This class includes information about a meeting participant, such as the attendee type, name, email address, and so on. This class also includes information such as whether the attendee is the owner of the meeting, whether the attendee has accepted or declined the meeting invitation, and other meeting-related information.

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

See also:

CalendarEvent


Overview

Public Types Index

enum Type

Invalid = 0, Host = 1, Participant = 2

Public Functions Index

Attendee ()
Attendee (const Attendee &other)
~Attendee ()
ContactIdcontactId () const
QStringemail () const
EventIdeventId () const
AttendeeIdid () const
boolisOwner () const
boolisValid () const
QStringname () const
Attendee &operator= (const Attendee &other)
AttendeeRole::Typerole () const
boolrsvp () const
voidsetContactId (ContactId contactId)
voidsetEmail (const QString &email)
voidsetEventId (EventId eventId)
voidsetId (AttendeeId id)
voidsetName (const QString &name)
voidsetOwner (bool owner)
voidsetRole (AttendeeRole::Type role)
voidsetRsvp (bool rsvp)
voidsetStatus (AttendeeStatus::Type status)
voidsetType (Attendee::Type type)
AttendeeStatus::Typestatus () const
Attendee::Typetype () const

Public Types

Type

An enumeration of supported attendee types.

Since:

BlackBerry 10.0.0

Invalid = 0

Indicates an invalid attendee type.

Host = 1

Indicates that the attendee is hosting the meeting.

Since:

BlackBerry 10.0.0

Participant = 2

Indicates that the attendee is a participant in the meeting.

Since:

BlackBerry 10.0.0

Public Functions

Attendee ()

Constructs a new Attendee.

Since:

BlackBerry 10.0.0

Attendee (

Copy constructor.

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

Parameters
other

The Attendee to be copied.

Since:

BlackBerry 10.0.0

~Attendee ()

Destructor.

Since:

BlackBerry 10.0.0

ContactId contactId ()

Retrieves the contact ID of this Attendee.

The contact ID identifies the contact that this Attendee object represents. An Attendee object can exist without a corresponding contact.

Return:

The contact ID of this Attendee.

Since:

BlackBerry 10.0.0

QString email ()

Retrieves the email address of this Attendee.

Return:

The email address of this Attendee.

Since:

BlackBerry 10.0.0

EventId eventId ()

Retrieves the event ID of this Attendee.

The event ID identifies the event in which this attendee participates.

Return:

The event ID of this Attendee.

Since:

BlackBerry 10.0.0

AttendeeId id ()

Retrieves the ID of this Attendee.

The ID uniquely identifies an Attendee.

Return:

The ID of this Attendee.

Since:

BlackBerry 10.0.0

bool isOwner ()

Indicates whether this Attendee represents the current user.

Return:

true if this Attendee represents the current user, false otherwise.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this Attendee is valid.

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

Return:

true if this Attendee is valid, false otherwise.

Since:

BlackBerry 10.0.0

QString name ()

Retrieves the name of this Attendee.

Return:

The name of this Attendee.

Since:

BlackBerry 10.0.0

Attendee & operator= (

Assignment operator.

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

Parameters
other

The Attendee from which to copy all values.

Return:

A reference to this Attendee.

Since:

BlackBerry 10.0.0

AttendeeRole::Type role ()

Retrieves the role of this Attendee.

This function returns the participation role of this attendee. An attendee can be:
Return:

The role of this Attendee.

See also:

AttendeeRole

Since:

BlackBerry 10.0.0

bool rsvp ()

RSVP flag for attendees in an iCalendar attachment.

Return:

true if the meeting organizer requires a response from this Attendee.

Since:

BlackBerry 10.2.0

void setContactId (
  • ContactIdcontactId)

Sets the contact ID of this Attendee.

Parameters
contactId

The new contact ID.

Since:

BlackBerry 10.0.0

void setEmail (

Sets the email address of this Attendee.

Parameters
email

The new email address.

Since:

BlackBerry 10.0.0

void setEventId (
  • EventIdeventId)

Sets the event ID of this Attendee.

Parameters
eventId

The new event ID.

Since:

BlackBerry 10.0.0

void setId (
  • AttendeeIdid)

Sets the ID of this Attendee.

Parameters
id

The new ID.

Since:

BlackBerry 10.0.0

void setName (

Sets the name of this Attendee.

Parameters
name

The new name.

Since:

BlackBerry 10.0.0

void setOwner (
  • boolowner)

Sets whether this Attendee represents the current user.

Parameters
owner

If true this Attendee represents the current user, if false this Attendee does not represent the current user.

Since:

BlackBerry 10.0.0

void setRole (

Sets the role of this Attendee.

Parameters
role

The new role.

Since:

BlackBerry 10.0.0

void setRsvp (
  • boolrsvp)

Sets the RSVP flag on this Attendee.

Parameters
rsvp

The new flag value.

Since:

BlackBerry 10.2.0

void setStatus (

Sets the acceptance status of this Attendee.

Parameters
status

The new acceptance status.

Since:

BlackBerry 10.0.0

void setType (

Sets the type of this Attendee.

Parameters
type

The new type.

Since:

BlackBerry 10.0.0

AttendeeStatus::Type status ()

Retrieves the acceptance status of this Attendee.

This function indicates the attendance status of the attendee, such as whether the attendee:
Return:

The acceptance status of this Attendee.

Since:

BlackBerry 10.0.0

Attendee::Type type ()

Retrieves the type of this Attendee.

An attendee can either be the host of a meeting (indicated by Attendee::Host) or a participant of a meeting (indicated by Attendee::Participant).

Return:

The type of this Attendee.

Since:

BlackBerry 10.0.0

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus