TMsvEntry Class Reference

#include <mw/msvstd.h>

Link against: msgs_autoshutdown.lib

class TMsvEntry
Public Attributes
TInt32 iBioType
TTime iDate
TPtrC iDescription
TPtrC iDetails
TInt32 iError
TUid iMtm
TInt32 iMtmData1
TInt32 iMtmData2
TInt32 iMtmData3
TMsvId iRelatedId
TMsvId iServiceId
TInt32 iSize
TUid iType
Public Member Functions
TMsvEntry()
TMsvEntry(const TMsvEntry &)
TBool Attachment()
TBool Complete()
TBool Connected()
voidDecPcSyncCount()
TBool DeleteProtected()
TBool Deleted()
IMPORT_C voidExternalizeL(RWriteStream &)
TBool Failed()
TBool Forwarded()
TMsvId Id()
TBool InPreparation()
voidIncPcSyncCount()
IMPORT_C voidInternalizeL(RReadStream &)
TBool LocallyDeleted()
IMPORT_C TInt32MtmData1()
IMPORT_C TInt32MtmData2()
IMPORT_C TInt32MtmData3()
TBool MultipleRecipients()
TBool New()
TBool OffPeak()
TBool Operation()
TBool Owner()
TMsvId Parent()
TInt PcSyncCount()
IMPORT_C TBoolPendingConditions()
TBool PendingDelete()
IMPORT_C TBoolPermanentDataUnchanged(const TMsvEntry &)
IMPORT_C TMsvPriorityPriority()
TBool ReadOnly()
TBool Scheduled()
TUint SendingState()
voidSetAttachment(TBool)
voidSetComplete(TBool)
voidSetConnected(TBool)
voidSetDeleteProtected(TBool)
voidSetFailed(TBool)
voidSetForwarded(TBool)
voidSetInPreparation(TBool)
voidSetLocallyDeleted(TBool)
IMPORT_C voidSetMtmData1(TInt32)
IMPORT_C voidSetMtmData2(TInt32)
IMPORT_C voidSetMtmData3(TInt32)
voidSetMultipleRecipients(TBool)
voidSetNew(TBool)
voidSetOffPeak(TBool)
voidSetOperation(TBool)
IMPORT_C voidSetPendingConditions(TBool)
voidSetPendingDelete(TBool)
IMPORT_C voidSetPriority(TMsvPriority)
voidSetReadOnly(TBool)
voidSetScheduled(TBool)
voidSetSendingState(TUint)
voidSetStandardFolder(TBool)
voidSetUnread(TBool)
voidSetVisible(TBool)
voidSetVisibleFolderFlag(TBool)
TBool StandardFolder()
TBool Unread()
TBool Visible()
TBool VisibleFolderFlag()
IMPORT_C TMsvEntry &operator=(const TMsvEntry &)
IMPORT_C TBooloperator==(const TMsvEntry &)
Protected Member Functions
TUint PersistedFlags()
voidSetDeleted(TBool)
voidSetId(TMsvId)
voidSetOwner(TBool)
voidSetParent(TMsvId)
TUint TemporaryFlags()

Detailed 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.

Member Attribute Documentation

iBioType

TInt32 iBioType

BIO message type

iDate

TTime iDate

Time

iDescription

TPtrC iDescription

Description

iDetails

TPtrC iDetails

Details

iError

TInt32 iError

Error

iMtm

TUid iMtm

MTM

iMtmData1

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.

iMtmData2

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.

iMtmData3

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.

iRelatedId

TMsvId iRelatedId

Related folder ID.

iServiceId

TMsvId iServiceId

Service ID.

iSize

TInt32 iSize

Size

iType

TUid iType

Entry type

Constructor & Destructor Documentation

TMsvEntry ( )

IMPORT_CTMsvEntry()

Default constructor.

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

TMsvEntry ( const TMsvEntry & )

IMPORT_CTMsvEntry(const TMsvEntry &aEntry)

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
aEntryThe entry to copy

Member Function Documentation

Attachment ( )

TBool Attachment()const [inline]

Gets the value of the attachment flag.

Return Value
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.

Return Value
The value of the message complete flag

Connected ( )

TBool Connected()const [inline]

Gets the value of the remote server connection flag.

Return Value
The value of the remote server connection flag

DecPcSyncCount ( )

voidDecPcSyncCount()[inline]

Decrements the PC synchronisation field.

DeleteProtected ( )

