Contents

KCalendarCore::Attendee Class

class KCalendarCore::Attendee

Represents information related to an attendee of an Calendar Incidence, typically a meeting or task (to-do). More...

Header: #include <KCalendarCore/Attendee>
CMake: find_package(KF6 REQUIRED COMPONENTS CalendarCore)
target_link_libraries(mytarget PRIVATE KF6::CalendarCore)
In QML: attendee

Public Types

(since 4.14) enum CuType { Individual, Group, Resource, Room, Unknown }
List
enum PartStat { NeedsAction, Accepted, Declined, Tentative, Delegated, …, None }
enum Role { ReqParticipant, OptParticipant, NonParticipant, Chair }

Properties

Public Functions

Attendee()
Attendee(const QString &name, const QString &email, bool rsvp = false, KCalendarCore::Attendee::PartStat status = None, KCalendarCore::Attendee::Role role = ReqParticipant, const QString &uid = QString())
Attendee(const KCalendarCore::Attendee &attendee)
~Attendee()
bool RSVP() const
(since 4.14) KCalendarCore::Attendee::CuType cuType() const
(since 4.14) QString cuTypeStr() const
KCalendarCore::CustomProperties &customProperties()
const KCalendarCore::CustomProperties &customProperties() const
QString delegate() const
QString delegator() const
QString email() const
QString fullName() const
bool isNull() const
QString name() const
KCalendarCore::Attendee::Role role() const
(since 4.14) void setCuType(KCalendarCore::Attendee::CuType cuType)
(since 4.14) void setCuType(const QString &cuType)
void setCustomProperty(const QByteArray &xname, const QString &xvalue)
void setDelegate(const QString &delegate)
void setDelegator(const QString &delegator)
void setEmail(const QString &email)
void setName(const QString &name)
void setRSVP(bool rsvp)
void setRole(KCalendarCore::Attendee::Role role)
void setStatus(KCalendarCore::Attendee::PartStat status)
void setUid(const QString &uid)
KCalendarCore::Attendee::PartStat status() const
QString uid() const
bool operator!=(const KCalendarCore::Attendee &attendee) const
KCalendarCore::Attendee &operator=(const KCalendarCore::Attendee &attendee)
bool operator==(const KCalendarCore::Attendee &attendee) const

Detailed Description

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.

Member Type Documentation

[since 4.14] enum Attendee::CuType

The different types of a participant.

ConstantValueDescription
KCalendarCore::Attendee::Individual0An individual (default).
KCalendarCore::Attendee::Group1A group of individuals.
KCalendarCore::Attendee::Resource2A physical resource.
KCalendarCore::Attendee::Room3A room resource.
KCalendarCore::Attendee::Unknown4Otherwise not known.

This enum was introduced in 4.14.

Attendee::List

List of attendees.

enum Attendee::PartStat

The different types of participant status. The meaning is specific to the incidence type in context.

ConstantValueDescription
KCalendarCore::Attendee::NeedsAction0Event, to-do or journal needs action (default).
KCalendarCore::Attendee::Accepted1Event, to-do or journal accepted.
KCalendarCore::Attendee::Declined2Event, to-do or journal declined.
KCalendarCore::Attendee::Tentative3Event or to-do tentatively accepted.
KCalendarCore::Attendee::Delegated4Event or to-do delegated.
KCalendarCore::Attendee::Completed5To-do completed.
KCalendarCore::Attendee::InProcess6To-do in process of being completed.
KCalendarCore::Attendee::None7 

enum Attendee::Role

The different types of participation roles.

ConstantValueDescription
KCalendarCore::Attendee::ReqParticipant0Participation is required (default).
KCalendarCore::Attendee::OptParticipant1Participation is optional.
KCalendarCore::Attendee::NonParticipant2Non-Participant; copied for information purposes.
KCalendarCore::Attendee::Chair3Chairperson.

Property Documentation

cuType : CuType

Access functions:

KCalendarCore::Attendee::CuType cuType() const
void setCuType(KCalendarCore::Attendee::CuType cuType)
void setCuType(const QString &cuType)

delegate : QString

Access functions:

QString delegate() const
void setDelegate(const QString &delegate)

delegator : QString

Access functions:

QString delegator() const
void setDelegator(const QString &delegator)

email : QString

Access functions:

QString email() const
void setEmail(const QString &email)

[read-only] fullName : const QString

Access functions:

QString fullName() const

[read-only] isNull : const bool

Access functions:

bool isNull() const

name : QString

Access functions:

QString name() const
void setName(const QString &name)

role : Role

Access functions:

KCalendarCore::Attendee::Role role() const
void setRole(KCalendarCore::Attendee::Role role)

rsvp : bool

Access functions:

bool RSVP() const
void setRSVP(bool rsvp)

status : PartStat

Access functions:

KCalendarCore::Attendee::PartStat status() const
void setStatus(KCalendarCore::Attendee::PartStat status)

uid : QString

Access functions:

QString uid() const
void setUid(const QString &uid)

Member Function Documentation

Attendee::Attendee()

