KCalCore Library
#include <attendee.h>

Public Types | |
enum | CuType { Individual , Group , Resource , Room , Unknown } |
typedef QVector< Ptr > | List |
enum | PartStat { NeedsAction , Accepted , Declined , Tentative , Delegated , Completed , InProcess , None } |
typedef QSharedPointer< Attendee > | Ptr |
enum | Role { ReqParticipant , OptParticipant , NonParticipant , Chair } |
Detailed Description
Represents information related to an attendee of an Calendar Incidence, typically a meeting or task (to-do).
Attendees are people with a name and (optional) email address who are invited to participate in some way in a meeting or task. This class also tracks that status of the invitation: accepted; tentatively accepted; declined; delegated to another person; in-progress; completed.
Attendees may optionally be asked to RSVP ("Respond Please") to the invitation.
Note that each attendee be can optionally associated with a UID (unique identifier) derived from a Calendar Incidence, Email Message, or any other thing you want.
Definition at line 57 of file attendee.h.
Member Typedef Documentation
◆ List
List of attendees.
Definition at line 118 of file attendee.h.
◆ Ptr
A shared pointer to an Attendee object.
Definition at line 113 of file attendee.h.
Member Enumeration Documentation
◆ CuType
The different types of a participant.
- Since
- 4.14
Definition at line 97 of file attendee.h.
◆ PartStat
The different types of participant status.
The meaning is specific to the incidence type in context.
Enumerator | |
---|---|
NeedsAction | Event, to-do or journal needs action (default) |
Accepted | Event, to-do or journal accepted. |
Declined | Event, to-do or journal declined. |
Tentative | Event or to-do tentatively accepted. |
Delegated | Event or to-do delegated. |
Completed | To-do completed. |
InProcess | To-do in process of being completed. |
Definition at line 70 of file attendee.h.
◆ Role
The different types of participation roles.
Enumerator | |
---|---|
ReqParticipant | Participation is required (default) |
OptParticipant | Participation is optional. |
NonParticipant | Non-Participant; copied for information purposes. |
Chair | Chairperson. |
Definition at line 84 of file attendee.h.
Constructor & Destructor Documentation
◆ Attendee() [1/2]
Attendee::Attendee | ( | const QString & | name, |
const QString & | email, | ||
bool | rsvp = false, | ||
Attendee::PartStat | status = None, | ||
Attendee::Role | role = ReqParticipant, | ||
const QString & | uid = QString() ) |
Constructs an attendee consisting of a Person name (name
) and email address (email
); invitation status and Role; an optional RSVP flag and UID.
- Parameters
-
name is person name of the attendee. email is person email address of the attendee. rsvp if true, the attendee is requested to reply to invitations. status is the PartStat status of the attendee. role is the Role of the attendee. uid is the UID of the attendee.
Definition at line 119 of file attendee.cpp.
◆ Attendee() [2/2]
Constructs an attendee by copying another attendee.
- Parameters
-
attendee is the attendee to be copied.
Definition at line 132 of file attendee.cpp.
◆ ~Attendee()
Attendee::~Attendee | ( | ) |
Destroys the attendee.
Definition at line 138 of file attendee.cpp.
Member Function Documentation
◆ customProperties() [1/2]
CustomProperties & Attendee::customProperties | ( | ) |
Returns a reference to the CustomProperties object.
Definition at line 259 of file attendee.cpp.
◆ customProperties() [2/2]
const CustomProperties & Attendee::customProperties | ( | ) | const |
Returns a const reference to the CustomProperties object.
Definition at line 264 of file attendee.cpp.
◆ cuType()
Attendee::CuType Attendee::cuType | ( | ) | const |
Returns the CuType of the attendee.
- See also
- setCuType()
- Since
- 4.14
Definition at line 204 of file attendee.cpp.
◆ cuTypeStr()
QString Attendee::cuTypeStr | ( | ) | const |
Returns the CuType of the attendee.
- See also
- setCuType()
- Since
- 4.14
Definition at line 209 of file attendee.cpp.
◆ delegate()
QString Attendee::delegate | ( | ) | const |
◆ delegator()
QString Attendee::delegator | ( | ) | const |
◆ email()
QString Person::email | ( | ) | const |
Returns the email address for this person.
- Returns
- A QString containing the person's email address.
- See also
- setEmail()
Definition at line 138 of file person.cpp.
◆ fullName()
QString Person::fullName | ( | ) | const |
Returns the full name of this person.
- Returns
- A QString containing the person's full name in the form "FirstName LastName \<mail@domain\>".
Definition at line 106 of file person.cpp.
◆ name()
QString Person::name | ( | ) | const |
◆ operator!=()
Compares this with attendee
for inequality.
- Parameters
-
attendee the attendee to compare.
Definition at line 156 of file attendee.cpp.
◆ operator=()
Sets this attendee equal to attendee
.
- Parameters
-
attendee is the attendee to copy.
Definition at line 161 of file attendee.cpp.
◆ operator==()
Compares this with attendee
for equality.
- Parameters
-
attendee the attendee to compare.
Definition at line 143 of file attendee.cpp.
◆ role()
Attendee::Role Attendee::role | ( | ) | const |
◆ RSVP()
bool Attendee::RSVP | ( | ) | const |
◆ setCustomProperty()
void Attendee::setCustomProperty | ( | const QByteArray & | xname, |
const QString & | xvalue ) |
Adds a custom property.
If the property already exists it will be overwritten.
- Parameters
-
xname is the name of the property. xvalue is its value.
Definition at line 254 of file attendee.cpp.
◆ setCuType() [1/2]
Sets the CuType of the attendee to cuType
.
- Parameters
-
cuType is the CuType to use for the attendee.
- See also
- cuType()
- Since
- 4.14
Definition at line 199 of file attendee.cpp.
◆ setCuType() [2/2]
void Attendee::setCuType | ( | Attendee::CuType | cuType | ) |
Sets the CuType of the attendee to cuType
.
- Parameters
-
cuType is the CuType to use for the attendee.
- See also
- cuType()
- Since
- 4.14
Definition at line 194 of file attendee.cpp.
◆ setDelegate()
Sets the delegate.
- Parameters
-
delegate is a string containing a MAILTO URI of those delegated to attend the meeting.
- See also
- delegate(), setDelegator().
Definition at line 234 of file attendee.cpp.
◆ setDelegator()
Sets the delegator.
- Parameters
-
delegator is a string containing a MAILTO URI of those who have delegated their meeting attendance.
- See also
- delegator(), setDelegate().
Definition at line 244 of file attendee.cpp.
◆ setEmail()
Sets the email address for this person to email
.
- Parameters
-
email is the email address for this person.
- See also
- email()
Definition at line 131 of file person.cpp.
◆ setName()
Sets the name of the person to name
.
- Parameters
-
name is the name of this person.
- See also
- name()
Definition at line 115 of file person.cpp.
◆ setRole()
void Attendee::setRole | ( | Attendee::Role | role | ) |
Sets the Role of the attendee to role
.
- Parameters
-
role is the Role to use for the attendee.
- See also
- role()
Definition at line 214 of file attendee.cpp.
◆ setRSVP()
void Attendee::setRSVP | ( | bool | rsvp | ) |
Sets the RSVP flag of the attendee to rsvp
.
- Parameters
-
rsvp if set (true), the attendee is requested to reply to invitations.
- See also
- RSVP()
Definition at line 174 of file attendee.cpp.
◆ setStatus()
void Attendee::setStatus | ( | Attendee::PartStat | status | ) |
Sets the PartStat of the attendee to status
.
- Parameters
-
status is the PartStat to use for the attendee.
- See also
- status()
Definition at line 184 of file attendee.cpp.
◆ setUid()
Sets the UID of the attendee to uid
.
- Parameters
-
uid is the UID to use for the attendee.
- See also
- uid()
Definition at line 224 of file attendee.cpp.
◆ status()
Attendee::PartStat Attendee::status | ( | ) | const |
Returns the PartStat of the attendee.
- See also
- setStatus()
Definition at line 189 of file attendee.cpp.
◆ uid()
QString Attendee::uid | ( | ) | const |
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.