Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: MSVSTD.H
Link against: msgs.lib
Link against: msgs_autoshutdown.lib

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() (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.

Members

Defined in TMsvEntry:
Attachment(), Complete(), Connected(), DecPcSyncCount(), DeleteProtected(), Deleted(), ExternalizeL(), Failed(), Forwarded(), Id(), InPreparation(), IncPcSyncCount(), InternalizeL(), LocallyDeleted(), MtmData1(), MtmData2(), MtmData3(), MultipleRecipients(), New(), OffPeak(), Operation(), Owner(), Parent(), PcSyncCount(), PendingConditions(), PendingDelete(), PermanentDataUnchanged(), PersistedFlags(), Priority(), ReadOnly(), Scheduled(), SendingState(), SetAttachment(), SetComplete(), SetConnected(), SetDeleteProtected(), SetDeleted(), SetFailed(), SetForwarded(), SetId(), SetInPreparation(), SetLocallyDeleted(), SetMultipleRecipients(), SetNew(), SetOffPeak(), SetOperation(), SetOwner(), SetParent(), SetPendingConditions(), SetPendingDelete(), SetPriority(), SetReadOnly(), SetScheduled(), SetSendingState(), SetStandardFolder(), SetUnread(), SetVisible(), StandardFolder(), TMsvEntry(), TMsvEntry(), TemporaryFlags(), Unread(), Visible(), iBioType, iDate, iDescription, iDetails, iError, iMtm, iMtmData1, iMtmData2, iMtmData3, iRelatedId, iServiceId, iSize, iType, operator=(), operator==()


Construction and destruction


TMsvEntry()

IMPORT_C TMsvEntry();

Description

Default constructor.

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


TMsvEntry()

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

const TMsvEntry &aEntry

The entry to copy

[Top]


Member functions


operator=()

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

const TMsvEntry &aEntry

The entry from which to assign

Return value

TMsvEntry &

Object after assignment


operator==()

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

const TMsvEntry &aEntry

The entry with which to compare

Return value

TBool

ETrue if the entries are equal, else EFalse


PermanentDataUnchanged()

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

const TMsvEntry &aEntry

Index entry to compare against

Return value

TBool

True if the flags settings are equal, otherwise false


Priority()

IMPORT_C TMsvPriority Priority() const;

Description

Gets the value of the message priority field.

Return value

TMsvPriority

The value of the message priority field


SetPriority()

IMPORT_C void SetPriority(TMsvPriority aPriority);

Description

Sets the message priority.

Parameters

TMsvPriority aPriority

Value for the message priority


InternalizeL()

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Reads an externalised object from the specified stream.

Parameters

RReadStream &aStream

Stream from which to read


ExternalizeL()

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Writes the object into the stream specified.

Parameters

RWriteStream &aStream

Stream to which to write


Id()

inline TMsvId Id() const;

Description

Gets the value of the entry ID.

Return value

TMsvId

The value of the entry ID


Parent()

inline TMsvId Parent() const;

Description

Gets the value of the parent ID.

Return value

TMsvId

The value of the parent ID


Owner()

inline TBool Owner() const;

Description

Gets the value of the owner flag.

Return value

TBool

The value of the owner flag


Deleted()

inline TBool Deleted() const;

Description

Gets the value of the deleted flag.

Return value

TBool

The value of the deleted flag


Complete()

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

TBool

The value of the message complete flag


SetComplete()

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

TBool aComplete

Value for the message complete flag


New()

inline TBool New() const;

Description

Gets the value of the new message flag.

Return value

TBool

The value of the new message flag


SetNew()

inline void SetNew(TBool aNew);

Description

Sets the message new flag.

Parameters

TBool aNew

Value for the message new flag


Unread()

inline TBool Unread() const;

Description

Gets the value of the message unread flag.

Return value

TBool

The value of the message unread flag


SetUnread()

inline void SetUnread(TBool aUnread);

Description

Sets the message unread flag.

Parameters

TBool aUnread

Value for the message unread flag


Failed()

inline TBool Failed() const;

Description

Gets the value of the message send failed flag.

Return value

TBool

The value of the message send failed flag


SetFailed()

inline void SetFailed(TBool aFailed);

Description

Sets the message send failed flag.

Parameters

TBool aFailed

Value for the message send failed flag


Operation()

inline TBool Operation() const;

Description

Gets the value of the disconnected operation queued flag.

Return value

TBool

The value of the disconnected operation queued flag


SetOperation()

inline void SetOperation(TBool aOperation);

Description

Sets the disconnected operation queued flag.

Parameters

TBool aOperation

Value for the disconnected operation queued flag


Visible()

inline TBool Visible() const;

Description

Gets the value of the entry visible flag.

Return value

TBool

The value of the entry visible flag


SetVisible()

inline void SetVisible(TBool aVisble);

Description

Sets the entry visible flag.

Parameters

TBool aVisble

Value for the entry visible flag


MultipleRecipients()

inline TBool MultipleRecipients() const;

Description

Gets the value of the multiple recipients flag.

Return value

TBool

The value of the multiple recipients flag


SetMultipleRecipients()

inline void SetMultipleRecipients(TBool aMultipleRecipient);

Description

Sets the multiple recipients flag.

Parameters

TBool aMultipleRecipient

Value for the multiple recipients flag


ReadOnly()

inline TBool ReadOnly() const;

Description

Gets the value of the read-only flag.

Return value

TBool

The value of the read-only flag


SetReadOnly()

inline void SetReadOnly(TBool aReadOnly);

Description

Sets the read-only flag.

Parameters

TBool aReadOnly

Value for the read-only flag


StandardFolder()

inline TBool StandardFolder() const;

Description

Gets the value of the standard folder flag.

Return value

TBool

The value of the standard folder flag


SetStandardFolder()

inline void SetStandardFolder(TBool aStanardFolder);

Description

Parameters

TBool aStanardFolder


Attachment()

inline TBool Attachment() const;

Description

Gets the value of the attachment flag.

Return value

TBool

The value of the attachment flag


SetAttachment()

inline void SetAttachment(TBool aAttachmentFlag);

Description

Sets the attachment flag.

Parameters

TBool aAttachmentFlag

Value for the attachment flag


Connected()

inline TBool Connected() const;

Description

Gets the value of the remote server connection flag.

Return value

TBool

The value of the remote server connection flag


SetConnected()

inline void SetConnected(TBool aConnected);

Description

Sets the remote server connection flag.

Parameters

TBool aConnected

Value for the remote server connection flag


InPreparation()

inline TBool InPreparation() const;

Description

Gets the value of the in preparation flag.

Return value

TBool

The value of the in preparation flag


SetInPreparation()

inline void SetInPreparation(TBool aInPreparation);

Description

Sets the in-preparation flag.

Parameters

TBool aInPreparation

Value for the in-preparation flag


PcSyncCount()

inline TInt PcSyncCount() const;

Description

Gets the value of the PC synchronisation field.

Return value

TInt

The value of the PC synchronisation field


DecPcSyncCount()

inline void DecPcSyncCount();

Description

Decrements the PC synchronisation field.


IncPcSyncCount()

inline void IncPcSyncCount();

Description

Increments the PC synchronisation field.


OffPeak()

inline TBool OffPeak() const;

Description

Gets the off-peak flag.

Return value

TBool

The value of the off-peak flag


SetOffPeak()

inline void SetOffPeak(TBool aOffPeak);

Description

Sets the off-peak flag.

Parameters

TBool aOffPeak

Value for off-peak flag.


Scheduled()

inline TBool Scheduled() const;

Description

Gets the scheduled flag.

Return value

TBool

The value of the scheduled flag


SetScheduled()

inline void SetScheduled(TBool aScheduled);

Description

Sets the scheduled flag.

Parameters

TBool aScheduled

Value for the scheduled flag.


SendingState()

inline TUint SendingState() const;

Description

Gets the sending state.

Return value

TUint

The sending state


SetSendingState()

inline void SetSendingState(TUint aSendingState);

Description

Sets the sending state.

Parameters

TUint aSendingState

The sending state. This must be a value between 0x00 and KMsvSendStateMax.


PendingDelete()

inline TBool PendingDelete() const;

Description

Return value

TBool


SetPendingDelete()

inline void SetPendingDelete(TBool aPendingDelete);

Description

Parameters

TBool aPendingDelete


SetDeleteProtected()

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

TBool aDeleteProtected


DeleteProtected()

inline TBool DeleteProtected() const;

Description

returns the delete protected state

Return value

TBool


SetForwarded()

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

TBool aForwarded


Forwarded()

inline TBool Forwarded() const;

Description

returns the forwarded state

Return value

TBool


SetLocallyDeleted()

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

TBool aLocallyDeleted


LocallyDeleted()

inline TBool LocallyDeleted() const;

Description

returns the locally deleted state

Return value

TBool


PendingConditions()

IMPORT_C TBool PendingConditions() const;

Description

Gets the pending conditions flag.

Return value

TBool

The value for the pending conditions flag.


SetPendingConditions()

IMPORT_C void SetPendingConditions(TBool aPendingConditions);

Description

Sets the pending conditions flag.

Parameters

TBool aPendingConditions


MtmData1()

IMPORT_C TInt32 MtmData1() const;

Description

Gets the integer value of iMtmData1

Return value

TInt32

the integer value of iMtmData1


MtmData2()

IMPORT_C TInt32 MtmData2() const;

Description

Gets the integer value of iMtmData2

Return value

TInt32

the integer value of iMtmData2


MtmData3()

IMPORT_C TInt32 MtmData3() const;

Description

Gets the integer value of iMtmData3

Return value

TInt32

the integer value of iMtmData3


SetId()

protected: inline void SetId(TMsvId aId);

Description

Parameters

TMsvId aId


SetParent()

protected: inline void SetParent(TMsvId aId);

Description

Parameters

TMsvId aId


SetOwner()

protected: inline void SetOwner(TBool aAttachment);

Description

Parameters

TBool aAttachment


SetDeleted()

protected: inline void SetDeleted(TBool aDeletedFlag);

Description

Parameters

TBool aDeletedFlag


PersistedFlags()

protected: inline TUint PersistedFlags() const;

Description

Return value

TUint


TemporaryFlags()

protected: inline TUint TemporaryFlags() const;

Description

Return value

TUint

[Top]


Member data


iServiceId

TMsvId iServiceId;

Description

Service ID.


iRelatedId

TMsvId iRelatedId;

Description

Related folder ID.


iType

TUid iType;

Description

Entry type


iMtm

TUid iMtm;

Description

MTM


iDate

TTime iDate;

Description

Time


iSize

TInt32 iSize;

Description

Size


iError

TInt32 iError;

Description

Error


iBioType

TInt32 iBioType;

Description

BIO message type


iMtmData1

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.


iMtmData2

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.


iMtmData3

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.


iDescription

TPtrC iDescription;

Description

Description


iDetails

TPtrC iDetails;

Description

Details