CLogEvent Class Reference

class CLogEvent : public CBase

Encapsulates the details of an event.

Where time is used, it must be specified as UTC rather than local time.

Inherits from

Public Member Functions
~CLogEvent()
voidClearFlags(TLogFlags)
TLogContactItemId Contact()
IMPORT_C voidCopyL(const CLogEvent &)
const TDesC8 &Data()
const TDesC &Description()
const TDesC &Direction()
TLogDuration Duration()
TLogDurationType DurationType()
TUid EventType()
IMPORT_C voidExternalizeL(RWriteStream &)
TLogFlags Flags()
TLogId Id()
IMPORT_C voidInternalizeL(RReadStream &)
TLogLink Link()
IMPORT_C CLogEvent *NewL()
const TDesC &Number()
const TDesC &RemoteParty()
voidSetContact(TLogContactItemId)
IMPORT_C voidSetDataL(RReadStream &, TInt)
IMPORT_C voidSetDataL(const TDesC8 &)
voidSetDescription(const TDesC &)
voidSetDirection(const TDesC &)
voidSetDuration(TLogDuration)
voidSetDurationType(TLogDurationType)
voidSetEventType(TUid)
voidSetFlags(TLogFlags)
voidSetId(TLogId)
voidSetLink(TLogLink)
voidSetNumber(const TDesC &)
voidSetRemoteParty(const TDesC &)
IMPORT_C voidSetSimId(TSimId)
voidSetStatus(const TDesC &)
voidSetSubject(const TDesC &)
voidSetTime(const TTime &)
IMPORT_C TSimIdSimId()
const TDesC &Status()
const TDesC &Subject()
const TTime &Time()
Private Member Functions
CLogEvent()
voidConstructL()
voidInternalizeBufL(RReadStream &, HBufC *&)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
TLogContactItemId iContact
HBufC8 *iData
HBufC *iDescription
HBufC *iDirection
TLogDuration iDuration
TLogDurationType iDurationType
TUid iEventType
TLogFlags iFlags
TLogId iId
TLogLink iLink
HBufC *iNumber
HBufC *iRemoteParty
HBufC *iStatus
HBufC *iSubject
TTime iTime

Constructor & Destructor Documentation

CLogEvent()

CLogEvent()[private]

~CLogEvent()

IMPORT_C~CLogEvent()

Member Functions Documentation

ClearFlags(TLogFlags)

voidClearFlags(TLogFlagsaFlags)[inline]

Clears the specified flags for this event.

The function does not change any of the other flag bit settings.

The constant KLogFlagsMask may be used to clear all the flags in an event.

Parameters

TLogFlags aFlagsThe flags to be cleared.

ConstructL()

voidConstructL()[private]

Contact()

TLogContactItemId Contact()const [inline]

Gets the contact ID associated with the event.

The contact ID.

CopyL(const CLogEvent &)

IMPORT_C voidCopyL(const CLogEvent &aEvent)

Parameters

const CLogEvent & aEvent

Data()

const TDesC8 &Data()const [inline]

Gets event specific data.

A reference to a non-modifiable descriptor containing the data that is specific to the event.KNullDesC8, if there is no data.

Description()

const TDesC &Description()const [inline]

Gets the human readable name describing the event type.

Note that this is set automatically by the Log Engine.

A reference to a non-modifiable descriptor containing the readable name.

Direction()

const TDesC &Direction()const [inline]

Gets the direction of the call represented by this event. The direction of a call means incoming, outgoing etc.

The direction is represented by a string.

A reference to a non-modifiable descriptor containing the string representing the direction of the call.

Duration()

TLogDuration Duration()const [inline]

Gets the duration of the event.

The duration of the event, expressed as the number of seconds since the time of the event.

DurationType()

TLogDurationType DurationType()const [inline]

Gets the duration type.

This applies meaning to the idea of a duration.

The duration type is implemented as a UI variant-specific enumeration. The following duration types are generic: KLogDurationNone, KLogDurationValid and KLogDurationData.

The duration type.

