Class CSyncMLHistoryPushMsg

class CSyncMLHistoryPushMsg : public CSyncMLHistoryEntry;

Description

This class holds the result of a parsing a push msg. This class contains a counter that stores how many times the same message has been received.

Derivation

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

• CSyncMLHistoryEntry - Base class for a history log entry

• CSyncMLHistoryPushMsg - This class holds the result of a parsing a push msg

Members

Defined in CSyncMLHistoryPushMsg:
AddAlertsL(), Alert(), AlertCount(), DynamicCast(), DynamicCast(), ExternalizeL(), IncReceivedCount(), InternalizeL(), MsgDigest(), NewL(), Profile(), ReceivedCount(), ResetAlerts(), ResultCode(), SetMsgDigest(), SetResultCode(), TimeStamp(), ~CSyncMLHistoryPushMsg()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CSyncMLHistoryEntry:
ESortByTime, ESortByType, EntryId(), EntryType(), Reserved(), TSortOrder

static IMPORT_C CSyncMLHistoryPushMsg *NewL();

Description

This method creates a new Push Message entry representing a Push Message.

Return value

CSyncMLHistoryPushMsg * New Push Message entry

Leave codes

KErrNoMemory Insufficient free system RAM.

virtual IMPORT_C ~CSyncMLHistoryPushMsg();

Description

Destructor for CSyncMLHistoryPushMsg.

static inline CSyncMLHistoryPushMsg *DynamicCast(CSyncMLHistoryEntry *);

Description

Parameters

CSyncMLHistoryEntry *

Return value

CSyncMLHistoryPushMsg *

static inline const CSyncMLHistoryPushMsg *DynamicCast(const CSyncMLHistoryEntry *);

Description

Parameters

const CSyncMLHistoryEntry *

Return value

const CSyncMLHistoryPushMsg *

virtual IMPORT_C void ExternalizeL(RWriteStream &) const;

Description

This method writes the details associated with this entry to the specified stream.

Parameters

RWriteStream & The stream to write the entry to.

virtual IMPORT_C TSmlProfileId Profile() const;

Description

This method returns the ID of the Server Profile that this entry is associated with. Returns KSmlNullId if this entry is not associated with any Profile.

Return value

TSmlProfileId The ID of the Server Profile that this entry is associated with.

virtual IMPORT_C TTime TimeStamp() const;

Description

This method returns the time stamp of this entry. i.e. when the message was (last) received.

Return value

TTime The time stamp in Universal Time.

virtual IMPORT_C TInt ResultCode() const;

Description

This method returns the result of parsing the push message.

Return value

TInt The error code that the parsing completed with.

IMPORT_C TInt ReceivedCount() const;

Description

This method returns the number of times the message has been received.

Return value

TInt The number of times the message has been received

IMPORT_C const TDesC8 &MsgDigest() const;

Description

This method returns an MD5 digest of the message body. This is used by the History Log for identifying duplicate messages.

Return value

const TDesC8 & The MD5 message digest.

IMPORT_C TInt AlertCount() const;

Description

This method returns the number of Alerts in this entry. Each Alert represents a Sync Job, requested by the sender of the Push Message. Typically a Push Message only contains one Alert.

Return value

TInt The number of alerts.

IMPORT_C const CSmlAlertInfo &Alert(TInt aIndex) const;

Description

This method returns details of the Alert at the specified index.

Parameters

TInt aIndex The index of the Alert to retrieve.

Return value

const CSmlAlertInfo & The Alert details.

IMPORT_C void IncReceivedCount();

Description

This method increments the counter indicating how many times the message has been received. Also updates the entry timestamp.

IMPORT_C void SetMsgDigest(const TDesC8 &);

Description

This method sets the digest for the message, and sets the received count to 1.

Parameters

const TDesC8 & The MD5 message digest.

IMPORT_C void AddAlertsL(RPointerArray< CSmlAlertInfo > &);

Description

This method moves the Alerts from the supplied array into the entry. The entry takes ownership of all the alerts in the array. This method will clear any Alerts currently in the entry.

Parameters

RPointerArray< CSmlAlertInfo > & An array of Alerts.

Leave codes

KErrNoMemory Insufficient free system RAM.

IMPORT_C void ResetAlerts();

Description

This method will clear any Alerts currently in the entry.

IMPORT_C void SetResultCode(TInt aResultCode);

Description

This method will set the result code for this entry.

Parameters

TInt aResultCode The result code for the this entry

private: virtual void InternalizeL(RReadStream &);

Description

Parameters

RReadStream &