TBool DeleteProtected()const [inline]

Deleted ( )

TBool Deleted()const [inline]

Gets the value of the deleted flag.

Return Value
The value of the deleted flag

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Writes the object into the stream specified.

Parameters
aStreamStream to which to write

Failed ( )

TBool Failed()const [inline]

Gets the value of the message send failed flag.

Return Value
The value of the message send failed flag

Forwarded ( )

TBool Forwarded()const [inline]

Id ( )

TMsvId Id()const [inline]

Gets the value of the entry ID.

Return Value
The value of the entry ID

InPreparation ( )

TBool InPreparation()const [inline]

Gets the value of the in preparation flag.

Return Value
The value of the in preparation flag

IncPcSyncCount ( )

voidIncPcSyncCount()[inline]

Increments the PC synchronisation field.

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(RReadStream &aStream)

Reads an externalised object from the specified stream.

Parameters
aStreamStream from which to read

LocallyDeleted ( )

TBool LocallyDeleted()const [inline]

MtmData1 ( )

IMPORT_C TInt32MtmData1()const

Gets the integer value of iMtmData1

Return Value
the integer value of iMtmData1

MtmData2 ( )

IMPORT_C TInt32MtmData2()const

Gets the integer value of iMtmData2

Return Value
the integer value of iMtmData2

MtmData3 ( )

IMPORT_C TInt32MtmData3()const

Gets the integer value of iMtmData3

Return Value
the integer value of iMtmData3

MultipleRecipients ( )

TBool MultipleRecipients()const [inline]

Gets the value of the multiple recipients flag.

Return Value
The value of the multiple recipients flag

New ( )

TBool New()const [inline]

Gets the value of the new message flag.

Return Value
The value of the new message flag

OffPeak ( )

TBool OffPeak()const [inline]

Gets the off-peak flag.

Return Value
The value of the off-peak flag

Operation ( )

TBool Operation()const [inline]

Gets the value of the disconnected operation queued flag.

Return Value
The value of the disconnected operation queued flag

Owner ( )

TBool Owner()const [inline]

Gets the value of the owner flag.

Return Value
The value of the owner flag

Parent ( )

TMsvId Parent()const [inline]

Gets the value of the parent ID.

Return Value
The value of the parent ID

PcSyncCount ( )

TInt PcSyncCount()const [inline]

Gets the value of the PC synchronisation field.

Return Value
The value of the PC synchronisation field

PendingConditions ( )

IMPORT_C TBoolPendingConditions()const

Gets the pending conditions flag.

Return Value
The value for the pending conditions flag.

PendingDelete ( )

TBool PendingDelete()const [inline]

PermanentDataUnchanged ( const TMsvEntry & )

IMPORT_C TBoolPermanentDataUnchanged(const TMsvEntry &aEntry)const

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
aEntryIndex entry to compare against
Return Value
True if the flags settings are equal, otherwise false

PersistedFlags ( )

TUint PersistedFlags()const [protected, inline]

Priority ( )

IMPORT_C TMsvPriorityPriority()const

Gets the value of the message priority field.

Return Value
The value of the message priority field

ReadOnly ( )

TBool ReadOnly()const [inline]

Gets the value of the read-only flag.

Return Value
The value of the read-only flag

Scheduled ( )

TBool Scheduled()const [inline]

Gets the scheduled flag.

Return Value
The value of the scheduled flag

SendingState ( )

TUint SendingState()const [inline]

Gets the sending state.

Return Value
The sending state

SetAttachment ( TBool )

voidSetAttachment(TBoolaAttachmentFlag)[inline]

Sets the attachment flag.

Parameters
aAttachmentFlagValue for the attachment flag

SetComplete ( TBool )

