class CLogEvent : public CBase |
Encapsulates the details of an event.
Where time is used, it must be specified as UTC rather than local time.
Private Member Functions | |
---|---|
CLogEvent() | |
void | ConstructL() |
void | InternalizeBufL(RReadStream &, HBufC *&) |
void | ClearFlags | ( | TLogFlags | aFlags | ) | [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.
TLogFlags aFlags | The flags to be cleared. |
TLogContactItemId | Contact | ( | ) | const [inline] |
Gets the contact ID associated with the event.
The contact ID.
IMPORT_C void | CopyL | ( | const CLogEvent & | aEvent | ) |
const CLogEvent & aEvent |
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.
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.
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.
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.
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.
TUid | EventType | ( | ) | const [inline] |
Gets the type of this log event. Event types are identified by a UID.
The event type UID.
IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream | ) | const |
RWriteStream & aStream |
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()
void | InternalizeBufL | ( | RReadStream & | aStream, |
HBufC *& | aDes | |||
) | [private] |
RReadStream & aStream | |
HBufC *& aDes |
IMPORT_C void | InternalizeL | ( | RReadStream & | aStream | ) |
RReadStream & aStream |
const TDesC & | Number | ( | ) | const [inline] |
Gets the phone number associated with the event.
A reference to a non-modifiable descriptor containing the phone number.
const TDesC & | RemoteParty | ( | ) | const [inline] |
Gets the remote party associated with this event.
A reference to a non-modifiable descriptor containing the remote party.
void | SetContact | ( | TLogContactItemId | aContact | ) | [inline] |
Sets the contact ID associated with the event.
TLogContactItemId aContact | The contact ID. |
IMPORT_C void | SetDataL | ( | RReadStream & | aStream, |
TInt | aLen | |||
) |
RReadStream & aStream | |
TInt aLen |
void | SetDescription | ( | const TDesC & | aDescription | ) | [inline] |
const TDesC & aDescription |
void | SetDirection | ( | 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()
const TDesC & aDirection | The readable name. |
void | SetDuration | ( | TLogDuration | aDuration | ) | [inline] |
Sets the duration of the event.
TLogDuration aDuration | The duration of the event, expressed as the number of seconds since the time of the event. |
void | SetDurationType | ( | TLogDurationType | aDurationType | ) | [inline] |
Sets the duration type. This applies meaning to the idea of a duration.
TLogDurationType aDurationType | The duration type. |
void | SetEventType | ( | TUid | aId | ) | [inline] |
Sets the type of this log event. Event types are identified by a UID.
TUid aId | The event type UID. |
void | SetFlags | ( | TLogFlags | aFlags | ) | [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.
TLogFlags aFlags | The flags to be set. |
void | SetId | ( | TLogId | aId | ) | [inline] |
Sets the unique event ID.
TLogId aId | The unique event ID. |
void | SetLink | ( | TLogLink | aLink | ) | [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.
TLogLink aLink | The link value. |
void | SetNumber | ( | 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.
const TDesC & aNumber | The number. |
void | SetRemoteParty | ( | 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.
const TDesC & aRemote | The remote party. |
void | SetStatus | ( | 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()
const TDesC & aStatus | The delivery status. |
void | SetSubject | ( | 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.
const TDesC & aSubject | The subject. |
void | SetTime | ( | 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.
const TTime & aTime | The UTC time of the event. |
const TDesC & | Status | ( | ) | const [inline] |
Gets the delivery status of this event.
A reference to a non-modifiable descriptor containing the delivery status.
const TDesC & | Subject | ( | ) | const [inline] |
Gets the subject of this event.
A reference to a non-modifiable descriptor containing the subject.
const TTime & | Time | ( | ) | const [inline] |
Gets the UTC time that this event was created.
The time of the event.