examples/ForumNokia/SMSExample/Engine/inc/SMSExampleMtmsEngine.h

/*
 * Copyright (c) 2008-2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
 *    
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    
 *  * Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  * Neither the name of Nokia Corporation nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *    
 *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 *    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 *    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 *    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *    
 *    Description:  
 */

#ifndef SMS_EXAMPLE_ENGINE
#define SMS_EXAMPLE_ENGINE

// INCLUDES 
#include <e32base.h> // CBase
#include <msvapi.h>  // MMsvSessionObserver
#include <badesca.h> // CDesCArrayFlat

// FORWARD DECLARATIONS
class CClientMtmRegistry;
class CSmsClientMtm;
class MSMSExampleMtmsEngineObserver;

// CLASS DECLARATION

class CSMSExampleMtmsEngine : public CActive, public MMsvSessionObserver
    {
    public:
       
        static CSMSExampleMtmsEngine* NewL(MSMSExampleMtmsEngineObserver& 
                                           aObserver);
        
        ~CSMSExampleMtmsEngine();

    public:

        void MoveToFolderL( TMsvId aMessageId,  TMsvId aFolder );

        void DeleteMessageL( TMsvId aMessageId );

        void CopyMessageL( TMsvId aMessageId, TMsvId aFolder );

        void GetMessageAddressL( TMsvId aMessageId, TDes& aAddress );

        TBool GetMessageL( TMsvId aMessageId, TDes& aMessage );

        TBool GetMessageIndexBodyTextL( TMsvId aMessageId, TDes& aMessage );

        void GetFolderSMSMessageInformationL( TMsvId aFolderID, 
                                              CDesCArrayFlat*& aAddresses, 
                                              CDesCArrayFlat*& aMessages );

        RArray<TMsvId>* GetMessageIds();

    private:
        CSMSExampleMtmsEngine(MSMSExampleMtmsEngineObserver& aObserver);

        void ConstructL();

        void CreateMtmClientL();

    private: // from CActive
        virtual void DoCancel();
        virtual void RunL();


    private: // from MMsvSessionObserver
        void HandleSessionEventL(TMsvSessionEvent aEvent, TAny* aArg1, 
                                 TAny* aArg2, TAny* aArg3);

    private:

        // SMS client MTM interface
        CSmsClientMtm*      iSmsMtm;

        // Observer of this engine.
        MSMSExampleMtmsEngineObserver& iObserver;

        // Controls asynchronous commands in the messaging system
        // Get progress information about the sending.
        CMsvOperation*      iMsvOper;

        // Encapsulates an array of entry IDs.
        CMsvEntrySelection* iEntrySelection;

        // Represents a session to the messaging server
        CMsvSession*        iSession;   

        // This registry holds details of the all the Client-side 
        // MTMs currently available on the system. 
        CClientMtmRegistry* iClientMtmReg;
       
        // Array of ids
        RArray<TMsvId>*     iIdArray;
       
        // Id of an SMS message
        TMsvId              iSmsId;
    };

class MSMSExampleMtmsEngineObserver
    {
    public:
        virtual void HandleMessageSentL(TInt aError) = 0;
    };


#endif  // SMS_EXAMPLE_ENGINE

---