![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
RHandleBase |
Abstract: handle to an object |
RSessionBase |
Abstract: base class for handle to a session |
t32alm.h
ealwl.lib
This class defines the alarm servers client side API.
Clients can use this API to connect to the alarm server, add, count and delete alarms, retrieve alarm information, orphan session alarms, and set the alarm sound state.
TInt Connect();
This function connects a client process to the alarm server.
TInt |
An error code: see System error codes. |
TVersion Version() const;
This function returns the version number of the DLL.
The version number may be incremented in future releases of the alarm server. If extra features are added in such releases, the version number may be used by application programs as a basis for assessing the capabilities of the alarm server. Version-specific functions will be marked as such in the SDK documentation.
TVersion |
The version number. |
TInt AlarmCount(TCountCategory aCategory) const;
This function retrieves the number of alarms in a particular category.
TCountCategory aCategory |
The category of alarm being counted. |
TInt |
An error code: see System error codes. |
TAlarmSetState AlarmState(TInt aAlarmId) const;
This function is used to determine whether a given alarm is set, not set, or disabled.
TInt aAlarmId |
The ID of the alarm for which the state is to be found. |
The current state of the alarm. |
TInt AlarmInfo(TAlarmInfo& anAlarm,TInfoCategory aCategory,TInt aAlarmId=KNullAlarmID) const;
This function retrieves alarm information from the alarm server.
The information is retrieved by category and alarm ID. The alarms in each category are indexed from 0 if no ID is specified then the first alarm in the specified category is retrieved (KNullAlarmID).
TAlarmInfo& anAlarm |
On return, contains the alarm information. |
TInfoCategory aCategory |
The category of alarm for which information is to be obtained. |
TInt aAlarmId=KNullAlarmID |
The alarm ID, which must be greater than or equal to zero. The ID defaults to the first alarm in the specified category. |
TInt |
An error code: see System error codes. |
TAlarmSoundState AlarmSoundState() const;
This function returns the alarm sound state. This state, which applies to all alarms, determines whether the sound for active alarms is on, off, or suspended for a predefined period.
TAlarmSoundState |
The alarm sound status. |
TInt AlarmType(TAlarmType& aType,TInt aAlarmId) const;
This function retrieves the type of the specified alarm.
TAlarmType& aType |
On return, contains the alarm type. |
TInt aAlarmId |
The ID of the alarm. |
TInt |
An error code: see System error codes. |
TInt AlarmOwner(TFullName& aName,TInt aAlarmId) const;
This function returns the owners name for an alarm.
TFullName& aName |
On return, contains the owners name for the alarm. |
TInt aAlarmId |
The ID of the alarm. |
TInt |
An error code: see System error codes. |
void AlarmArrayPopulateL(CAlarmIdArray& aArray,TArrayCategory aCategory,TInt aMaxNumber=64) const;
This function populates an array with the alarm IDs of a specified type. The array of IDs can then be used for finding information about each of the alarms.
CAlarmIdArray& aArray |
The array which is to be populated. |
TArrayCategory aCategory |
The type of alarms with which to populate the array. |
TInt aMaxNumber |
The maximum number of alarms in the array. The default is 64. |
TInt AlarmEnable(TBool aShouldEnable,TInt aAlarmId);
This function is used to enable or disable alarms.
TBool aShouldEnable |
ETrue Enable the alarm. EFalse Disable the alarm. |
TInt aAlarmId |
The ID of the alarm to be enabled or disabled. |
TInt |
An error code: see System error codes. |
TInt AlarmDelete(TInt aAlarmId);
This function deletes an alarm from the alarm server.
TInt aAlarmId |
The ID of the alarm to be deleted. |
TInt |
An error code: see System error codes. |
void SetClockAlarm(TInt aClockAlarmIndex,const TTime& aAlarmTime,const TAlarmMessage& aMessage,const TAlarmSoundName& aSound,TAlarmClockRepeat aRepeat);
This function sets a new clock alarm.
TInt aClockAlarmIndex |
The index of the clock alarm range 0 - 7. |
const TTime& aAlarmTime |
The alarm activation time. |
const TAlarmMessage& aMessage |
The text message associated with the alarm. |
const TAlarmSoundName& aSound |
The name of the sound file to be played when the alarm activates. |
TAlarmClockRepeat aRepeat |
The alarm repetition rate. |
void SetSessionAlarm(TRequestStatus& aStatus,const TTime& aAlarmTime,const TAlarmMessage& aMessage,const TAlarmSoundName& aSound,const TTime& aDueDateTime,TSessionType aType);
This function sets the session alarm.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TTime& aAlarmTime |
The alarm date and time. This is the time that the alarm is next expected to activate. This is initially the same as the due time. |
const TAlarmMessage& aMessage |
The alarm message. |
const TAlarmSoundName& aSound |
The name of the sound file to play when the alarm activates. |
const TTime& aDueDateTime |
The alarm due date and time. This is the time that the alarm was/is due. When setting the alarm this should be the same as aAlarmTime. |
TSessionType aType |
The type of session alarm. |
void CancelSessionAlarm();
This function cancels the outstanding session alarm, placed using the SetSessionAlarm() function.
TInt OrphanSessionAlarm();
This function orphans the session alarm. This allows the alarm to be serviced after the session is closed for example, say, when Agenda is shut down.
TInt |
An error code: see System error codes. |
void NotifyOnChange(TRequestStatus& aStatus);
This function provides sessions with notification when the alarm settings change, and when the next alarm time should be calculated.
TRequestStatus& aStatus |
A flag that indicates the completion status of the request. |
void NotifyOnChangeCancel();
This function cancels an "Any change" notification request, placed using the NotifyOnChange() function.
TInt QuietPeriodSet(TTimeIntervalMinutes aQuietInterval);
This function defers all alarm sounds for a given interval.
TTimeIntervalMinutes aQuietInterval |
The time interval for which all alarm sounds are to be deferred. |
TInt |
An error code: see System error codes. |
void QuietPeriodCancel();
This function cancels the alarm quiet period, set using the QuietPeriodSet() function.
TTime QuietPeriodUntil() const;
This function returns the time at which the alarm quiet period will end.
TTime |
The time at which the alarm is no longer quiet. |
void SetAlarmSoundOn(TBool aSetSoundOn);
This function turns the sound for all alarms on or off.
TBool aSetSoundOn |
ETrue = sounds on, EFalse = sounds off. |
This enumeration specifies whether a session alarm is for a timed or an untimed event. The alarm type is set using the RAlarmServer::SetSessionAlarm() function.
The alarm is an untimed event. In Agenda, this corresponds to an untimed day entry. |
|
The alarm is a timed event. In Agenda, this is associated with a timed entry, and remains linked to it. |
This enumeration is used by the AlarmArrayPopulateL() function to define the type of alarms to be put into an array.
The array is to contain pending alarms, including clock alarms, session alarms, orphaned alarms and snoozed alarms. |
|
The array is to contain review alarms. |
|
The array is to contain orphaned alarms. This will also include all snoozed alarms. |
|
The array is to contain snoozed alarms. |
This enumeration is used by the RAlarmServer::AlarmInfo() function to define the category of alarms for which information is required.
Get information for the alarm with the specified ID irrespective of type. |
|
Get information for one of the 8 clock alarms. |
|
Get information for the next alarm which is due irrespective of type. |
|
Get information for a session alarm. |
This enumeration is used by the RAlarmServer::AlarmCount() function to define the category of the alarms which are to be counted.
Count the number of pending alarms. |
|
Count the number of review alarms. |
|
Count the number of orphaned alarms. |
|
Count the number of snoozed alarms. |
|
Count the number of unacknowledged alarms. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |