Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <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:

Inherited from CBase:

Inherited from CCalUser:


Construction and destruction


NewL(const TDesC &)

Capability: Illegal

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

Description

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

Parameters

const TDesC16 &aAddress

The address of the attendee.

Return value

CCalAttendee *

Pointer to newly constructed object


NewL(const TDesC &,const TDesC &)

Capability: Illegal

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

Description

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

Parameters

const TDesC16 &aAddress

The address of the attendee.

const TDesC16 &aSentBy

Return value

CCalAttendee *

Pointer to newly constructed object


NewL(const TDesC &)

Capability: Illegal

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

Description

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

Parameters

const TDesC16 &aAddress

The address of the user.

Return value

CCalAttendee *

The newly constructed object.


NewL(const TDesC &,const TDesC &)

Capability: Illegal

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

Description

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

Parameters

const TDesC16 &aAddress

The address of the user.

const TDesC16 &aSentBy

The sender.

Return value

CCalAttendee *

The newly constructed object.

[Top]


Member functions


SetRoleL(TCalRole)

Capability: Illegal

IMPORT_C void SetRoleL(TCalRole aRole);

Description

Set the role of this attendee.

Parameters

CCalAttendee::TCalRole aRole

The role.


SetStatusL(TCalStatus)

Capability: Illegal

IMPORT_C void SetStatusL(TCalStatus aStatus);

Description

Set the status of this attendee.

Parameters

CCalAttendee::TCalStatus aStatus

The status.


SetResponseRequested(TBool)

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()const

Capability: Illegal

IMPORT_C TCalRole RoleL() const;

Description

Get the role of this attendee.

Return value

CCalAttendee::TCalRole

The role.


StatusL()const

Capability: Illegal

IMPORT_C TCalStatus StatusL() const;

Description

Get the status of this attendee.

Return value

CCalAttendee::TCalStatus

The status.


ResponseRequested()const

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.


SetRoleL(TCalRole)

Capability: Illegal

IMPORT_C void SetRoleL(TCalRole aRole);

Description

Parameters

CCalAttendee::TCalRole aRole


SetStatusL(TCalStatus)

Capability: Illegal

IMPORT_C void SetStatusL(TCalStatus aStatus);

Description

Parameters

CCalAttendee::TCalStatus aStatus


SetResponseRequested(TBool)

Capability: Illegal

IMPORT_C void SetResponseRequested(TBool aRsvp);

Description

Parameters

TBool aRsvp


SetVCalExpect(TVCalExpect)

Capability: Illegal

IMPORT_C void SetVCalExpect(TVCalExpect aExpected);

Description

Sets the expected response of this attendee. This property is supported in vCalendar only.

Parameters

CCalAttendee::TVCalExpect aExpected

The expected response.


RoleL()const

Capability: Illegal

IMPORT_C TCalRole RoleL() const;

Description

Return value

CCalAttendee::TCalRole


StatusL()const

Capability: Illegal

IMPORT_C TCalStatus StatusL() const;

Description

Return value

CCalAttendee::TCalStatus


ResponseRequested()const

Capability: Illegal

IMPORT_C TBool ResponseRequested() const;

Description

Return value

TBool


VCalExpect()const

Capability: Illegal

IMPORT_C TVCalExpect VCalExpect() const;

Description

Gets the expected response of this attendee. This property is supported in vCalendar only.

Return value

CCalAttendee::TVCalExpect

The expected response.

[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 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.

EVCalAttendee

Indicates an attendee at the event or todo. This value is supported in vCalendar only.

EVCalDelegate

Indicates a delegate of another attendee. This value is supported in vCalendar only.

EVCalOwner

Indicates owner of the event or todo (not the same as phone owner). This value is supported in vCalendar only.


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.


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.

EVCalSent

An entry has been sent. This value is supported in vCalendar only.

EVCalXReceived

An entry has been received. This value is supported in vCalendar only.


Enum TVCalExpect

TVCalExpect

Description

Attendee's expected participation response. This property is supported in vCalendar only. It is not a property of iCalendar.

EVCalFyi

Indicates request is for your information.

EVCalRequire

Indicates presence is definitely required.

EVCalRequest

Indicates presence is being requested.

EVCalImmediate

Indicates an immediate response needed.