Class TMsvEntry

class TMsvEntry;

Description

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(const TMsvEntry &) (or CMsvServerEntry::ChangeEntry(const TMsvEntry &,TSecureId)).

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.

Members

Defined in TMsvEntry:

• Attachment()constGets the value of the attachment flag.
• Complete()constGets the value of the message complete flag.
• Connected()constGets the value of the remote server connection flag.
• DecPcSyncCount()Decrements the PC synchronisation field.
• DeleteProtected()constreturns the delete protected state
• Deleted()constGets the value of the deleted flag.
• ExternalizeL(RWriteStream &)constWrites the object into the stream specified.
• Failed()constGets the value of the message send failed flag.
• Forwarded()constreturns the forwarded state
• Id()constGets the value of the entry ID.
• InPreparation()constGets the value of the in preparation flag.
• IncPcSyncCount()Increments the PC synchronisation field.
• InternalizeL(RReadStream &)Reads an externalised object from the specified stream.
• LocallyDeleted()constreturns the locally deleted state
• MtmData1()constGets the integer value of iMtmData1
• MtmData2()constGets the integer value of iMtmData2
• MtmData3()constGets the integer value of iMtmData3
• MultipleRecipients()constGets the value of the multiple recipients flag.
• New()constGets the value of the new message flag.
• OffPeak()constGets the off-peak flag.
• Operation()constGets the value of the disconnected operation queued flag.
• Owner()constGets the value of the owner flag.
• Parent()constGets the value of the parent ID.
• PcSyncCount()constGets the value of the PC synchronisation field.
• PendingConditions()constGets the pending conditions flag.
• PendingDelete()const
• PermanentDataUnchanged(const TMsvEntry &)constCompares if the flag settings in two index entries are the same. The Connected a...
• PersistedFlags()const
• Priority()constGets the value of the message priority field.
• ReadOnly()constGets the value of the read-only flag.
• Scheduled()constGets the scheduled flag.
• SendingState()constGets the sending state.
• SetAttachment(TBool)Sets the attachment flag.
• SetComplete(TBool)Sets the message complete flag.
• SetConnected(TBool)Sets the remote server connection flag.
• SetDeleteProtected(TBool)This method sets bit 24 of iMtmData1, if you are using this bit elsewhere don't ...
• SetDeleted(TBool)
• SetFailed(TBool)Sets the message send failed flag.
• SetForwarded(TBool)This method sets bit 31 of iMtmData1, if you are using this bit elsewhere don't ...
• SetId(TMsvId)
• SetInPreparation(TBool)Sets the in-preparation flag.
• SetLocallyDeleted(TBool)This method sets bit 32 of iMtmData1, if you are using this bit elsewhere don't ...
• SetMultipleRecipients(TBool)Sets the multiple recipients flag.
• SetNew(TBool)Sets the message new flag.
• SetOffPeak(TBool)Sets the off-peak flag.
• SetOperation(TBool)Sets the disconnected operation queued flag.
• SetOwner(TBool)
• SetParent(TMsvId)
• SetPendingConditions(TBool)Sets the pending conditions flag.
• SetPendingDelete(TBool)
• SetPriority(TMsvPriority)Sets the message priority.
• SetReadOnly(TBool)Sets the read-only flag.
• SetScheduled(TBool)Sets the scheduled flag.
• SetSendingState(TUint)Sets the sending state.
• SetStandardFolder(TBool)
• SetUnread(TBool)Sets the message unread flag.
• SetVisible(TBool)Sets the entry visible flag.
• StandardFolder()constGets the value of the standard folder flag.
• TMsvEntry()Default constructor.
• TMsvEntry(const TMsvEntry &)Copy constructor.
• TemporaryFlags()const
• Unread()constGets the value of the message unread flag.
• Visible()constGets the value of the entry visible flag.
• iBioTypeBIO message type
• iDate Time
• iDescriptionDescription
• iDetailsDetails
• iErrorError
• iMtmMTM
• iMtmData1MTM data 1: this can be used for any purpose by an MTM. This member must only be...
• iMtmData2MTM data 2: this can be used for any purpose by an MTM. This member must only be...
• iMtmData3MTM data 3: this can be used for any purpose by an MTM. This member must only be...
• iRelatedIdRelated folder ID.
• iServiceIdService ID.
• iSizeSize
• iTypeEntry type
• operator=(const TMsvEntry &)Overloaded assignment operator.
• operator==(const TMsvEntry &)constOverloaded equality operator.

IMPORT_C TMsvEntry();

Description

Default constructor.

Initialises the new object to null values: 0 for integer values, KMsvNullIndexEntryId for IDs, and KUidMsvNullEntry for UIDs.

IMPORT_C TMsvEntry(const TMsvEntry &aEntry);

Description

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.

Parameters

IMPORT_C TMsvEntry& operator=(const TMsvEntry &aEntry);

Description

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

Return value

IMPORT_C TBool operator==(const TMsvEntry &aEntry) const;

Description

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

Return value

IMPORT_C TBool PermanentDataUnchanged(const TMsvEntry &aEntry) const;

Description

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

Return value

IMPORT_C TMsvPriority Priority() const;

Description

Gets the value of the message priority field.

Return value

IMPORT_C void SetPriority(TMsvPriority aPriority);

Description

Sets the message priority.

Parameters

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Reads an externalised object from the specified stream.

Parameters

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Writes the object into the stream specified.

Parameters

inline TMsvId Id() const;

Description

Gets the value of the entry ID.

Return value

inline TMsvId Parent() const;

Description

Gets the value of the parent ID.

