TMsvEntry Class Reference
Represents an entry in the Message Server index.
MTM implementations and message client applications use it to access and manipulate index entry values. Note that a TMsvEntry is effectively a local cache of the index entry, and changes to it are not automatically written into the index. To commit changes to the Message Server, you need to call CMsvEntry::ChangeL() (or CMsvServerEntry::ChangeEntry()).
To avoid repetition, the functions and data members are simply listed here, without detailed explanation of the fields. The public data members can be used to get and set the values of some index entry fields.
Constructor & Destructor Documentation
TMsvEntry()
Default constructor.
Initialises the new object to null values: 0 for integer values, KMsvNullIndexEntryId for IDs, and KUidMsvNullEntry for UIDs.
TMsvEntry(const TMsvEntry &)
Copy constructor.
It creates a simple copy of the entry, so the TPtrC members iDescription and iDetails will point to the same descriptor data in the original and new objects.
Member Functions Documentation
Attachment()
|
TBool
| Attachment | ( | ) | const [inline] |
Gets the value of the attachment flag.
Complete()
|
TBool
| Complete | ( | ) | const [inline] |
Gets the value of the message complete flag.
Note that for email download without size limits, the complete flag will only be set to true once all the parts of the message (body text and attachments) have been downloaded.
Connected()
|
TBool
| Connected | ( | ) | const [inline] |
Gets the value of the remote server connection flag.
DecPcSyncCount()
| void | DecPcSyncCount | ( | ) | [inline] |
Decrements the PC synchronisation field.
DeleteProtected()
|
TBool
| DeleteProtected | ( | ) | const [inline] |
Deleted()
|
TBool
| Deleted | ( | ) | const [inline] |
Gets the value of the deleted flag.
ExternalizeL(RWriteStream &)
Writes the object into the stream specified.
Failed()
|
TBool
| Failed | ( | ) | const [inline] |
Gets the value of the message send failed flag.
Forwarded()
|
TBool
| Forwarded | ( | ) | const [inline] |
Id()
Gets the value of the entry ID.
InPreparation()
|
TBool
| InPreparation | ( | ) | const [inline] |
Gets the value of the in preparation flag.
IncPcSyncCount()
| void | IncPcSyncCount | ( | ) | [inline] |
Increments the PC synchronisation field.
InternalizeL(RReadStream &)
Reads an externalised object from the specified stream.
LocallyDeleted()
|
TBool
| LocallyDeleted | ( | ) | const [inline] |
MtmData1()
| IMPORT_C TInt32 | MtmData1 | ( | ) | const |
Gets the integer value of iMtmData1
MtmData2()
| IMPORT_C TInt32 | MtmData2 | ( | ) | const |
Gets the integer value of iMtmData2
MtmData3()
| IMPORT_C TInt32 | MtmData3 | ( | ) | const |
Gets the integer value of iMtmData3
MultipleRecipients()
|
TBool
| MultipleRecipients | ( | ) | const [inline] |
Gets the value of the multiple recipients flag.
New()
|
TBool
| New | ( | ) | const [inline] |
Gets the value of the new message flag.
OffPeak()
|
TBool
| OffPeak | ( | ) | const [inline] |
Operation()
|
TBool
| Operation | ( | ) | const [inline] |
Gets the value of the disconnected operation queued flag.
Owner()
|
TBool
| Owner | ( | ) | const [inline] |
Gets the value of the owner flag.
Parent()
Gets the value of the parent ID.
PcSyncCount()
|
TInt
| PcSyncCount | ( | ) | const [inline] |
Gets the value of the PC synchronisation field.
PendingConditions()
| IMPORT_C TBool | PendingConditions | ( | ) | const |
Gets the pending conditions flag.
PendingDelete()
|
TBool
| PendingDelete | ( | ) | const [inline] |
PermanentDataUnchanged(const TMsvEntry &)
Compares if the flag settings in two index entries are the same. The Connected and Pending Delete flags are not used in the comparison, as they indicate temporary conditions of the entry.
Parameters
| const TMsvEntry & aEntry | Index entry to compare against |
PersistedFlags()
|
TUint
| PersistedFlags | ( | ) | const [protected, inline] |
Priority()
Gets the value of the message priority field.
ReadOnly()
|
TBool
| ReadOnly | ( | ) | const [inline] |
Gets the value of the read-only flag.
Scheduled()
|
TBool
| Scheduled | ( | ) | const [inline] |
SendingState()
|
TUint
| SendingState | ( | ) | const [inline] |
SetAttachment(TBool)
| void | SetAttachment | ( | TBool | aAttachmentFlag | ) | [inline] |
Sets the attachment flag.
Parameters
| TBool aAttachmentFlag | Value for the attachment flag |
SetComplete(TBool)
| void | SetComplete | ( | TBool | aComplete | ) | [inline] |
Sets the message complete flag.
Note that for email download without size limits, the complete flag will only be set to true once all the parts of the message (body text and attachments) have been downloaded.
Parameters
| TBool aComplete | Value for the message complete flag |
SetConnected(TBool)
| void | SetConnected | ( | TBool | aConnected | ) | [inline] |
Sets the remote server connection flag.
Parameters
| TBool aConnected | Value for the remote server connection flag |
SetDeleteProtected(TBool)
| void | SetDeleteProtected | ( | TBool | aDeleteProtected | ) | [inline] |
This method sets bit 24 of iMtmData1, if you are using this bit elsewhere don't call this method.
SetDeleted(TBool)
| void | SetDeleted | ( | TBool | aDeletedFlag | ) | [protected, inline] |
SetFailed(TBool)
| void | SetFailed | ( | TBool | aFailed | ) | [inline] |
Sets the message send failed flag.
Parameters
| TBool aFailed | Value for the message send failed flag |
SetForwarded(TBool)
| void | SetForwarded | ( | TBool | aForwarded | ) | [inline] |
This method sets bit 31 of iMtmData1, if you are using this bit elsewhere don't call this method.
SetId(TMsvId)
| void | SetId | ( | TMsvId | aId | ) | [protected, inline] |
SetInPreparation(TBool)
| void | SetInPreparation | ( | TBool | aInPreparation | ) | [inline] |
Sets the in-preparation flag.
Parameters
| TBool aInPreparation | Value for the in-preparation flag |
SetLocallyDeleted(TBool)
| void | SetLocallyDeleted | ( | TBool | aLocallyDeleted | ) | [inline] |
This method sets bit 32 of iMtmData1, if you are using this bit elsewhere don't call this method.
SetMtmData1(TInt32)
| IMPORT_C void | SetMtmData1 | ( | TInt32 | aMtmData | ) | |
Sets the value of iMtmData1. This API should only be called by Symbian Software Ltd.
Parameters
| TInt32 aMtmData | Value of the data to be stored in iMtmData1 |
SetMtmData2(TInt32)
| IMPORT_C void | SetMtmData2 | ( | TInt32 | aMtmData | ) | |
Sets the value of iMtmData2. This API should only be called by Symbian Software Ltd.
Parameters
| TInt32 aMtmData | Value of the data to be stored in iMtmData2 |
SetMtmData3(TInt32)
| IMPORT_C void | SetMtmData3 | ( | TInt32 | aMtmData | ) | |
Sets the value of iMtmData3. This API should only be called by Symbian Software Ltd.
Parameters
| TInt32 aMtmData | Value of the data to be stored in iMtmData3 |
SetMultipleRecipients(TBool)
| void | SetMultipleRecipients | ( | TBool | aMultipleRecipient | ) | [inline] |
Sets the multiple recipients flag.
Parameters
| TBool aMultipleRecipient | Value for the multiple recipients flag |
SetNew(TBool)
| void | SetNew | ( | TBool | aNew | ) | [inline] |
Sets the message new flag.
Parameters
| TBool aNew | Value for the message new flag |
SetOffPeak(TBool)
| void | SetOffPeak | ( | TBool | aOffPeak | ) | [inline] |
Parameters
| TBool aOffPeak | Value for off-peak flag. |
SetOperation(TBool)
| void | SetOperation | ( | TBool | aOperation | ) | [inline] |
Sets the disconnected operation queued flag.
Parameters
| TBool aOperation | Value for the disconnected operation queued flag |
SetOwner(TBool)
| void | SetOwner | ( | TBool | aAttachment | ) | [protected, inline] |
SetParent(TMsvId)
| void | SetParent | ( | TMsvId | aId | ) | [protected, inline] |
SetPendingConditions(TBool)
| IMPORT_C void | SetPendingConditions | ( | TBool | aPendingConditions | ) | |
Sets the pending conditions flag.
SetPendingDelete(TBool)
| void | SetPendingDelete | ( | TBool | aPendingDelete | ) | [inline] |
SetPriority(TMsvPriority)
Sets the message priority.
SetReadOnly(TBool)
| void | SetReadOnly | ( | TBool | aReadOnly | ) | [inline] |
Parameters
| TBool aReadOnly | Value for the read-only flag |
SetScheduled(TBool)
| void | SetScheduled | ( | TBool | aScheduled | ) | [inline] |
Parameters
| TBool aScheduled | Value for the scheduled flag. |
SetSendingState(TUint)
| void | SetSendingState | ( | TUint | aSendingState | ) | [inline] |
Parameters
| TUint aSendingState | The sending state. This must be a value between 0x00 and KMsvSendStateMax. |
SetStandardFolder(TBool)
| void | SetStandardFolder | ( | TBool | aStanardFolder | ) | [inline] |
SetUnread(TBool)
| void | SetUnread | ( | TBool | aUnread | ) | [inline] |
Sets the message unread flag.
Parameters
| TBool aUnread | Value for the message unread flag |
SetVisible(TBool)
| void | SetVisible | ( | TBool | aVisble | ) | [inline] |
Sets the entry visible flag.
Parameters
| TBool aVisble | Value for the entry visible flag |
SetVisibleFolderFlag(TBool)
| void | SetVisibleFolderFlag | ( | TBool | aReadOnly | ) | [inline] |
Sets the flag for the TMsvEntry's visible folder(CMsvCacheVisibleFolder), if the entry is visible while creation.
StandardFolder()
|
TBool
| StandardFolder | ( | ) | const [inline] |
Gets the value of the standard folder flag.
TemporaryFlags()
|
TUint
| TemporaryFlags | ( | ) | const [protected, inline] |
Unread()
|
TBool
| Unread | ( | ) | const [inline] |
Gets the value of the message unread flag.
Visible()
|
TBool
| Visible | ( | ) | const [inline] |
Gets the value of the entry visible flag.
VisibleFolderFlag()
|
TBool
| VisibleFolderFlag | ( | ) | const [inline] |
Gets the value of the TMsvEntry's visible folder flag.
operator=(const TMsvEntry &)
Overloaded assignment operator.
This acts similarly to the copy constructor: i.e. it makes a simple copy of entry, so the TPtrC entry description and details members will point to the same descriptor data in the original and new objects.
Parameters
| const TMsvEntry & aEntry | The entry from which to assign |
operator==(const TMsvEntry &)
Overloaded equality operator.
This tests whether the fields of the specified entry are equal to those of this object. The contents, rather than pointer values, of the TPtrC members are compared.
Parameters
| const TMsvEntry & aEntry | The entry with which to compare |
Member Data Documentation
TInt32
iMtmData1
MTM data 1: this can be used for any purpose by an MTM. This member must only be accessed through the predefined set and get functions. If you must write data to a bit that has no meaning in the predefined derived classes then you must derive your own class from TMsvEntry.
TInt32
iMtmData2
MTM data 2: this can be used for any purpose by an MTM. This member must only be accessed through the predefined set and get functions. If you must write data to a bit that has no meaning in the predefined derived classes then you must derive your own class from TMsvEntry.
TInt32
iMtmData3
MTM data 3: this can be used for any purpose by an MTM. This member must only be accessed through the predefined set and get functions. If you must write data to a bit that has no meaning in the predefined derived classes then you must derive your own class from TMsvEntry.
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.