EventType()

TUid EventType()const [inline]

Gets the type of this log event. Event types are identified by a UID.

The event type UID.

CLogEvent::Description()

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Parameters

RWriteStream & aStream

Flags()

TLogFlags Flags()const [inline]

Gets the flags set for this event.

The flags.

Id()

TLogId Id()const [inline]

Gets the unique event ID associated with this log event.

Unique event IDs are allocated by the Log Engine when an event is added to the log.

The unique event ID.

CLogClient::GetEvent()

CLogClient::AddEvent()

CLogClient::ChangeEvent()

CLogClient::DeleteEvent()

InternalizeBufL(RReadStream &, HBufC *&)

voidInternalizeBufL(RReadStream &aStream,
HBufC *&aDes
)[private]

Parameters

RReadStream & aStream
HBufC *& aDes

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)

Parameters

RReadStream & aStream

Link()

TLogLink Link()const [inline]

Gets the link value.

The link value.

NewL()

IMPORT_C CLogEvent *NewL()[static]

Number()

const TDesC &Number()const [inline]

Gets the phone number associated with the event.

A reference to a non-modifiable descriptor containing the phone number.

RemoteParty()

const TDesC &RemoteParty()const [inline]

Gets the remote party associated with this event.

A reference to a non-modifiable descriptor containing the remote party.

SetContact(TLogContactItemId)

voidSetContact(TLogContactItemIdaContact)[inline]

Sets the contact ID associated with the event.

Parameters

TLogContactItemId aContactThe contact ID.

SetDataL(RReadStream &, TInt)

IMPORT_C voidSetDataL(RReadStream &aStream,
TIntaLen
)

Parameters

RReadStream & aStream
TInt aLen

SetDataL(const TDesC8 &)

IMPORT_C voidSetDataL(const TDesC8 &aData)

Parameters

const TDesC8 & aData

SetDescription(const TDesC &)

voidSetDescription(const TDesC &aDescription)[inline]

Parameters

const TDesC & aDescription

SetDirection(const TDesC &)

voidSetDirection(const TDesC &aDirection)[inline]

Sets the direction of the call represented by this event. The direction of a call means incoming, outgoing etc.

The direction is represented by a string. Standard strings are available in the log wrapper resource file and can be accessed through the resource IDs: R_LOG_DIR_IN, R_LOG_DIR_OUT, R_LOG_DIR_IN_ALT, R_LOG_DIR_OUT_ALT, R_LOG_DIR_FETCHED and R_LOG_DIR_MISSED.

The string is copied into a pre-allocated heap descriptor that has a maximum length of KLogMaxDirectionLength. If the length of the specified descriptor is greater than KLogMaxDirectionLength, then the data is truncated.

CLogClient::GetString()

Parameters

const TDesC & aDirectionThe readable name.

SetDuration(TLogDuration)

voidSetDuration(TLogDurationaDuration)[inline]

Sets the duration of the event.

Parameters

TLogDuration aDurationThe duration of the event, expressed as the number of seconds since the time of the event.

SetDurationType(TLogDurationType)

voidSetDurationType(TLogDurationTypeaDurationType)[inline]

Sets the duration type. This applies meaning to the idea of a duration.

Parameters

TLogDurationType aDurationTypeThe duration type.

SetEventType(TUid)

voidSetEventType(TUidaId)[inline]

Sets the type of this log event. Event types are identified by a UID.

CLogEvent::Description()

Parameters

TUid aIdThe event type UID.

SetFlags(TLogFlags)

voidSetFlags(TLogFlagsaFlags)[inline]

Sets the specified flags for this event.

The function does not change any of the other flag bit settings.

Only the low order 4 bits are stored in the Log Engine Database; the constant KLogFlagsMask can be used as a mask.

Parameters

TLogFlags aFlagsThe flags to be set.

SetId(TLogId)

voidSetId(TLogIdaId)[inline]

Sets the unique event ID.

Parameters

TLogId aIdThe unique event ID.

SetLink(TLogLink)