Return value

inline TBool Owner() const;

Description

Gets the value of the owner flag.

Return value

inline TBool Deleted() const;

Description

Gets the value of the deleted flag.

Return value

inline TBool Complete() const;

Description

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.

Return value

inline void SetComplete(TBool aComplete);

Description

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

inline TBool New() const;

Description

Gets the value of the new message flag.

Return value

inline void SetNew(TBool aNew);

Description

Sets the message new flag.

Parameters

inline TBool Unread() const;

Description

Gets the value of the message unread flag.

Return value

inline void SetUnread(TBool aUnread);

Description

Sets the message unread flag.

Parameters

inline TBool Failed() const;

Description

Gets the value of the message send failed flag.

Return value

inline void SetFailed(TBool aFailed);

Description

Sets the message send failed flag.

Parameters

inline TBool Operation() const;

Description

Gets the value of the disconnected operation queued flag.

Return value

inline void SetOperation(TBool aOperation);

Description

Sets the disconnected operation queued flag.

Parameters

inline TBool Visible() const;

Description

Gets the value of the entry visible flag.

Return value

inline void SetVisible(TBool aVisble);

Description

Sets the entry visible flag.

Parameters

inline TBool MultipleRecipients() const;

Description

Gets the value of the multiple recipients flag.

Return value

inline void SetMultipleRecipients(TBool aMultipleRecipient);

Description

Sets the multiple recipients flag.

Parameters

inline TBool ReadOnly() const;

Description

Gets the value of the read-only flag.

Return value

inline void SetReadOnly(TBool aReadOnly);

Description

Sets the read-only flag.

Parameters

inline TBool StandardFolder() const;

Description

Gets the value of the standard folder flag.

Return value

inline void SetStandardFolder(TBool aStanardFolder);

Description

Parameters

inline TBool Attachment() const;

Description

Gets the value of the attachment flag.

Return value

inline void SetAttachment(TBool aAttachmentFlag);

Description

Sets the attachment flag.

Parameters

inline TBool Connected() const;

Description

Gets the value of the remote server connection flag.

Return value

inline void SetConnected(TBool aConnected);

Description

Sets the remote server connection flag.

Parameters

inline TBool InPreparation() const;

Description

Gets the value of the in preparation flag.

Return value

inline void SetInPreparation(TBool aInPreparation);

Description

Sets the in-preparation flag.

Parameters

inline TInt PcSyncCount() const;

Description

Gets the value of the PC synchronisation field.

Return value

inline void DecPcSyncCount();

Description

Decrements the PC synchronisation field.

inline void IncPcSyncCount();

Description

Increments the PC synchronisation field.

inline TBool OffPeak() const;

Description

Gets the off-peak flag.

Return value

inline void SetOffPeak(TBool aOffPeak);

Description

Sets the off-peak flag.

Parameters

inline TBool Scheduled() const;

Description

Gets the scheduled flag.

Return value

inline void SetScheduled(TBool aScheduled);

Description

Sets the scheduled flag.

Parameters

inline TUint SendingState() const;

Description

Gets the sending state.

Return value

inline void SetSendingState(TUint aSendingState);

Description

Sets the sending state.

Parameters

inline TBool PendingDelete() const;

Description

Return value

inline void SetPendingDelete(TBool aPendingDelete);

Description

Parameters

inline void SetDeleteProtected(TBool aDeleteProtected);

Description

This method sets bit 24 of iMtmData1, if you are using this bit elsewhere don't call this method.

Parameters

inline TBool DeleteProtected() const;

Description

returns the delete protected state

Return value

inline void SetForwarded(TBool aForwarded);

Description

This method sets bit 31 of iMtmData1, if you are using this bit elsewhere don't call this method.

Parameters

inline TBool Forwarded() const;

Description

returns the forwarded state

Return value

inline void SetLocallyDeleted(TBool aLocallyDeleted);

Description

This method sets bit 32 of iMtmData1, if you are using this bit elsewhere don't call this method.

Parameters

inline TBool LocallyDeleted() const;

Description

returns the locally deleted state

Return value

IMPORT_C TBool PendingConditions() const;

Description

Gets the pending conditions flag.

Return value

IMPORT_C void SetPendingConditions(TBool aPendingConditions);

Description

Sets the pending conditions flag.

Parameters

IMPORT_C TInt32 MtmData1() const;

Description

Gets the integer value of iMtmData1

Return value

IMPORT_C TInt32 MtmData2() const;

Description

Gets the integer value of iMtmData2

Return value

IMPORT_C TInt32 MtmData3() const;

Description

Gets the integer value of iMtmData3

Return value

protected: inline void SetId(TMsvId aId);

Description

Parameters

protected: inline void SetParent(TMsvId aId);

Description

Parameters

protected: inline void SetOwner(TBool aAttachment);

Description

Parameters

protected: inline void SetDeleted(TBool aDeletedFlag);

Description

Parameters

protected: inline TUint PersistedFlags() const;

Description

Return value

protected: inline TUint TemporaryFlags() const;

Description

Return value

TMsvId iServiceId;

Description

Service ID.

TMsvId iRelatedId;

Description

Related folder ID.

TUid iType;

Description

Entry type

TUid iMtm;

Description

MTM

TTime iDate;

Description

Time

TInt32 iSize;

Description

Size

TInt32 iError;

Description

Error

TInt32 iBioType;

Description

BIO message type

TInt32 iMtmData1;

Description

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;

Description

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;

Description

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.

TPtrC iDescription;

Description

Description

TPtrC iDetails;

Description

Details