TASShdAlarm Class Reference

class TASShdAlarm

A client-side alarm object.

It contains all of the information needed to create an alarm in the Alarm Server.

Public Member Functions
	TASShdAlarm()
TAlarmCategory &	Category()
TAlarmCategory	Category()
TAlarmCharacteristicsFlags &	Characteristics()
TAlarmCharacteristicsFlags	Characteristics()
TInt	ClientData1()
TInt &	ClientData1()
TInt	ClientData2()
TInt &	ClientData2()
TBitFlags16 &	ClientFlags()
TBitFlags16	ClientFlags()
TAlarmDayOrTimed	DayOrTimed()
TAlarmDayOrTimed &	DayOrTimed()
IMPORT_C void	ExternalizeL(RWriteStream &)
TSecureId	GetSid()
IMPORT_C TBool	HasAssociatedData()
IMPORT_C TBool	HasBecomeOrphaned()
IMPORT_C TBool	HasOwningSession()
TAlarmId &	Id()
TAlarmId	Id()
IMPORT_C void	InternalizeL(RReadStream &)
TBool	IsFloating()
TAlarmMessage &	Message()
const TAlarmMessage &	Message()
TTime &	NextDueTime()
const TTime &	NextDueTime()
TTime &	OriginalExpiryTime()
const TTime &	OriginalExpiryTime()
TAlarmRepeatDefinition &	RepeatDefinition()
TAlarmRepeatDefinition	RepeatDefinition()
IMPORT_C void	Reset()
IMPORT_C void	SetDeQueueIfDueTimeInPast()
void	SetSid(const TSecureId &)
IMPORT_C void	SetUtcNextDueTime(TTime)
TAlarmSoundName &	SoundName()
const TAlarmSoundName &	SoundName()
TAlarmState	State()
TAlarmStatus	Status()

Protected Member Enumerations
enum	TASShdAlarmFlags { EASShdAlarmFlagsHasAssociatedData = 0, EASShdAlarmFlagsHasOwningSession = 1, EASShdAlarmFlagsHasBecomeOrphaned = 2, EASShdAlarmFlagsPermanentDisabled = 4 }

Protected Attributes
TAlarmId	iAlarmId
TAlarmCategory	iCategory
TAlarmCharacteristicsFlags	iCharacteristics
TInt	iClientData1
TInt	iClientData2
TBitFlags16	iClientFlags
TAlarmDayOrTimed	iDayOrTimed
TBitFlags8	iFlags
TAlarmMessage	iMessage
TTime	iNextDueTime
TTime	iOriginalExpiryTime
TAlarmRepeatDefinition	iRepeatDefinition
TAlarmSoundName	iSoundName
TAlarmState	iState
TAlarmStatus	iStatus

Private Attributes
TSecureId	iTASShdAlarmSID
TAny *	iTASShdAlarm_2
TAny *	iTASShdAlarm_3

Constructor & Destructor Documentation

TASShdAlarm()

IMPORT_C

TASShdAlarm

(

)

Member Functions Documentation

Category()

TAlarmCategory &

Category()

TAlarmCategory

Characteristics()

TAlarmCharacteristicsFlags &

Characteristics

(

)

[inline]

Returns a writable version of the alarm's characteristics.

Alarm characteristics bit flags.

Characteristics()

TAlarmCharacteristicsFlags

Characteristics

(

)

const [inline]

Returns the alarm's characteristics

Alarm characteristics bit flags.

ClientData1()

TInt

ClientData1

(

)

const [inline]

Returns the client data from slot 1 for this alarm.

The first client-specific integer.

ClientData1()

TInt &

ClientData1

(

)

[inline]

Returns a writable version of the client data from slot 1 for this alarm.

Reference to the first client-specific integer.

ClientData2()

TInt

ClientData2

(

)

const [inline]

Returns the client data from slot 2 for this alarm.

The second client-specific integer.

