Symbian^3 Product Developer Library >

TMsvOffPeakTime Class Reference

class TMsvOffPeakTime

Defines an off-peak period for message sending.

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

Public Member Functions
TMsvOffPeakTime()
TMsvOffPeakTime(const TDay, const TInt, const TInt, const TTimeIntervalMinutes)
IMPORT_C TDayDay()
IMPORT_C TIntHour()
IMPORT_C TIntMinute()
IMPORT_C const TTimeNextTimeInclusive(const TTime &)
IMPORT_C voidReset()
IMPORT_C voidSetDay(const TDay)
IMPORT_C voidSetHour(const TInt)
IMPORT_C voidSetMinute(const TInt)
IMPORT_C voidSetValidityPeriod(const TTimeIntervalMinutes)
IMPORT_C const TTimeIntervalMinutesValidityPeriod()
Private Attributes
TDay iDay
TInt8 iHour
TInt8 iMinute
TTimeIntervalMinutes iValidityPeriod

Constructor & Destructor Documentation

TMsvOffPeakTime()

IMPORT_CTMsvOffPeakTime()

Default constructor.

TMsvOffPeakTime(const TDay, const TInt, const TInt, const TTimeIntervalMinutes)

IMPORT_CTMsvOffPeakTime(const TDayaDay,
const TIntaHour,
const TIntaMinute,
const TTimeIntervalMinutesaValidityPeriod
)

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

Parameters

const TDay aDayDay start time.
const TInt aHourHour start time.
const TInt aMinuteMinute start time.
const TTimeIntervalMinutes aValidityPeriodDuration (in minutes).

Member Functions Documentation

Day()

IMPORT_C TDayDay()const

Gets the start time day parameter.

Hour()

IMPORT_C TIntHour()const

Gets the start time hour parameter.

Minute()

IMPORT_C TIntMinute()const

Gets the start time minute parameter.

NextTimeInclusive(const TTime &)

IMPORT_C const TTimeNextTimeInclusive(const TTime &aFromTime)const

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 & aFromTimeSpecified time.

Reset()

IMPORT_C voidReset()

Resets the object to default settings.

SetDay(const TDay)

IMPORT_C voidSetDay(const TDayaDay)

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

Parameters

const TDay aDayStart time day parameter.

SetHour(const TInt)

IMPORT_C voidSetHour(const TIntaHour)

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

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

Parameters

const TInt aHourStart time hour parameter.

SetMinute(const TInt)

IMPORT_C voidSetMinute(const TIntaMinute)

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

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

Parameters

const TInt aMinuteStart time minute parameter.

SetValidityPeriod(const TTimeIntervalMinutes)

IMPORT_C voidSetValidityPeriod(const TTimeIntervalMinutesaValidityPeriod)

Sets the duration parameter.

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

Parameters

const TTimeIntervalMinutes aValidityPeriodDuration parameter.

ValidityPeriod()

IMPORT_C const TTimeIntervalMinutesValidityPeriod()const

Gets the duration parameter.

Member Data Documentation

TDay iDay

TDay iDay[private]

TInt8 iHour

TInt8 iHour[private]

TInt8 iMinute

TInt8 iMinute[private]

TTimeIntervalMinutes iValidityPeriod

TTimeIntervalMinutes iValidityPeriod[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.