CMsvScheduledEntry Class Reference
#include
<mw/msvscheduledentry.h>
Link against: schsend.lib
class CMsvScheduledEntry : public CBase |
Detailed Description
Abstract base class which stores the schedule data and recipients of a message.
CMsvScheduledEntry does not force the Server MTM to store the message recipients in a certain way. However, it is recommended that the Server MTM derive its recipients class from CMsvRecipient, because the class already has support for the number of retries to send a message to a recipient.
CMsvScheduledEntry stores the TMsvEntry to which it relates to provide quick access to the scheduling-related index data without needing calls to CMsvServerEntry::SetEntry(). However, CMsvScheduledEntry does not provide access to all the members of the TMsvEntry. This is to stop the user of the CMsvScheduledEntry from accessing the descriptor members of the TMsvEntry while the server entry is not set to the TMsvEntry.
Member Attribute Documentation
Constructor & Destructor Documentation
CMsvScheduledEntry ( const TMsvEntry & )
IMPORT_C | CMsvScheduledEntry | ( | const TMsvEntry & | aEntry | ) | [protected] |
Parameters |
---|
aEntry | Scheduled message. |
Member Function Documentation
CanSendToAnyRecipients ( const CMsvSendErrorActions &, TMsvSendErrorAction & )
Tests if any of the recipients of this message can still be sent to.
Parameters |
---|
aErrorActions | Error-actions |
aAction | Default error-action |
- Return Value
- True if at least one of the recipients has not been sent the message.
CanSendToAnyRecipients ( const TMsvSendErrorAction & )
Tests if any of the recipients of this message can still be sent to.
Parameters |
---|
aAction | Default error-action |
- Return Value
- True if at least one of the recipients has not been sent the message.
Entry ( TMsvEntry & )
Parameters |
---|
aEntry | On return, the message entry. |
Error ( )
const TInt | Error | ( | ) | const [inline] |
Failed ( )
const TBool | Failed | ( | ) | const [inline] |
Id ( )
const TMsvId | Id | ( | ) | const [inline] |
Mtm ( )
const TUid | Mtm | ( | ) | const [inline] |
OffPeak ( )
const TBool | OffPeak | ( | ) | const [inline] |
PendingConditions ( )
IMPORT_C TBool | PendingConditions | ( | ) | const |
Gets the entry's pending conditions flag.
- Return Value
- The entry's pending conditions flag.
RecipientsAllSent ( )
TBool
| RecipientsAllSent | ( | ) | const [pure virtual] |
Tests if all recipients of the message have been sent successfully.
- Return Value
- True if all recipients have been sent successfully.
RecipientsIncreaseRetries ( )
void | RecipientsIncreaseRetries | ( | ) | [pure virtual] |
Increases all the recipients' retries by one.
RecipientsResetRetries ( )
void | RecipientsResetRetries | ( | ) | [pure virtual] |
Sets all the recipients' retries to zero.
RecipientsRestoreL ( CMsvStore & )
void | RecipientsRestoreL | ( | CMsvStore & | aStore | ) | [pure virtual] |
Parameters |
---|
aStore | Store to read from. |
RecipientsSetFailed ( )
void | RecipientsSetFailed | ( | ) | [pure virtual] |
Sets all the recipients' flags to sending failed.
RecipientsStoreL ( CMsvStore & )
void | RecipientsStoreL | ( | CMsvStore & | aStore | ) | const [pure virtual] |
Parameters |
---|
aStore | Store to write to. |
RestoreL ( CMsvStore & )
IMPORT_C void | RestoreL | ( | CMsvStore & | aStore | ) | [virtual] |
Parameters |
---|
aStore | Store to read from. |
ScheduleDate ( )
const TTime & | ScheduleDate | ( | ) | const [inline] |
Scheduled ( )
const TBool | Scheduled | ( | ) | const [inline] |
SendingState ( )
const TInt | SendingState | ( | ) | const [inline] |
SetFailed ( const TBool )
void | SetFailed | ( | const TBool | aFail | ) | [inline] |
SetPendingConditions ( TBool )
IMPORT_C void | SetPendingConditions | ( | TBool | aPendingConditions | ) | |
sets the entry's pending conditions flag.
SetScheduleDate ( const TTime & )
void | SetScheduleDate | ( | const TTime & | aDate | ) | [inline] |
SetScheduled ( const TBool )
void | SetScheduled | ( | const TBool | aScheduled | ) | [inline] |
SetSendingState ( TInt )
void | SetSendingState | ( | TInt | aState | ) | [inline] |
StoreL ( CMsvStore & )
IMPORT_C void | StoreL | ( | CMsvStore & | aStore | ) | const [virtual] |
Parameters |
---|
aStore | Store to write to. |