ClientData2()

TInt &

ClientData2

(

)

[inline]

Returns the client data from slot 2 for this alarm.

The second client-specific integer.

ClientFlags()

TBitFlags16 &

ClientFlags

(

)

[inline]

Returns a writable version of the alarm's client flags.

The client flags may be used for any client-specific data - the alarm server does not use them.

Reference to the alarm's bit flags.

ClientFlags()

TBitFlags16

ClientFlags

(

)

const [inline]

Returns this alarm's client flags.

Reference to the alarm's bit flags.

DayOrTimed()

TAlarmDayOrTimed

DayOrTimed

(

)

const [inline]

Returns the alarm session type.

Alarm session type.

DayOrTimed()

TAlarmDayOrTimed &

DayOrTimed

(

)

[inline]

Returns a writable version of the alarm type, i.e. day, timed

iDayOrTimed.

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Parameters

RWriteStream & aStream

GetSid()

TSecureId

GetSid

(

)

const [inline]

HasAssociatedData()

IMPORT_C TBool

HasAssociatedData

(

)

const

HasBecomeOrphaned()

IMPORT_C TBool

HasBecomeOrphaned

(

)

const

HasOwningSession()

IMPORT_C TBool

HasOwningSession

(

)

const

Id()

TAlarmId &

(

)

[inline]

Returns a writable version of the alarm's unique identifier.

Reference to the unique identifier.

Id()

TAlarmId

(

)

const [inline]

Return the alarm's unique identifier.

The unique identifier.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Parameters

RReadStream & aStream

IsFloating()

TBool

IsFloating

(

)

const [inline]

Tests whether the alarm is floating.

Floating alarms expire at a given wall-clock time regardless of the current locale and whether any daylight saving time rules are in force.

True if the alarm is floating.

Message()

TAlarmMessage &

Message

(

)

[inline]

Returns a writable version of the alarm's message.

The message is usually displayed in the application UI when the alarm expires.

Reference to the alarm's associated message.

Message()

const TAlarmMessage &

Message

(

)

const [inline]

Returns the alarm's message.

The message is usually displayed in the application UI when the alarm expires.

Reference to the alarm's associated message.

NextDueTime()

TTime &

NextDueTime

(

)

[inline]

Returns a writable version of the next time the alarm is scheduled to expire.

Next expiry time.

NextDueTime()

const TTime &

NextDueTime

(

)

const [inline]

Returns the next time that the alarm is scheduled to expire.

Next expiry time.

OriginalExpiryTime()

TTime &

OriginalExpiryTime

(

)

[inline]

Returns a writable version of the alarm's original expiry time.

Original expiry time.

OriginalExpiryTime()

const TTime &

OriginalExpiryTime

(

)

const [inline]

Returns the alarm's original expiry time.

The original expiry time is the same as the next due time, unless the alarm has been snoozed. In that case, the original expiry time is the time when the alarm first expired, and the next due time is when it is to re-awaken after the snooze.

Original expiry time.

RepeatDefinition()

TAlarmRepeatDefinition &

RepeatDefinition

(

)

[inline]

Returns a writable version of the alarm's repeat definition.

The repeat definition controls the alarm's behaviour after it has expired. For example, you can set the repeat definition so that the server automatically queues the alarm to expire again in exactly 24 hours time.

Alarm repeat definition.

RepeatDefinition()

TAlarmRepeatDefinition

RepeatDefinition

(

)

const [inline]

Returns the repeat definition for the alarm.

The alarm's repeat definition.

Reset()

IMPORT_C void

Reset

(

)

SetDeQueueIfDueTimeInPast()

IMPORT_C void

SetDeQueueIfDueTimeInPast

(

)

SetSid(const TSecureId &)

void

SetSid

(

const TSecureId &

aSecureID

)

[inline]

The Secure ID is only used in the secured platform

Parameters

const TSecureId & aSecureID

