Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: agmxentr.h
Link against: agnmodel.lib

Class CAgnAttendee

CAgnAttendee

Support

Supported from 5.0

Description

Attendee to a group event.

A group event might be, for example, a meeting. An agenda entry may own multiple attendees. Attendees have a role (e.g. delegate, organiser), a status (e.g. accepted, declined), an indicator of whether a reply is requested from the attendee, an address and a priority (indicates whether the attendee is required or requested to attend).

Derivation

CAgnAttendeeAttendee to a group event
CBaseBase class for all classes to be instantiated on the heap

Defined in CAgnAttendee:
Address(), Copy(), EAccepted, EAttendee, ECompleted, EConfirmed, EDeclined, EDelegate, EDelegated, EFyi, EImmediate, ENeedsAction, EOrganizer, EOwner, EReceived, ERequest, ERequire, ESent, ETentative, Expect(), NewL(), ResponseRequested(), Role(), SetExpect(), SetResponseRequested(), SetRole(), SetStatus(), Status(), TAgnExpect, TAgnRole, TAgnStatus

Inherited from CBase:
operator new()


Construction


NewL()

static CAgnAttendee* NewL(const TDesC& aAddress);

Description

Allocates and constructs an attendee object. Initialises the address and sets its other details to the following default values: Role = EAttendee, Status = ENeedsAction, Expect = EFyi, RSVP = EFalse.

Parameters

const TDesC& aAddress

If not NULL, the address of the attendee.

Return value

CAgnAttendee*

Pointer to the newly created attendee.

[Top]


Copy


Copy()

void Copy(CAgnAttendee* aSource);

Description

Makes a copy of all the details from the source to the current attendee.

Parameters

CAgnAttendee* aSource

Pointer to the source attendee.

[Top]


Get details


ResponseRequested()

TBool ResponseRequested() const;

Description

Returns whether a response has been requested from the attendee.

Return value

TBool

ETrue if a response is requested, EFalse if a response is not requested.


Role()

TAgnRole Role() const;

Description

Gets the role of the attendee.

Return value

TAgnRole

The attendee’s role.


Status()

TAgnStatus Status() const;

Description

Gets the status of the attendee.

Return value

TAgnStatus

The attendee’s status.


Expect()

TAgnExpect Expect() const;

Description

Returns the priority indicated to the attendee.

Return value

TAgnExpect

Indicates whether the attendee is expected to attend.


Address()

TPtrC Address() const;

Description

Returns the attendee’s address.

Return value

TPtrC

Pointer descriptor to the attendee’s address.

[Top]


Set details


SetExpect()

void SetExpect(TAgnExpect aExpect);

Description

Sets the priority indicated to the attendee.

Parameters

TAgnExpect aExpect

Indicates the priority required of the attendee.


SetResponseRequested()

void SetResponseRequested(TBool aRsvp);

Description

Sets whether a response is requested from the attendee.

Parameters

TBool aRsvp

ETrue if a response is requested, EFalse if a response is not requested.


SetRole()

void SetRole(TAgnRole aRole);

Description

Sets the role of the attendee.

Parameters

TAgnRole aRole

The attendee’s role.


SetStatus()

void SetStatus(TAgnStatus aStatus);

Description

Sets the status of the attendee.

Parameters

TAgnStatus aStatus

The attendee’s status.

[Top]


Enumerations


Enum TAgnExpect

TAgnExpect

Description

Attendence priority

EFyi

Request is informative only.

ERequire

Attendee's presence is required.

ERequest

Attendee's presence is requested.

EImmediate

Immediate reply requested.


Enum TAgnRole

TAgnRole

Description

Attendee's role

EAttendee

Attendee.

EOrganizer

Organizer, but not owner.

EOwner

Owner.

EDelegate

A delegate of another attendee.


Enum TAgnStatus

TAgnStatus

Description

Attendee's status

EAccepted

Attendee has accepted request.

ENeedsAction

Action required by attendee.

ESent

Request was sent to attendee.

ETentative

Attendee has tentatively accepted request.

EConfirmed

Attendee's presence confirmed.

EDeclined

Attendee has declined request.

ECompleted

Required action has been completed by attendee.

EDelegated

Attendee has delegated the request to another person.

EReceived

Attendee has received request.