Class CMsvEntryFilter

class CMsvEntryFilter : public CBase;

Description

Used to query the Message Server for entries that match the specification defined in the filter.

It allows a query to be performed on service, MTM, type and last change date. The filter also enables the specification of the order in which the entries are returned.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CMsvEntryFilter - Used to query the Message Server for entries that match the specification define...

Members

Defined in CMsvEntryFilter:

• LastChangeDate()constGets the last change date set for the filter.
• Mtm()constGets the MTM UID set for the filter.
• NewL()Allocates and constructs a new entry filter.
• NewLC()Allocates and constructs a new entry filter, and leaves the pointer on the clean...
• Order()constGets the selection ordering set for the filter.
• Service()constGets the service ID set for the filter.
• SetLastChangeDate(const TTime &)Sets the last date change for the filter.
• SetMtm(TUid)Sets the MTM UID for the filter.
• SetOrder(const TMsvSelectionOrdering &)Sets the sort ordering for the filter.
• SetService(TMsvId)Sets the service ID for the filter.
• SetSortMtm(TUid)Sets the sorting by MTM for the filter.
• SetType(TUid)Sets the entry type for the filter.
• SortMtm()constGets the sorting by MTM for the filter.
• Type()constGets the entry type set for the filter.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

See also:

• CMsvSession::GetChildIdsL(TMsvId,const CMsvEntryFilter &,CMsvEntrySelection &)Gets filtered list of children of a specified message entry.

IMPORT_C static CMsvEntryFilter* NewLC();

Description

Allocates and constructs a new entry filter, and leaves the pointer on the cleanup stack.

For default values, see the CMsvEntryFilter::NewL() function.

Return value

CMsvEntryFilter * Pointer to the newly created entry filter.

IMPORT_C static CMsvEntryFilter* NewL();

Description

Allocates and constructs a new entry filter.

Default values are as follows:

1. service: KMsvNullIndexEntryId

2. MTM: KNullUid

3. entry type: KNullUid

4. last change date: no date

5. sort order defaults to EMsvSortByNone

These values mean that entries with any values for service, MTM, type and last change date will be returned, with no grouping or sort MTM.

Return value

CMsvEntryFilter * Pointer to the newly created entry filter.

inline TMsvId Service() const;

Description

Gets the service ID set for the filter.

Return value

TMsvId Service ID set for the filter

inline void SetService(TMsvId aServiceId);

Description

Sets the service ID for the filter.

Parameters

TMsvId aServiceId Service ID for the filter

inline TUid Mtm() const;

Description

Gets the MTM UID set for the filter.

Return value

TUid MTM UID set for the filter

inline void SetMtm(TUid aMtm);

Description

Sets the MTM UID for the filter.

Parameters

TUid aMtm MTM UID for the filter

inline TUid Type() const;

Description

Gets the entry type set for the filter.

Return value

TUid Entry type set for the filter

inline void SetType(TUid aType);

Description

Sets the entry type for the filter.

Parameters

TUid aType Entry type for the filter

inline const TTime& LastChangeDate() const;

Description

Gets the last change date set for the filter.

Return value

const TTime & Last change date set for the filter

inline void SetLastChangeDate(const TTime &aLastChange);

Description

Sets the last date change for the filter.

This is used to retrieve entries that have changed since a particular date.

Parameters

const TTime &aLastChange Last date change for the filter, specified in Universal Time (GMT)

inline const TMsvSelectionOrdering& Order() const;

Description

Gets the selection ordering set for the filter.

Return value

const TMsvSelectionOrdering & Selection ordering set for the filter

inline void SetOrder(const TMsvSelectionOrdering &aOrder);

Description

Sets the sort ordering for the filter.

Parameters

const TMsvSelectionOrdering &aOrder Selection ordering for the filter

inline TUid SortMtm() const;

Description

Gets the sorting by MTM for the filter.

Return value

TUid Sorting by MTM for the filter

inline void SetSortMtm(TUid aSortMtm);

Description

Sets the sorting by MTM for the filter.

Parameters

TUid aSortMtm Sorting by MTM for the filter