SetUtcNextDueTime(TTime)

IMPORT_C void

SetUtcNextDueTime

(

TTime

aUtcTime

)

Parameters

TTime aUtcTime

SoundName()

TAlarmSoundName &

SoundName

(

)

[inline]

Return a writable version of the alarm sound's filename.

Reference to the alarm's sound filename.

SoundName()

const TAlarmSoundName &

SoundName

(

)

const [inline]

Returns the alarm's sound filename.

Sound filename.

State()

TAlarmState

State

(

)

const [inline]

Returns the alarm state.

Alarm state.

Status()

TAlarmStatus

Status

(

)

const [inline]

Returns the alarm status.

Alarm status.

Member Enumerations Documentation

Enum TASShdAlarmFlags

Enumerators

EASShdAlarmFlagsHasAssociatedData = 0
EASShdAlarmFlagsHasOwningSession = 1
EASShdAlarmFlagsHasBecomeOrphaned = 2
EASShdAlarmFlagsPermanentDisabled = 4	Set if alarm is disabled manually so that can not be enabled when locale changes.

Member Data Documentation

TAlarmId iAlarmId

TAlarmId

iAlarmId

[protected]

The unique identifier assoicated with each alarm maintained by the alarm world server.

TAlarmCategory iCategory

TAlarmCategory

iCategory

[protected]

This UID is supplied by the client and is used to indicate the category that this alarm is part of. The Alarm Server is category-agnostic, that is, this information is for the client's use only

TAlarmCharacteristicsFlags iCharacteristics

TAlarmCharacteristicsFlags

iCharacteristics

[protected]

This represents the desired behaviour for a given alarm. The Alarm Server uses this information to control the behaviour of the alarm.

TAlarmCharacteristics

TInt iClientData1

TInt

iClientData1

[protected]

For arbitrary client data 1

TInt iClientData2

TInt

iClientData2

[protected]

For arbitrary client data 2

TBitFlags16 iClientFlags

TBitFlags16

iClientFlags

[protected]

Flags for use by any particular client. These will only be relevant to a client who can interpret them.

TAlarmDayOrTimed iDayOrTimed

TAlarmDayOrTimed

iDayOrTimed

[protected]

The type of this alarm (e.g. day, timed)

TBitFlags8 iFlags

TBitFlags8

iFlags

[protected]

Various flags - used internally by the alarm object

TAlarmMessage iMessage

TAlarmMessage

iMessage

[protected]

The message associated with this alarm, typically used in an application UI to inform the user as to the reason for the alarm.

TTime iNextDueTime

TTime

iNextDueTime

[protected]

The date and time at which this alarm is next due. For alarms that haven't been snoozed, then this is the original due time.

For alarms that have been snoozed, this is the time at which the alarm will reawaken.

TTime iOriginalExpiryTime

TTime

iOriginalExpiryTime

[protected]

This attribute is only used in the instance whereby an alarm is snoozed. It represents the time at which the alarm first expired.

TAlarmRepeatDefinition iRepeatDefinition

TAlarmRepeatDefinition

iRepeatDefinition

[protected]

Controls how the alarm repeats after it has expired. Note that session alarms are not allowed to repeat (they must be "once only").

TAlarmSoundName iSoundName

TAlarmSoundName

iSoundName

[protected]

A descriptor which holds the name of the sound file which should be played when the alarm expires.

TAlarmState iState

TAlarmState

iState

[protected]

The state of this alarm (e.g. queued, notifying, notified, snoozed etc)

TAlarmStatus iStatus

TAlarmStatus

iStatus

[protected]

The status of this alarm (e.g. enabled, disabled)

TSecureId iTASShdAlarmSID

TSecureId

iTASShdAlarmSID

[private]

TAny * iTASShdAlarm_2

TAny *

iTASShdAlarm_2

[private]

TAny * iTASShdAlarm_3

TAny *

iTASShdAlarm_3

[private]