/*

* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Interface for fetching/saving the vmbx number and querying

*                for it.

*                Also notify on a number change is supported.

*

*/

#ifndef VMNUMBER_H

#define VMNUMBER_H

// INCLUDES

/*****************************************************

*  Series 60 Customer / ETel

*  Series 60 ETel API

*****************************************************/

#include <etelmm.h>

#include <etelsat.h>

#include <mmtsy_names.h>

#include <PhCltTypes.h>         // from PhoneClient

#include <MSSSettingsObserver.h>

#include <msatrefreshobserver.h>

#include <rsatsession.h>

#include <rsatrefresh.h>

#include <centralrepository.h>

#include <cenrepnotifyhandler.h>

#include <aknappui.h>

#include <AknQueryDialog.h>

#include <CPhCltEmergencyCall.h>     // CPhCltEmergencyCall

#include <MPhCltEmergencyCallObserver.h>

// FORWARD DECLARATIONS

class CVmSPSHandler;

// CONSTANTS

_LIT( KEmptyVoiceMailNumber, "" );

enum TVmbxQueryType

    {

    EVmbxNotDefinedQuery,   // use this

    EVmbxChangeNumberQuery  // this is only for vmbx application

    };

enum TVmbxNumberEntry

    {

    EAlsActiveLineEntry = 0,    // currently active ALS line

    EAlsLine1Entry = 1,         // ALS primary line

    EAlsLine2Entry = 2          // ALS auxiliary line

    };

enum TVmbxAlsLine

    {

    EAlsLine1 = 1,

    EAlsLine2 = 2

    };

enum TVmbxPhonebookOperation

    {

    EVmbxPhonebookGetInfo,

    EVmbxPhonebookRead,

    EVmbxPhonebookWrite,

    EVmbxPhonebookDelete

    };

enum TVmbxMemoryLocation

    {

    EVmbxSimMemory = 0,

    EVmbxPhoneMemory

    };

_LIT( KVmbxPanicCategory, "RVmbxNumber");

enum TVmbxPanic

    {

    EVmbxNotConnected       = 0,

    EVmbxDescriptorTooSmall = 1,

    EVmbxNumberTooLong      = 2,

    EVmbxNoNotifyHandler    = 3,

    EVmbxNoCoeEnv           = 4,

    EVmbxUnhandledOperation = 5

    };

enum TVmbxSimNumAcceptance

    {

    EVmbxSimNumNotAccepted = 0,

    EVmbxSimNumAccepted

    };

enum TVmbxUserEditIndicator

    {

    EVmbxNotUserEdit = 0,

    EVmbxUserEdit,

    EvmbxPhoneMemForcedEdit

    };

const TInt KVmbxMaxNumberLength = KPhCltTelephoneNumberLength;

const TInt KVmbxMaxAddressLength = 100;

// Phonebook entry name length

const TInt KVmbxPhoneBookEntryNameLength = 5;

// Branding id

const TInt KVmSettingsUiBrandingIdLength = 512;

// Publish & Subscribe property category definition

enum TVmbxNumType

    {

    EVmbxMDN,

    EVmbxMIN

    };

enum TVmbxType

    {

    EVmbx,

    EVmbxIP,

    EVmbxVideo,

    EVmbxNone

    };

enum TVmbxTitle

    {

    EVmbxCall,

    EVmbxDefine

    };

// Phonebook types (VMBX = 6f17)

enum TVmSimPhoneBookTypes

    {

    EVMBXPhoneBook = 0,

    EMBDNPhoneBook

    };

// FORWARD DECLARATIONS

class CVmTextQueryDialog;

class CCoeEnv;

class CVPbkContactManager;

class CPhCntSingleItemFetch;

class CVMSimQueryDilaog;

class CVmListQueryDialog;

class CVmBSHandler;

// CLASS DECLARATION

/**

*  TVmbxEntry

*  Contains vmbx sim entry data.

*

*  @lib vmbx.lib

*  @since 2.0

**/

class TVmbxEntry

    {

    public: // Constructors and destructor

        /**

        * C++ default constructor.

        */

        TVmbxEntry() : iIndex( 0 )

            {

            iTelNumber.FillZ();

            iTelNumber.Zero();

            };

    public: // Data

        // Data index

        TInt iIndex;

        // Telefony number

        TBuf16<KVmbxMaxNumberLength> iTelNumber;

        // Phonebook entry name

        TBuf16<KVmbxPhoneBookEntryNameLength> iText;

    };

/**

*  MVmbxNotifyHandler

*

*  @lib vmbx.lib

*  @since

**/

class MVmbxNotifyHandler

    {

    public:

        /**

        * Does the action user wants when a vmbx number has been changed.

        * If the parameter aNotifyOnActiveLineOnly was ETrue in notify request,

        * only a change of the vmbx number of the active ALS line causes

        * calling this.

        *

        * @param aLine ALS line of which number was changed ( 1 or 2 )

        * @param aValue the new vmbx number of that line.

        * (this reference is only valid in scope of this method)

        */

        virtual void HandleNotifyL( TInt aLine, const TDesC& aValue ) = 0;

    };