Create a null Attendee.

Attendee::Attendee(const QString &name, const QString &email, bool rsvp = false, KCalendarCore::Attendee::PartStat status = None, KCalendarCore::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.

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.

Attendee::Attendee(const KCalendarCore::Attendee &attendee)

Constructs an attendee by copying another attendee.

attendee is the attendee to be copied.

[noexcept] Attendee::~Attendee()

Destroys the attendee.

bool Attendee::RSVP() const

Returns the attendee RSVP flag.

Note: Getter function for property rsvp.

See also setRSVP().

[since 4.14] KCalendarCore::Attendee::CuType Attendee::cuType() const

Returns the CuType of the attendee.

Note: Getter function for property cuType.

This function was introduced in 4.14.

See also setCuType().

[since 4.14] QString Attendee::cuTypeStr() const

Returns the CuType of the attendee.

This function was introduced in 4.14.

See also setCuType().

KCalendarCore::CustomProperties &Attendee::customProperties()

Returns a reference to the CustomProperties object

const KCalendarCore::CustomProperties &Attendee::customProperties() const

Returns a const reference to the CustomProperties object

QString Attendee::delegate() const

Returns the delegate.

Note: Getter function for property delegate.

See also setDelegate().

QString Attendee::delegator() const

Returns the delegator.

Note: Getter function for property delegator.

See also setDelegator().

QString Attendee::email() const

Returns the email address for this attendee.

Note: Getter function for property email.

See also setEmail().

QString Attendee::fullName() const

Returns the full name and email address of this attendee Returns A QString containing the person's full name in the form "FirstName LastName <mail@domain>".

Note: Getter function for property fullName.

bool Attendee::isNull() const

Returns true if this is a default-constructed Attendee instance.

Note: Getter function for property isNull.

QString Attendee::name() const

Returns the name of the attendee.

Note: Getter function for property name.

See also setName().

KCalendarCore::Attendee::Role Attendee::role() const

Returns the Role of the attendee.

Note: Getter function for property role.

See also setRole().

[since 4.14] void Attendee::setCuType(KCalendarCore::Attendee::CuType cuType)

Sets the CuType of the attendee to cuType.

cuType is the CuType to use for the attendee.

Note: Setter function for property cuType.

This function was introduced in 4.14.

See also cuType().

[since 4.14] void Attendee::setCuType(const QString &cuType)

Sets the CuType of the attendee to cuType.

cuType is the CuType to use for the attendee.

Note: Setter function for property cuType.

This function was introduced in 4.14.

See also cuType().

void Attendee::setCustomProperty(const QByteArray &xname, const QString &xvalue)

Adds a custom property. If the property already exists it will be overwritten.

xname is the name of the property.

xvalue is its value.

void Attendee::setDelegate(const QString &delegate)

Sets the delegate.

delegate is a string containing a MAILTO URI of those delegated to attend the meeting.

Note: Setter function for property delegate.

See also delegate() and setDelegator().

void Attendee::setDelegator(const QString &delegator)

Sets the delegator.

delegator is a string containing a MAILTO URI of those who have delegated their meeting attendance.

Note: Setter function for property delegator.

See also delegator() and setDelegate().

void Attendee::setEmail(const QString &email)

Sets the email address for this attendee to email.

Note: Setter function for property email.

See also email().

void Attendee::setName(const QString &name)

Sets the name of the attendee to name.

Note: Setter function for property name.

See also name().

void Attendee::setRSVP(bool rsvp)

Sets the RSVP flag of the attendee to rsvp.

rsvp if set (true), the attendee is requested to reply to invitations.

Note: Setter function for property rsvp.

See also RSVP().

void Attendee::setRole(KCalendarCore::Attendee::Role role)

Sets the Role of the attendee to role.

role is the Role to use for the attendee.

Note: Setter function for property role.

See also role().

void Attendee::setStatus(KCalendarCore::Attendee::PartStat status)

Sets the PartStat of the attendee to status.

status is the PartStat to use for the attendee.

Note: Setter function for property status.

See also status().

void Attendee::setUid(const QString &uid)

Sets the UID of the attendee to uid.

uid is the UID to use for the attendee.

Note: Setter function for property uid.

See also uid().

KCalendarCore::Attendee::PartStat Attendee::status() const

Returns the PartStat of the attendee.

Note: Getter function for property status.

See also setStatus().

QString Attendee::uid() const

Returns the UID of the attendee.

Note: Getter function for property uid.

See also setUid().

bool Attendee::operator!=(const KCalendarCore::Attendee &attendee) const

Compares this with attendee for inequality.

attendee the attendee to compare.

Returns true if attendee is not equal to this object, or false if they are equal.

KCalendarCore::Attendee &Attendee::operator=(const KCalendarCore::Attendee &attendee)

Sets this attendee equal to attendee.

attendee is the attendee to copy.

bool Attendee::operator==(const KCalendarCore::Attendee &attendee) const

Compares this with attendee for equality.

attendee is the attendee to compare.

Returns true if attendee is equal to this object, or false if they are different.