class CMsvEntry : public CBase |
Accesses and acts upon a particular Message Server entry. The current entry that a CMsvEntry object relates is referred to as its context.
It may be helpful to consider CMsvEntry functions in two broad groups. The first provides means to access the various types of storage associated with an entry. The second provides a means to discover and access other entries that the entry owns (its children).
Message client applications, Client-side MTMs, and User Interface MTMs all commonly use CMsvEntry objects. CMsvEntry objects though represent a lower level of access to an entry than that provided by a Client-side MTM or User Interface MTM. In particular, any MTM-specific functionality, such as address lists or subject fields, must be accessed by a message client application through an MTM inteface.
A CMsvEntry object is relatively expensive in RAM usage, as it caches its children, updating them as necessary when notified of changes. They should therefore be created sparingly.
Note that Server-side MTMs do not use this class, but a similar one, CMsvServerEntry.
Private Member Enumerations | |
---|---|
enum | TEntryState { EValid, EInvalidChangingContext, EInvalidDeletedContext, EInvalidOldContext, EInvalidMissingChildren } |
Private Attributes | |
---|---|
CArrayPtrFlat< CMsvClientEntry > * | iEntries |
const TMsvEntry * | iEntryPtr |
CMsvSession & | iMsvSession |
CArrayFixFlat< TUid > * | iMtmList |
TUint32 | iNotifySequence |
TBool | iOberserverAdded |
CArrayPtrFlat< MMsvEntryObserver > * | iObservers |
TMsvSelectionOrdering | iOrdering |
TMsvId | iOwningService |
CMsvEntryArray * | iSortedChildren |
TEntryState | iState |
CMsvStore * | iStore |
CMsvEntry | ( | CMsvSession & | aMsvSession, |
const TMsvSelectionOrdering & | aOrdering | ||
) | [private] |
CMsvSession & aMsvSession | |
const TMsvSelectionOrdering & aOrdering |
IMPORT_C void | AddObserverL | ( | MMsvEntryObserver & | aObserver | ) |
MMsvEntryObserver & aObserver |
TBool | AreChildren | ( | const CMsvEntrySelection & | aSelection | ) | const [private] |
const CMsvEntrySelection & aSelection |
IMPORT_C void | ChangeAttributesL | ( | const CMsvEntrySelection & | aSelection, |
TUint | aSetAttributes, | |||
TUint | aClearAttributes | |||
) |
const CMsvEntrySelection & aSelection | |
TUint aSetAttributes | |
TUint aClearAttributes |
IMPORT_C void | ChangeL | ( | const TMsvEntry & | aEntry | ) |
const TMsvEntry & aEntry |
IMPORT_C void | ChangeL | ( | const TMsvEntry & | aEntry, |
TSecureId | aOwnerId | |||
) |
IMPORT_C CMsvOperation * | ChangeL | ( | const TMsvEntry & | aEntry, |
TRequestStatus & | aStatus | |||
) |
const TMsvEntry & aEntry | |
TRequestStatus & aStatus |
IMPORT_C CMsvOperation * | ChangeL | ( | const TMsvEntry & | aEntry, |
TSecureId | aOwnerId, | |||
TRequestStatus & | aStatus | |||
) |
const TMsvEntry & aEntry | |
TSecureId aOwnerId | |
TRequestStatus & aStatus |
void | CheckDeletedGrandchildrenL | ( | TMsvId | aId | ) | [private] |
TMsvId aId |
void | CheckIfContextMovedL | ( | const CMsvEntrySelection & | aSelection | ) | [private] |
const CMsvEntrySelection & aSelection |
void | ChildrenChangedL | ( | const CMsvEntrySelection & | aSelection | ) | [private] |
const CMsvEntrySelection & aSelection |
IMPORT_C CMsvEntrySelection * | ChildrenWithMtmL | ( | TUid | aMtm | ) | const |
TUid aMtm |
IMPORT_C CMsvEntrySelection * | ChildrenWithServiceL | ( | TMsvId | aServiceId | ) | const |
TMsvId aServiceId |
IMPORT_C CMsvEntrySelection * | ChildrenWithTypeL | ( | TUid | aType | ) | const |
TUid aType |
void | ContextChangedL | ( | MMsvEntryObserver::TMsvEntryEvent | aEvent | ) | [private] |
MMsvEntryObserver::TMsvEntryEvent aEvent |
IMPORT_C CMsvOperation * | CopyL | ( | const CMsvEntrySelection & | aSelection, |
TMsvId | aTargetId, | |||
TRequestStatus & | aStatus | |||
) |
const CMsvEntrySelection & aSelection | |
TMsvId aTargetId | |
TRequestStatus & aStatus |
IMPORT_C CMsvOperation * | CopyL | ( | TMsvId | aMsvId, |
TMsvId | aTargetId, | |||
TRequestStatus & | aStatus | |||
) |
TMsvId aMsvId | |
TMsvId aTargetId | |
TRequestStatus & aStatus |
IMPORT_C void | CopyL | ( | const CMsvEntrySelection & | aSelection, |
TMsvId | aTargetId, | |||
TMsvLocalOperationProgress & | aProgress | |||
) |
const CMsvEntrySelection & aSelection | |
TMsvId aTargetId | |
TMsvLocalOperationProgress & aProgress |
TInt | Count | ( | ) | const [inline] |
Gets the number of children of the context.
Count of the child entries for the current context
IMPORT_C CMsvOperation * | CreateL | ( | const TMsvEntry & | aEntry, |
TRequestStatus & | aStatus | |||
) |
const TMsvEntry & aEntry | |
TRequestStatus & aStatus |
IMPORT_C CMsvOperation * | CreateL | ( | const TMsvEntry & | aEntry, |
TSecureId | aOwnerId, | |||
TRequestStatus & | aStatus | |||
) |
const TMsvEntry & aEntry | |
TSecureId aOwnerId | |
TRequestStatus & aStatus |
IMPORT_C CMsvOperation * | DeleteL | ( | const CMsvEntrySelection & | aSelection, |
TRequestStatus & | aStatus | |||
) |
const CMsvEntrySelection & aSelection | |
TRequestStatus & aStatus |
IMPORT_C CMsvOperation * | DeleteL | ( | TMsvId | aMsvId, |
TRequestStatus & | aStatus | |||
) |
TMsvId aMsvId | |
TRequestStatus & aStatus |
IMPORT_C void | DeleteL | ( | const CMsvEntrySelection & | aSelection, |
TMsvLocalOperationProgress & | aProgress | |||
) |
const CMsvEntrySelection & aSelection | |
TMsvLocalOperationProgress & aProgress |
void | DeletedChildrenL | ( | const CMsvEntrySelection & | aSelection | ) | [private] |
const CMsvEntrySelection & aSelection |
CMsvOperation * | DoDeleteL | ( | const CMsvEntrySelection & | aSelection, |
TRequestStatus & | aStatus | |||
) | [private] |
const CMsvEntrySelection & aSelection | |
TRequestStatus & aStatus |
CMsvClientEntry * | DoGetEntryLC | ( | TMsvId | aId, |
TMsvId & | aOwningService | |||
) | [private] |
CMsvEntrySelection * | DoGetNewChildrenL | ( | const CMsvEntrySelection & | aSelection | ) | [private] |
const CMsvEntrySelection & aSelection |
CMsvEntrySelection * | DoMakeSelectionL | ( | TMsvId | aId | ) | [private] |
TMsvId aId |
void | DoSortTypeL | ( | CMsvClientEntry * | aContext | ) | [private] |
CMsvClientEntry * aContext |
const TMsvEntry & | Entry | ( | ) | const [inline] |
Gets the index entry for the context.
Current context's index entry
CMsvEntryArray * | GetNewSortedListL | ( | const TMsvSelectionOrdering & | aOrdering, |
const CArrayFix< TUid > & | aMtmList | |||
) | [private] |
const TMsvSelectionOrdering & aOrdering | |
const CArrayFix< TUid > & aMtmList |
void | HandleSessionEventL | ( | TMsvSessionEvent | aEvent, |
TAny * | aArg1, | |||
TAny * | aArg2, | |||
TAny * | aArg3 | |||
) |
void | HandleStoreEvent | ( | TMsvStoreEvent | aEvent, |
TMsvId | aId | |||
) |
TMsvStoreEvent aEvent | |
TMsvId aId |
void | Log | ( | TRefByValue< const TDesC > | aFmt, |
... | ||||
) | [private] |
TRefByValue< const TDesC > aFmt | |
... |
IMPORT_C CMsvOperation * | MoveL | ( | const CMsvEntrySelection & | aSelection, |
TMsvId | aTargetId, | |||
TRequestStatus & | aStatus | |||
) |
const CMsvEntrySelection & aSelection | |
TMsvId aTargetId | |
TRequestStatus & aStatus |
IMPORT_C CMsvOperation * | MoveL | ( | TMsvId | aMsvId, |
TMsvId | aTargetId, | |||
TRequestStatus & | aStatus | |||
) |
TMsvId aMsvId | |
TMsvId aTargetId | |
TRequestStatus & aStatus |
IMPORT_C void | MoveL | ( | const CMsvEntrySelection & | aSelection, |
TMsvId | aTargetId, | |||
TMsvLocalOperationProgress & | aProgress | |||
) |
const CMsvEntrySelection & aSelection | |
TMsvId aTargetId | |
TMsvLocalOperationProgress & aProgress |
void | NewChildrenL | ( | const CMsvEntrySelection & | aSelection | ) | [private] |
const CMsvEntrySelection & aSelection |
IMPORT_C CMsvEntry * | NewL | ( | CMsvSession & | aMsvSession, |
TMsvId | aMsvId, | |||
const TMsvSelectionOrdering & | aOrdering | |||
) | [static] |
CMsvSession & aMsvSession | |
TMsvId aMsvId | |
const TMsvSelectionOrdering & aOrdering |
void | NotifyAllObserversL | ( | MMsvEntryObserver::TMsvEntryEvent | aEvent, |
TAny * | aArg1, | |||
TAny * | aArg2, | |||
TAny * | aArg3 | |||
) | [private] |
MMsvEntryObserver::TMsvEntryEvent aEvent | |
TAny * aArg1 | |
TAny * aArg2 | |
TAny * aArg3 |
TMsvId | OwningService | ( | ) | const [inline] |
Gets the ID of the service entry that owns the context.
Local entries are considered as being members of the local service:
ID of the service entry that the context is under.
IMPORT_C void | RemoveObserver | ( | MMsvEntryObserver & | aObserver | ) |
MMsvEntryObserver & aObserver |
void | ReplaceChildL | ( | TInt | pos, |
const TMsvEntry & | aEntry | |||
) | [private] |
CMsvSession & | Session | ( | ) | [inline] |
Gets the Message Server session used by this object. This is the same session passed by the client in NewL().
The session used by the object
IMPORT_C void | SetSortTypeL | ( | const TMsvSelectionOrdering & | aOrdering | ) |
const TMsvSelectionOrdering & aOrdering |
const TMsvSelectionOrdering & | SortType | ( | ) | const [inline] |
Gets the current sort order of children of the entry. The sort order is initially set through NewL().
Current sort order
EValid | |
EInvalidChangingContext | |
EInvalidDeletedContext | |
EInvalidOldContext | |
EInvalidMissingChildren |
CArrayPtrFlat< MMsvEntryObserver > * | iObservers | [private] |