Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: caluser.h
Link against: calinterimapi.lib

Class CCalAttendee

class CCalAttendee : public CCalUser;

Description

Class representing an attendee of an event.

CCalAttendee is a specialization of the CCalUser class.

This class contains extra methods to store and retrieve an Attendee's ROLE, PART-STAT, and RSVP fields.

Derivation

Members

Defined in CCalAttendee:
EAccepted, EChair, ECompleted, EConfirmed, EDeclined, EDelegated, EInProcess, ENeedsAction, ENonParticipant, EOptParticipant, EReqParticipant, ETentative, NewL(), NewL(), ResponseRequested(), RoleL(), SetResponseRequested(), SetRoleL(), SetStatusL(), StatusL(), TCalRole, TCalStatus

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CCalUser:
Address(), CommonName(), SentBy(), SetCommonNameL(), iImpl


Construction and destruction


NewL()

Capability: Illegal

static IMPORT_C CCalAttendee *NewL(const TDesC &aAddress);

Description

Allocates and constructs a new attendee with the specified email address.

Parameters

const TDesC &aAddress

The address of the attendee.

Return value

CCalAttendee *

Pointer to newly constructed object


NewL()

Capability: Illegal

static IMPORT_C CCalAttendee *NewL(const TDesC &aAddress, const TDesC &aSentBy);

Description

Allocates and constructs a new attendee with the specified email address and sender.

Parameters

const TDesC &aAddress

The address of the attendee.

const TDesC &aSentBy

Return value

CCalAttendee *

Pointer to newly constructed object

[Top]


Member functions


SetRoleL()

Capability: Illegal

IMPORT_C void SetRoleL(TCalRole aRole);

Description

Set the role of this attendee.

Parameters

TCalRole aRole

The role.


SetStatusL()

Capability: Illegal

IMPORT_C void SetStatusL(TCalStatus aStatus);

Description

Set the status of this attendee.

Parameters

TCalStatus aStatus

The status.


SetResponseRequested()

Capability: Illegal

IMPORT_C void SetResponseRequested(TBool aRsvp);

Description

Sets whether or not a response was requested for this attendee.

Parameters

TBool aRsvp

ETrue if a response was requested, EFalse if not.


RoleL()

Capability: Illegal

IMPORT_C TCalRole RoleL() const;

Description

Get the role of this attendee.

Return value

TCalRole

The role.


StatusL()

Capability: Illegal

IMPORT_C TCalStatus StatusL() const;

Description

Get the status of this attendee.

Return value

TCalStatus

The status.


ResponseRequested()

Capability: Illegal

IMPORT_C TBool ResponseRequested() const;

Description

Gets whether or not a response was requested for this attendee.

Return value

TBool

ETrue if a response was requested, EFalse if not.

[Top]


Member enumerations


Enum TCalRole

TCalRole

Description

Attendee's role

EReqParticipant

A required participant of the event.

EOptParticipant

An optional participant of the event.

ENonParticipant

A non-participant of the event.

EChair

This participant will chair the event.


Enum TCalStatus

TCalStatus

Description

Attendee's status

ENeedsAction

Action is required by attendee.

EAccepted

Attendee has accepted request.

ETentative

Attendee has tentatively accepted the request.

EConfirmed

Attendee's presence is confirmed.

EDeclined

Attendee has declined request.

ECompleted

The required action has been completed by attendee.

EDelegated

Attendee has delegated the request to another person.

EInProcess

A to-do action in the process of being completed.