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. This class contains a count...

Members

Defined in CSyncMLHistoryPushMsg:

• AddAlertsL(RPointerArray< CSmlAlertInfo > &)This method moves the Alerts from the supplied array into the entry. The entry t...
• Alert(TInt)constThis method returns details of the Alert at the specified index.
• AlertCount()constThis method returns the number of Alerts in this entry. Each Alert represents a ...
• DynamicCast(CSyncMLHistoryEntry *)
• DynamicCast(const CSyncMLHistoryEntry *)
• ExternalizeL(RWriteStream &)constThis method writes the details associated with this entry to the specified strea...
• IncReceivedCount()This method increments the counter indicating how many times the message has bee...
• InternalizeL(RReadStream &)
• MsgDigest()constThis method returns an MD5 digest of the message body. This is used by the Histo...
• NewL()This method creates a new Push Message entry representing a Push Message.
• Profile()constThis method returns the ID of the Server Profile that this entry is associated w...
• ReceivedCount()constThis method returns the number of times the message has been received.
• ResetAlerts()This method will clear any Alerts currently in the entry.
• ResultCode()constThis method returns the result of parsing the push message.
• SetMsgDigest(const TDesC8 &)This method sets the digest for the message, and sets the received count to 1.
• SetResultCode(TInt)This method will set the result code for this entry.
• TimeStamp()constThis method returns the time stamp of this entry. i.e. when the message was (las...
• ~CSyncMLHistoryPushMsg()Destructor for CSyncMLHistoryPushMsg.

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

Inherited from CSyncMLHistoryEntry:

• ESortByTimeOrdered by Time Stamp.
• ESortByTypeOrdered by Entry Type.
• EntryId()constThis method returns the unique ID of the entry. This identifier is unique within...
• EntryType()constThis method may be used to determine the type of the entry.
• NewL(RReadStream &)This method creates a new history log entry from a stream, internalizing all dat...
• NewL(TUid)This method creates a new history log entry of the specified type.
• NewL(const CSyncMLHistoryEntry &)This method creates a new copy of an existing History Log entry.
• TSortOrderAn ordering of History Entries.

IMPORT_C static CSyncMLHistoryPushMsg* NewL();

Description

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

Return value

Leave codes

IMPORT_C virtual ~CSyncMLHistoryPushMsg();

Description

Destructor for CSyncMLHistoryPushMsg.

static inline CSyncMLHistoryPushMsg* DynamicCast(CSyncMLHistoryEntry *);

Description

Parameters

Return value

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

Description

Parameters

Return value

IMPORT_C virtual void ExternalizeL(RWriteStream &) const;

Description

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

Parameters

IMPORT_C virtual 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

IMPORT_C virtual TTime TimeStamp() const;

Description

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

Return value

IMPORT_C virtual TInt ResultCode() const;

Description

This method returns the result of parsing the push message.

Return value

IMPORT_C TInt ReceivedCount() const;

Description

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

Return value

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

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

IMPORT_C const CSmlAlertInfo& Alert(TInt aIndex) const;

Description

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

Parameters

Return value

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

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

Leave codes

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

private: virtual void InternalizeL(RReadStream &);

Description

Parameters