voidSetLink(TLogLinkaLink)[inline]

Sets the link value.

The link can be used to relate this event to an entity in another application. For example, it can be used to associate the event with the call ID or the message ID for emails and faxes.

Parameters

TLogLink aLinkThe link value.

SetNumber(const TDesC &)

voidSetNumber(const TDesC &aNumber)[inline]

Sets the phone number associated with this event. This is used when the number cannot be stored in any other field.

The number is specified as a string and is copied into a pre-allocated heap descriptor that has a maximum length of KLogMaxNumberLength. If the length of the specified descriptor is greater than KLogMaxNumberLength, then the number is truncated.

Parameters

const TDesC & aNumberThe number.

SetRemoteParty(const TDesC &)

voidSetRemoteParty(const TDesC &aRemote)[inline]

Sets the remote party associated with this event. This describes the destination of an outgoing event or the source of an incoming event.

The remote party is represented by a string.

The string is copied into a pre-allocated heap descriptor that has a maximum length of KLogMaxRemoteLength. If the length of the specified descriptor is greater than KLogMaxRemoteLength, then the data is truncated.

Parameters

const TDesC & aRemoteThe remote party.

SetSimId(TSimId)

IMPORT_C voidSetSimId(TSimIdaSimId)

Parameters

TSimId aSimId

SetStatus(const TDesC &)

voidSetStatus(const TDesC &aStatus)[inline]

Sets the delivery status of this event.

The delivery status is represented by a string. Standard strings are available in the log wrapper resource file and can be accessed through the resource IDs: R_LOG_DEL_PENDING, R_LOG_DEL_SENT, R_LOG_DEL_FAILED, R_LOG_DEL_NONE, R_LOG_DEL_DONE and R_LOG_DEL_NOT_SENT.

The string is copied into a pre-allocated heap descriptor that has a maximum length of KLogMaxStatusLength. If the length of the specified descriptor is greater than KLogMaxStatusLength, then the data is truncated.

CLogClient::GetString()

Parameters

const TDesC & aStatusThe delivery status.

SetSubject(const TDesC &)

voidSetSubject(const TDesC &aSubject)[inline]

Sets the subject of this event.

The subject is represented by a string.

The string is copied into a pre-allocated heap descriptor that has a maximum length of KLogMaxSubjectLength. If the length of the specified descriptor is greater than KLogMaxSubjectLength, then the data is truncated.

Parameters

const TDesC & aSubjectThe subject.

SetTime(const TTime &)

voidSetTime(const TTime &aTime)[inline]

Sets the UTC time that this event was created.

Note that this field is used when ordering events in a view; changing this value may change the position of the event in a view.

Parameters

const TTime & aTimeThe UTC time of the event.

SimId()

IMPORT_C TSimIdSimId()const

Status()

const TDesC &Status()const [inline]

Gets the delivery status of this event.

A reference to a non-modifiable descriptor containing the delivery status.

Subject()

const TDesC &Subject()const [inline]

Gets the subject of this event.

A reference to a non-modifiable descriptor containing the subject.

Time()

const TTime &Time()const [inline]

Gets the UTC time that this event was created.

The time of the event.

Member Data Documentation

TLogContactItemId iContact

TLogContactItemId iContact[private]

HBufC8 * iData

HBufC8 *iData[private]

HBufC * iDescription

HBufC *iDescription[private]

HBufC * iDirection

HBufC *iDirection[private]

TLogDuration iDuration

TLogDuration iDuration[private]

TLogDurationType iDurationType

TLogDurationType iDurationType[private]

TUid iEventType

TUid iEventType[private]

TLogFlags iFlags

TLogFlags iFlags[private]

TLogId iId

TLogId iId[private]

TLogLink iLink

TLogLink iLink[private]

HBufC * iNumber

HBufC *iNumber[private]

HBufC * iRemoteParty

HBufC *iRemoteParty[private]

HBufC * iStatus

HBufC *iStatus[private]

HBufC * iSubject

HBufC *iSubject[private]

TTime iTime

TTime iTime[private]