voidSetComplete(TBoolaComplete)[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
aCompleteValue for the message complete flag

SetConnected ( TBool )

voidSetConnected(TBoolaConnected)[inline]

Sets the remote server connection flag.

Parameters
aConnectedValue for the remote server connection flag

SetDeleteProtected ( TBool )

voidSetDeleteProtected(TBoolaDeleteProtected)[inline]

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

SetDeleted ( TBool )

voidSetDeleted(TBoolaDeletedFlag)[protected, inline]

SetFailed ( TBool )

voidSetFailed(TBoolaFailed)[inline]

Sets the message send failed flag.

Parameters
aFailedValue for the message send failed flag

SetForwarded ( TBool )

voidSetForwarded(TBoolaForwarded)[inline]

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

SetId ( TMsvId )

voidSetId(TMsvIdaId)[protected, inline]

SetInPreparation ( TBool )

voidSetInPreparation(TBoolaInPreparation)[inline]

Sets the in-preparation flag.

Parameters
aInPreparationValue for the in-preparation flag

SetLocallyDeleted ( TBool )

voidSetLocallyDeleted(TBoolaLocallyDeleted)[inline]

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

SetMtmData1 ( TInt32 )

IMPORT_C voidSetMtmData1(TInt32aMtmData)

Sets the value of iMtmData1. This API should only be called by Symbian Software Ltd.

Parameters
aMtmDataValue of the data to be stored in iMtmData1

SetMtmData2 ( TInt32 )

IMPORT_C voidSetMtmData2(TInt32aMtmData)

Sets the value of iMtmData2. This API should only be called by Symbian Software Ltd.

Parameters
aMtmDataValue of the data to be stored in iMtmData2

SetMtmData3 ( TInt32 )

IMPORT_C voidSetMtmData3(TInt32aMtmData)

Sets the value of iMtmData3. This API should only be called by Symbian Software Ltd.

Parameters
aMtmDataValue of the data to be stored in iMtmData3

SetMultipleRecipients ( TBool )

voidSetMultipleRecipients(TBoolaMultipleRecipient)[inline]

Sets the multiple recipients flag.

Parameters
aMultipleRecipientValue for the multiple recipients flag

SetNew ( TBool )

voidSetNew(TBoolaNew)[inline]

Sets the message new flag.

Parameters
aNewValue for the message new flag

SetOffPeak ( TBool )

voidSetOffPeak(TBoolaOffPeak)[inline]

Sets the off-peak flag.

Parameters
aOffPeakValue for off-peak flag.

SetOperation ( TBool )

voidSetOperation(TBoolaOperation)[inline]

Sets the disconnected operation queued flag.

Parameters
aOperationValue for the disconnected operation queued flag

SetOwner ( TBool )

voidSetOwner(TBoolaAttachment)[protected, inline]

SetParent ( TMsvId )

voidSetParent(TMsvIdaId)[protected, inline]

SetPendingConditions ( TBool )

IMPORT_C voidSetPendingConditions(TBoolaPendingConditions)

Sets the pending conditions flag.

SetPendingDelete ( TBool )

voidSetPendingDelete(TBoolaPendingDelete)[inline]

SetPriority ( TMsvPriority )

IMPORT_C voidSetPriority(TMsvPriorityaPriority)

Sets the message priority.

Parameters
aPriorityValue for the message priority

SetReadOnly ( TBool )

voidSetReadOnly(TBoolaReadOnly)[inline]

Sets the read-only flag.

Parameters
aReadOnlyValue for the read-only flag

SetScheduled ( TBool )

voidSetScheduled(TBoolaScheduled)[inline]

Sets the scheduled flag.

Parameters
aScheduledValue for the scheduled flag.

SetSendingState ( TUint )

voidSetSendingState(TUintaSendingState)[inline]

Sets the sending state.

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

SetStandardFolder ( TBool )

voidSetStandardFolder(TBoolaStanardFolder)[inline]

SetUnread ( TBool )

voidSetUnread(TBoolaUnread)[inline]

Sets the message unread flag.

Parameters
aUnreadValue for the message unread flag

SetVisible ( TBool )

voidSetVisible(TBoolaVisble)[inline]

Sets the entry visible flag.

Parameters
aVisbleValue for the entry visible flag

SetVisibleFolderFlag ( TBool )

voidSetVisibleFolderFlag(TBoolaReadOnly)[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.

Return Value
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.

Return Value
The value of the message unread flag

Visible ( )

TBool Visible()const [inline]

Gets the value of the entry visible flag.

Return Value
The value of the entry visible flag

VisibleFolderFlag ( )

TBool VisibleFolderFlag()const [inline]

Gets the value of the TMsvEntry's visible folder flag.

Return Value
The value of the entry visible flag

operator= ( const TMsvEntry & )

IMPORT_C TMsvEntry &operator=(const TMsvEntry &aEntry)

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
aEntryThe entry from which to assign
Return Value
Object after assignment

operator== ( const TMsvEntry & )

IMPORT_C TBooloperator==(const TMsvEntry &aEntry)const

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
aEntryThe entry with which to compare
Return Value
ETrue if the entries are equal, else EFalse
© Nokia 2005.