logsui/EngineInc/MLogsEventData.h
changeset 0 e686773b3f54
equal deleted inserted replaced
-1:000000000000 0:e686773b3f54
       
     1 /*
       
     2 * Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: 
       
    15 *     Defines abstract interface for Log database's additional Data field
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef __Logs_Engine_MLogsEventData_H__
       
    21 #define __Logs_Engine_MLogsEventData_H__
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32base.h>
       
    25 
       
    26 
       
    27 // FORWARD DECLARATION
       
    28 
       
    29 // CLASS DECLARATION
       
    30 
       
    31 class MLogsEventData 
       
    32     {
       
    33 
       
    34     public:  
       
    35        /**
       
    36         * Destructor.
       
    37         */
       
    38         virtual ~MLogsEventData() {};
       
    39 
       
    40 
       
    41     public:  
       
    42 
       
    43        /**
       
    44         *   ALS flag (Alternate line service).
       
    45         *
       
    46         *   @return  ALS status flag. EFalse if not ALS event, ETrue if ALS event.
       
    47         */
       
    48 		virtual TBool ALS() const = 0;
       
    49 
       
    50         /**
       
    51         *   CNAP flag (Calling name presentation service).
       
    52         *
       
    53         *   @return  CNAP status flag. EFalse if not CNAP event, ETrue if CNAP event.
       
    54         */
       
    55 		virtual TBool CNAP() const = 0;
       
    56 
       
    57         /**
       
    58         *   VT flag (Video Telephony).
       
    59         *
       
    60         *   @return  VT status flag. EFalse if not VT event, ETrue if VT event.
       
    61         */
       
    62 		virtual TBool VT() const = 0;
       
    63 
       
    64         /**
       
    65         *   PoC flag.
       
    66         *
       
    67         *   @return  PoC status flag. EFalse if not PoC event, ETrue if PoC event.
       
    68         */
       
    69 		virtual TBool PoC() const = 0;
       
    70 
       
    71         /**
       
    72         *   VoIP flag.
       
    73         *
       
    74         *   @return  VoIP status flag. EFalse if not VoIP event, ETrue if VoIP event.
       
    75         */
       
    76 		virtual TBool VoIP() const = 0;
       
    77 
       
    78         /**
       
    79         *   Data Recived counter. 
       
    80         *
       
    81         *   @return  Data received (where applicable).
       
    82         */
       
    83 		virtual TInt64 DataReceived() const = 0;
       
    84 
       
    85         /**
       
    86         *   URL. 
       
    87         *
       
    88         *   @return  URL (where applicable).
       
    89         */
       
    90 		virtual TDesC8& Url() const = 0;
       
    91 
       
    92         /**
       
    93         *   Profile information (normally used for VoIP profile)
       
    94         *
       
    95         *   @return  Profile data (where applicable).
       
    96         */
       
    97 		virtual TDesC8& Profile() const = 0;
       
    98 
       
    99         /**
       
   100         *   Additional reference, the Logging application can use to mediate, e.g. reference to PoC call group
       
   101         *
       
   102         *   @return  Additional reference data (where applicable).
       
   103         */
       
   104 		virtual TDesC8& Id() const = 0;
       
   105 
       
   106         /**
       
   107         *   Data Sent counter. 
       
   108         *
       
   109         *   @return  Data sent (where applicable).
       
   110         */
       
   111 		virtual TInt64 DataSent() const = 0;
       
   112         
       
   113         /**
       
   114         *   Data's type
       
   115         *
       
   116         *   @return  Data's type (where applicable).
       
   117         */
       
   118         virtual TInt Type() const = 0;
       
   119 
       
   120         /**
       
   121         *   My address
       
   122         *
       
   123         *   @return  User's own address (My address  where applicable).
       
   124         */
       
   125         virtual TDesC8& MyAddress() = 0;        
       
   126 
       
   127         /**
       
   128         *   Emergency flag.
       
   129         *
       
   130         *   @return  Emergency call flag. EFalse if not emerg call, ETrue if emerg call.
       
   131         */
       
   132 		virtual TBool Emerg() const = 0;      
       
   133 		
       
   134         /**
       
   135         *   Parts in sms.
       
   136         *
       
   137         *   @return  Parts in sms, this info is meaningful only for sms events
       
   138         */
       
   139         virtual TInt MsgPartsNumber() const = 0;
       
   140 
       
   141 // Sawfish VoIP changes ---------
       
   142         /**
       
   143          * Service Id
       
   144          *
       
   145          * @since S60 v3.2
       
   146          * @return Service Id
       
   147          */
       
   148         virtual TUint32 ServiceId() const = 0;
       
   149         
       
   150         /**
       
   151          * ContactLink
       
   152          *
       
   153          * @param aContactLink after return contains contactlink 
       
   154          *
       
   155          * @since S60 v3.2
       
   156          * @return KErrNone if link was found otherwise KErrNotFound
       
   157          */
       
   158         virtual TInt GetContactLink( TPtrC8& aContactLink ) = 0;
       
   159         
       
   160         /**
       
   161          * Returns the unparsed Data Field.
       
   162          *
       
   163          * @since S60 v3.2
       
   164          * @return Data Field
       
   165          */
       
   166         virtual TDesC8& DataField() const = 0;   
       
   167 // ------------------------------  
       
   168     };
       
   169 
       
   170 #endif      // __Logs_Engine_MLogsEventData_H__
       
   171 
       
   172 
       
   173 
       
   174 // End of File