Class TMsvOffPeakTime

class TMsvOffPeakTime;

Description

Defines an off-peak period for message sending.

An off-peak period is specified as a start time and a duration.

Members

Defined in TMsvOffPeakTime:
Day(), Hour(), Minute(), NextTimeInclusive(), Reset(), SetDay(), SetHour(), SetMinute(), SetValidityPeriod(), TMsvOffPeakTime(), TMsvOffPeakTime(), ValidityPeriod()

IMPORT_C TMsvOffPeakTime();

Description

Default constructor.

IMPORT_C TMsvOffPeakTime(const TDay aDay, const TInt aHour, const TInt aMinute, const TTimeIntervalMinutes aValidityPeriod);

Description

Constructor specifying off-peak time parameters. Note that the offpeak start time must be specified in UTC (Universal Time Coordinated)time.

Parameters

const TDay aDay Day start time. const TInt aHour Hour start time. const TInt aMinute Minute start time. const TTimeIntervalMinutes aValidityPeriod Duration (in minutes).

IMPORT_C void Reset();

Description

Resets the object to default settings.

IMPORT_C TDay Day() const;

Description

Gets the start time day parameter.

Return value

TDay Start time day parameter.

IMPORT_C void SetDay(const TDay aDay);

Description

Sets the start time day parameter. Note that the offpeak start time must be specified in UTC (Universal Time Coordinated)time.

Parameters

const TDay aDay Start time day parameter.

IMPORT_C TInt Hour() const;

Description

Gets the start time hour parameter.

Return value

TInt Start time hour parameter

IMPORT_C void SetHour(const TInt aHour);

Description

Sets the start time hour parameter. Note that the offpeak start time must be specified in UTC (Universal Time Coordinated)time.

Parameters

const TInt aHour Start time hour parameter.

Panic codes

ScheduleSend-DLL 12 The hour parameter is invalid (negative or more than 23).

IMPORT_C TInt Minute() const;

Description

Gets the start time minute parameter.

Return value

TInt Start time minute parameter.

IMPORT_C void SetMinute(const TInt aMinute);

Description

Sets the start time minute parameter. Note that the offpeak start time must be specified in UTC (Universal Time Coordinated)time.

Parameters

const TInt aMinute Start time minute parameter.

Panic codes

ScheduleSend-DLL 13 The minute parameter is invalid (negative or more than 59).

IMPORT_C const TTimeIntervalMinutes ValidityPeriod() const;

Description

Gets the duration parameter.

Return value

const TTimeIntervalMinutes Duration parameter.

IMPORT_C void SetValidityPeriod(const TTimeIntervalMinutes aValidityPeriod);

Description

Sets the duration parameter.

Parameters

const TTimeIntervalMinutes aValidityPeriod Duration parameter.

Panic codes

ScheduleSend-DLL 10 The duration period is invalid (negative or more than 24 hours).

IMPORT_C const TTime NextTimeInclusive(const TTime &aFromTime) const;

Description

Gets the next time, after a specified time, when this off-peak time becomes active.

If aFromTime is within the validity period of this off-peak time, then the next time will be less than or equal to aFromTime.

Parameters

const TTime &aFromTime Specified time.

Return value

const TTime Next time