/**

 *  Observer interface for ServiceNotifier.

 *

 *  @since S60 3.2

 **/

class MServiceNotifyHandler

    {

    public:

        /**

        * Called when a Service profile has been changed.

        */

        virtual void HandleServiceNotifyL() = 0;

    };

/**

*  MVmbxAlsObserver

*

*  @lib vmbx.lib

*  @since

**/

class MVmbxAlsObserver

    {

    public:

        /**

        * Does the action user wants when the active ALS line has been changed.

        *

        * @param aLine new ALS line number ( 1 or 2 )

        **/

        virtual void HandleAlsChangeL( TVmbxAlsLine aLine ) = 0;

    };

/**

 *  TVmbxServiceInfo, contains Service information.

 *

 *  @since S60 3.2

 **/

class TVmbxServiceInfo

    {

    public: // Constructors and destructor

        TVmbxServiceInfo()

            {

            iServiceId = 0;

            iSnapId    = 0;

            }

    public: // Data

        // Service's Id

        TUint       iServiceId;

        // Service's SNAP Id

        TUint32     iSnapId;

        // Service's name.

        TBuf<64>    iName;

        // Service's address.

        TBuf<KVmbxMaxAddressLength> iAddress;

    };

/**

 *  TVmbxServiceSelection, contains selected service information.

 *

 *  @since S60 3.2

 **/

class TVmbxServiceSelection

    {

    public: // Constructors and destructor

        TVmbxServiceSelection( TVmbxType aServiceType = EVmbxNone,

                               TUint aServiceId = 0 )

            {

            iServiceType = aServiceType;

            iServiceId   = aServiceId;

            }

    public: // Data

        // Service type

        TVmbxType   iServiceType;

        // Service Id

        TUint      iServiceId;

    };

/**

*  RVmbxNumber

*

*  @lib vmbx.lib

*  @since

**/

