examples/ForumNokia/SMSExample/Engine/inc/SMSEngine.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 CSMSENGINE_H
#define CSMSENGINE_H

//  EXTERNAL INCLUDES
#include <e32base.h>

//  INTERNAL INCLUDES
#include "SMSExampleMtmsEngine.h"

//  CONSTANTS
const TInt KSmsMessageLength = 512;
const TInt KAddressLength = 64;


class MSmsEngineObserver
{
    public:
        virtual void SendingMessage()=0;
        virtual void MessageSent()=0;
        virtual void MessageReceived(const TDesC& addr, const TDesC& msg)=0;
        virtual void SmsEngineInitialized()=0;
        virtual void SmsEngineError(TInt aErrorCode)=0;
        virtual void MessageDeleted()=0; //if automatic deletion is on
};

//  CLASS DEFINITION
class CSmsEngine : public CBase, public MMsvSessionObserver, public MSMSExampleMtmsEngineObserver
    {
    public:     // Constructors and destructor

        IMPORT_C static CSmsEngine* NewL(MSmsEngineObserver& aObserver);

        IMPORT_C static CSmsEngine* NewLC(MSmsEngineObserver& aObserver);

        IMPORT_C ~CSmsEngine();

     public:     //new functions
        IMPORT_C void SendSmsL(const TDesC& aAddr, const TDesC&aMsg); //nyt CreateSmsMessage, validateCreatedSms ja SendSms, laita kaikki piiloon

        IMPORT_C void ListenforIncomingSms(TBool aListening);

        IMPORT_C void SetAutomaticDeletetion(TBool aDeletion);


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

        IMPORT_C RArray<TMsvId>* GetMessageIds();

        IMPORT_C void CopyMessageL( TMsvId aMessageId, TMsvId aFolder );

        IMPORT_C void MoveToFolderL( TMsvId aMessageId,  TMsvId aFolder );

        IMPORT_C void DeleteMessageL( TMsvId aMessageId );

    public:  //from base classes

        void HandleSessionEventL(TMsvSessionEvent aEvent, TAny* aArg1, TAny* aArg2, TAny* aArg3);

        void HandleMessageSentL(TInt aError);

    private:    // Constructors

        CSmsEngine(MSmsEngineObserver& aObserver);

        void ConstructL();

    private:

        void SendSmsInThirdEditionL(const TDesC& aAddr, const TDesC& aMsg);

    private:    // Data

        //The observer
        MSmsEngineObserver& iObserver;

        // SMS engine
        CSMSExampleMtmsEngine* iEngine;

        // Parser that searches phone numbers
        //CSMSExampleParser* iParser;

        // Recipient address
        TBuf<KAddressLength> iAddress;

        // Message body
        TBuf<KSmsMessageLength> iMessage;

        // ETrue is automatic delete is on, EFalse otherwise
        TBool iAutomaticDelete;

        // are we listening for incoming messages
        TBool iListeningForIncoming;

        // Session with the messaging server
        CMsvSession* iMsvSession;

        // CMsvEntry accesses and acts upon a particular Message Server entry
        CMsvEntry* iMsvEntry;

        // Id of a new message
        TMsvId iNewMessageId;

        // Id of the sent message
        TMsvId iSentMessageId;

    };

//  INLINE FUNCTIONS

#endif      //  CSMSENGINE_H

// End of file

---