telephonyserverplugins/common_tsy/commontsy/inc/mmsms/cmmsmsextinterface.h
changeset 0 3553901f7fa8
child 24 6638e7f4bd8f
equal deleted inserted replaced
-1:000000000000 0:3553901f7fa8
       
     1 /*
       
     2 * Copyright (c) 2006-2009 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 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef CMMSMSEXTINTERFACE_H
       
    21 #define CMMSMSEXTINTERFACE_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32def.h>
       
    25 #include <et_tsy.h>
       
    26 #include <etelmm.h>
       
    27 
       
    28 //  FORWARD DECLARATIONS
       
    29 class TDataPackage;
       
    30 class CMmSmsTsy;
       
    31 class CMmPhoneTsy;
       
    32 struct TSmsMsg;
       
    33 class CListReadAllAttempt;
       
    34 
       
    35 // CLASS DECLARATION
       
    36 
       
    37 /**
       
    38 *  CMmSmsExtInterface is used to provide an extension interface for system 
       
    39 *  specific phone object extensions.
       
    40 */
       
    41 NONSHARABLE_CLASS( CMmSmsExtInterface ) : public CBase
       
    42 	{
       
    43     public:
       
    44 
       
    45         /**
       
    46         * Destructor
       
    47         */
       
    48         virtual ~CMmSmsExtInterface();
       
    49         
       
    50         /**
       
    51          * Default implementation of CompleteReceiveMessage method
       
    52          *          
       
    53          * 
       
    54          * @param aSmsMsg Pointer to the sms message
       
    55          * @param aReceiveMessageParamsPtr Pointer to the receive message 
       
    56          *        params
       
    57          * @param aReceiveMessagePduPtr Pointer to the receive message pdu
       
    58          * @return KErrNotSupported
       
    59          */
       
    60         virtual TInt CompleteReceiveMessage( TSmsMsg* aSmsMsg, 
       
    61             TAny* aReceiveMessageParamsPtr,
       
    62             TDes8* aReceiveMessagePduPtr ) = 0;
       
    63 
       
    64         /**
       
    65          * Default implementation of MessageStoreInfo method
       
    66          *          
       
    67          * 
       
    68          * @param aGetMessageStoreInfoPtr Pointer to get message store info
       
    69          * @param aTotalEntries Total entries
       
    70          * @param aUsedEntries Used entries
       
    71          * @return KErrNotSupported
       
    72          */
       
    73         virtual TInt MessageStoreInfo( TAny* aGetMessageStoreInfoPtr,
       
    74             TInt aTotalEntries,
       
    75             TInt aUsedEntries );
       
    76 
       
    77         /**
       
    78          * Default implementation of StoreInfo method
       
    79          *          
       
    80          * 
       
    81          * @param aGetMessageStoreInfoPtr Pointer to store info
       
    82          * @param aTotalEntries Total entries
       
    83          * @param aUsedEntries Used entries
       
    84          * @return KErrNotSupported
       
    85          */
       
    86         virtual TInt StoreInfo( TAny* aGetMessageStoreInfoPtr,
       
    87             TInt aTotalEntries,
       
    88             TInt aUsedEntries );
       
    89 
       
    90         /**
       
    91          * Default implementation of CompleteReadAllSmsPhase1L method.
       
    92          *          
       
    93          * 
       
    94          * @param aSmsListArray SMS message list storage array
       
    95          * @param aReadAllId Read all SMS messages Id
       
    96          * @param aSmsReadAllArray Read all SMS messages array
       
    97          * @param aReadAllBufSizePtr Read all SMS messages pointer
       
    98          * @return KErrNotSupported
       
    99          */
       
   100         virtual TInt CompleteReadAllSmsPhase1L( 
       
   101             CArrayPtrFlat<TSmsMsg>* aSmsListArray,
       
   102             RMobilePhone::TClientId aReadAllId,
       
   103             CArrayPtrFlat<CListReadAllAttempt>* aSmsReadAllArray,
       
   104             TInt* aReadAllBufSizePtr );
       
   105 
       
   106         /**
       
   107          * Default implementation of GetSupportedEntry method
       
   108          *          
       
   109          * 
       
   110          * @return KErrNotSupported
       
   111          */
       
   112         virtual TInt GetSupportedEntry();
       
   113 
       
   114     protected:
       
   115         
       
   116         /**
       
   117          * C++ default constructor.
       
   118          */
       
   119         CMmSmsExtInterface();
       
   120 
       
   121 	};
       
   122 
       
   123 #endif // CMMSMSEXTINTERFACE_H
       
   124 
       
   125 //  End of File