class RVmbxNumber : public MCenRepNotifyHandlerCallback,

                    public MSSSettingsObserver,

                    public MSatRefreshObserver,

                    public MPhCltEmergencyCallObserver

    {

    public:

        /**

        * status for QueryNumberL.

        * EVmQueryNormal Query number running normal case

        * EVmQueryProcess Query number running FOREVER case

        */

        enum TVmVmQueryStatusType

            {

            EVmQueryNormal = 0,

            EVmQueryProcess

            };

    public:

        /**

        * C++ default constructor.

        */

        IMPORT_C RVmbxNumber();

        /**

        * Destructor.

        */

        IMPORT_C ~RVmbxNumber();

    public: // New functions

        /**

        * Opens the resources needed. This or the other overloaded Open() has to

        * be called successfully before doing anything else.

        *

        * ----------------------------------------------------------------------

        * A new ETel connection is opened when using this method!

        * ----------------------------------------------------------------------

        *

        * @return Symbian OS error code (KErrNone is successful)

        **/

        /*****************************************************

        *  Series 60 Customer / ETel

        *  Series 60 ETel API

        *****************************************************/

        IMPORT_C TInt Open();

        /**

        * Opens the resources needed. This or the other overloaded Open() has to

        * be called successfully before doing anything else.

        *

        * Use this overload if you already have ETel connection.

        *

        * ----------------------------------------------------------------------

        * An existing ETel connection is used when using this method!

        * ----------------------------------------------------------------------

        *

        * @param aPhone Phone client

        * @return Symbian OS error code (KErrNone is successful)

        **/

        /*****************************************************

        *  Series 60 Customer / ETel

        *  Series 60 ETel API

        *****************************************************/

        IMPORT_C TInt Open( RMobilePhone& aPhone );

        /**

        * Fetches the specified vmbx number. If there is no vmbx number

        * saved for the specified ALS line, parameter aNumber remains unchanged

        * and the return value is KErrNotFound.

        *

        * @param aNumber vmbx number is saved here (must be room for at least

        *                KVmbxMaxNumberLength characters)

        *

        * @param aEntry determines which vmbx number entry is used:

        *               EAlsLine1Entry = vmbx number entry of primary line

        *               EAlsLine2Entry = vmbx number entry of secondary line

        *               EAlsActiveLineEntry = entry of currently active line

        *

        * @return - KErrNone if the number was found.

        *           aNumber will contain the vmbx number.

        *

        *         - KErrNotFound if the number is not defined

        *

        *         - Other error code if there was a problem in getting

        *           the number. Clients should show error note if this happens.

        **/

        /*****************************************************

        *  Series 60 Customer / ETel

        *  Series 60 ETel API

        *****************************************************/

        IMPORT_C TInt GetVmbxNumber( TDes& aNumber,

                            TVmbxNumberEntry aEntry = EAlsActiveLineEntry );

        /**

        * Check wether the voice mailbox number can be changed. If the number

        * cannot be edited, the QueryNumberL leaves with and SaveVmbxNumber

        * returns KErrAccessDenied.

        * @since 2.7

        * @return ETrue if editing is allowed.

        *         EFalse if editing is forbidden.

        */

        IMPORT_C TBool AllowedToChangeTheNumber();

        /**

        * Puts a query on the screen asking for a voice mailbox number.

        *

        * IMPORTANT:

        *

        * Other subsystems than voice mailbox application should call this

        * ONLY IF GetVmbxNumber() returned KErrNotFound. Also, only the

        * parameter EVmbxNotDefinedQuery should be used outside the voice

        * mailbox application.

        *

        * @param aQueryType type of the query, alternatives:

        *                   - EVmbxNotDefinedQuery

        *                     (use this when no vmbx number is defined)

        *

        *                   - EVmbxChangeNumberQuery

        * @param aNumber    Initial value for the query, AND the result value

        *                   of an accepted query. (must be room for at least

        *                   KVmbxMaxNumberLength characters. Not allowed to

        *                   contain longer initial value than

        *                   KVmbxMaxNumberLength)

        * @param aShowQuery When this is set and the sim has support for vmbx

        *                    number the user is shown a list query by which the

        *                    storage of sim number can be decided

        *

        * @return ETrue if the query was accepted and the vmbx number saved.

        *               This is the case also when user saves empty number!

        *         EFalse if the user canceled the query. No vmbx number changed.

        **/

        IMPORT_C TBool QueryNumberL( TVmbxQueryType aQueryType, TDes& aNumber,

                                                    TBool aShowQuery = EFalse );

        /**

        * Saves the vmbx number. (in phone file system and SIM)

        *

        * @param aNumber vmbx number ( max length is KVmbxMaxNumberLength )

        * @param aEntry determines in which entry the number is saved:

        *               EAlsLine1Entry = vmbx number entry of ALS primary line

        *               EAlsLine2Entry = vmbx number entry of ALS secondary line

        *               EAlsActiveLineEntry = entry of currently active ALS line

        *

        * @return Symbian OS error code (KErrNone is successful)

        **/

        /*****************************************************

        *  Series 60 Customer / ETel

        *  Series 60 ETel API

        *****************************************************/

        IMPORT_C TInt SaveVmbxNumber( const TDesC& aNumber,

                                      TVmbxNumberEntry aEntry );

        /**

        * Saves vmbx number to Sim

        * @since

        * @param aNumber Vmbx number

        * @param aEntry Als line entry

        * @return Symbian OS error code (KErrNone is successful)

        */

        TInt SaveVmbxNumberToSim( const TDesC& aNumber,

                                                    TVmbxNumberEntry aEntry );

        /**

        * Saves vmbx number to phone memory

        * @since

        * @param aNumber Vmbx number

        * @param aEntry Als line entry

        * @return Symbian OS error code (KErrNone is successful)

        */

        TInt SaveVmbxNumberToPhone( const TDesC& aNumber,

                                                    TVmbxNumberEntry aEntry );

        /**

        * Issues a notify request on a vmbx number change.

        * User's HandleNotifyL() will be called whenever the vmbx number has

        * been changed by any subsystem. Only one notify request can be done

        * per one RVmbxNumber object simultaneously. When issuing a notify

        * request while one is active already, only parameters aHandler and

        * aNotifyOnActiveLineOnly are updated in existing request.

        *

        * @param aHandler user's notify handler

        * @param aNotifyOnActiveLineOnly if this is ETrue, notify events will

        *        be generated only if the vmbx number of the active ALS line is

        *        changed, not if the number of the other line is changed. When

        *        there is no ALS support, this has no effect ie. notification

        *        will be generated always.

        *

        * Leaves if the notify request could not be done.

        **/

        IMPORT_C void NotifyVmbxNumberChangeL( MVmbxNotifyHandler* aHandler,

                                                TBool aNotifyOnActiveLineOnly );

        /**

        * Cancels a notify request on a vmbx number change.

        **/

        IMPORT_C void NotifyVmbxNumberChangeCancel();

        /**

        * Gets the currently active ALS line number ( 1 or 2 ).

        * Information is fetched from supplementary settings client.

        * @param aLineNumber line number is returned here. If ALS is not

        *                    supported, value 1 is returned.

        * @return Symbian OS error code (KErrNone is successful)

        **/

        IMPORT_C TInt GetAlsLine( TInt& aLineNumber ) const;

        /**

        * Issues a notify request on active ALS line change. A callback to

        * user's code is made when the ALS line is changed. The notify request

        * remains active as long as it is canceled with

        * NotifyAlsLineChangeCancel(), ie. it is not canceled when the ALS line

        * is changed. Implementation uses SharedData's notify system.

        * Leaves if the notify request could not be done.