/*

* Copyright (c) 2000-2007 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:

*

*/

/**

@file

Multimode ETel API header file.

Describes the MM ETel API - classes, methods and types.

@publishedPartner

@released

*/

#ifndef __ETELMM_H__

#define __ETELMM_H__

#include <e32base.h>

#include <s32mem.h>

#include <etel.h>

#include <etelmmcs.h>

/** 

Internal API/TSY delimiter used to pass the phonebook type

*/

#define PHBOOK_DELIMITER		_L("//")

/** The size of the phone book delimiter string.

@internalComponent

 */

const TInt KSizeOfPhbookDelimiter=2;

/**

Names for Multimode ETel sub-sessions

*/

_LIT(KETelMeAdnPhoneBook,"S1");

_LIT(KETelMeDialledPhoneBook,"S2");

_LIT(KETelMeMissedPhoneBook,"S3");

_LIT(KETelMeReceivedPhoneBook,"S4");

_LIT(KETelCombinedAdnPhoneBook,"S5");

_LIT(KETelTaAdnPhoneBook,"S6");

_LIT(KETelIccAdnPhoneBook,"S7");

_LIT(KETelIccFdnPhoneBook,"S8");

_LIT(KETelIccSdnPhoneBook,"S9");

_LIT(KETelIccBdnPhoneBook,"S10");

_LIT(KETelIccLndPhoneBook,"S11");

_LIT(KETelIccVoiceMailBox,"S12");

_LIT(KETelMeSmsStore,"S13");

_LIT(KETelIccSmsStore,"S14");

_LIT(KETelCombinedSmsStore,"S15");

_LIT(KETelNamStore,"S16");

_LIT(KETelOwnNumberStore,"S17");

_LIT(KETelEmergencyNumberStore,"S18");

_LIT(KETelSmsMessaging,"S19");

_LIT(KETelBroadcastMessaging,"S20");

_LIT(KETelUssdMessaging,"S21");

_LIT(KETelConferenceCall,"S22");

_LIT(KETelIccMbdnPhoneBook, "S23");

_LIT(KETelIccMsisdnPhoneBook, "S24");

_LIT(KETelIccOciPhoneBook, "S25");

_LIT(KETelIccIciPhoneBook, "S26");

_LIT(KETelIccNamStore ,"S27");

_LIT(KETelIccInfoPhoneBook, "S28");

_LIT(KETelLocationServices,"S29");

// Types for Multimode ETel sub-sessions

_LIT(KEtelCdmaPhoneBookType,"T1");

_LIT(KEtelGsmPhoneBookType,"T2");

_LIT(KEtelUSimPhoneBookType,"T3");

// Types for SmartCardEap sub-sessions

/**

The prefix to all RMobileSmartCardEap sub-session names.

*/

_LIT(KETelSmartCardEapSession, "ScEap");

/**

The length of KETelSmartCardEapSession.  Used to obtain a const value

for this length at compile-time.

*/

#define SCEAP_SSN_LENGTH 5

/**

EAP-MD5 type identifier.  Value taken from section 5 of RFC 3748 Jun 2004.

This should be used as the EAP type identifier value of

RMobileSmartCardEap::Open() if standard EAP-MD5 challenges are to be used.

This value corresponds to one of the possible values returned in the type

list of TUiccApplicationEapInfoV6.

(Decimal value = 4)

@see RMobileSmartCardEap::Open()

@see RMobilePhone::TUiccApplicationEapInfoV6

*/

_LIT8(KETelSmartCardEapTypeMD5, "04");

/**

EAP-TLS type identifier.  Value taken from section 4.1 of RFC 2716 Oct 1999.

This should be used as the EAP type identifier value of

RMobileSmartCardEap::Open() if standard EAP-TLS is to be used.

This value corresponds to one of the possible values returned in the type

list of TUiccApplicationEapInfoV6.

(Decimal value = 13)

@see RMobileSmartCardEap::Open()

@see RMobilePhone::TUiccApplicationEapInfoV6

*/

_LIT8(KETelSmartCardEapTypeTLS, "0D");

/**

EAP-SIM type identifier.

This should be used as the EAP type identifier value of

RMobileSmartCardEap::Open() if standard EAP-SIM is to be used.

This value corresponds to one of the possible values returned in the type

list of TUiccApplicationEapInfoV6.

(Decimal value = 18)

@see RMobileSmartCardEap::Open()

@see RMobilePhone::TUiccApplicationEapInfoV6

*/

_LIT8(KETelSmartCardEapTypeSIM, "12");

/**

EAP-AKA type identifier.

This should be used as the EAP type identifier value of

RMobileSmartCardEap::Open() if standard EAP-AKA is to be used.

This value corresponds to one of the possible values returned in the type

list of TUiccApplicationEapInfoV6.

(Decimal value = 23)

@see RMobileSmartCardEap::Open()

@see RMobilePhone::TUiccApplicationEapInfoV6

*/

_LIT8(KETelSmartCardEapTypeAKA, "17");

/**

EAP-TTLS type identifier.

This should be used as the EAP type identifier value of

RMobileSmartCardEap::Open() if standard EAP-TTLS is to be used.

This value corresponds to one of the possible values returned in the type

list of TUiccApplicationEapInfoV6.

(Decimal value = 21)

@see RMobileSmartCardEap::Open()

@see RMobilePhone::TUiccApplicationEapInfoV6

*/

_LIT8(KETelSmartCardEapTypeTTLS, "15");

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

//

//  Global Multimode constants and types

// 

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

/**

Unique API identifier and Functional Unit constants

Modes: Common 

*/

enum TMultimodeETelV1Api

	{

	/** TSY supports the Multimode ETel v1.0 API.

	Modes: Common */

	KETelExtMultimodeV1=3000,  // 3000 is unique reference for Multimode Etel v1.0 API

	/** TSY supports the MobileSimAccess functional unit.

	Modes: Common */

	KETelFuncMobileIccAccess,

	/** TSY supports the MobileNetwork functional unit.

	Modes: Common */

	KETelFuncMobileNetwork,

	/** TSY supports the MobileIdentity functional unit.

	Modes: Common */

	KETelFuncMobileIdentity,

	/** TSY supports the MobilePower functional unit.

	Modes: Common */

	KETelFuncMobilePower,

	/** TSY supports the MobileSignal functional unit.

	Modes: GSM/WCDMA */

	KETelFuncMobileSignal,

	/** TSY supports the MobileIndicator functional unit.

	Modes: Common */

	KETelFuncMobileIndicator,

	/** TSY supports the MobileDTMF functional unit.

	Modes: Common */

	KETelFuncMobileDTMF,

	/** TSY supports the MobileUserNetworkAccess functional unit.

	Modes: Common */

	KETelFuncMobileUserNetworkAccess,

	/** TSY supports the MobileIdentityService functional unit.

	Modes: Common */

	KETelFuncMobileIdentityService,

	/** TSY supports the MobileCallForwarding functional unit.

	Modes: Common */

	KETelFuncMobileCallForwarding,

	/** TSY supports the MobileCallBarring functional unit.

	Modes: GSM/WCDMA */

	KETelFuncMobileCallBarring,

	/** TSY supports the MobileCallWaiting functional unit.

	Modes: Common */

	KETelFuncMobileCallWaiting,

	/** TSY supports the MobileCallCompletion functional unit. */

	KETelFuncMobileCallCompletion,

	/** TSY supports the MobileAlternatingCall functional unit.

	Modes: GSM/WCDMA */

	KETelFuncMobileAlternatingCall,

	/** TSY supports the MobileCost functional unit.

	Modes: GSM/WCDMA */

	KETelFuncMobileCost,

	/** TSY supports the MobileSecurity functional unit.

	Modes: Common */

	KETelFuncMobileSecurity,

	/** TSY supports the MobileAlternateLineService functional unit.

	Modes: GSM/WCDMA */

	KETelFuncMobileAlternateLineService,

	/** TSY supports the MobileMessageWaiting functional unit.

	Modes: Common */

	KETelFuncMobileMessageWaiting,

	/** TSY supports the MobileFixedDiallingNumbers functional unit.

	Modes: GSM/WCDMA */

	KETelFuncMobileFixedDiallingNumbers,

	/** TSY supports the MobileDataCall functional unit.

	Modes: Common */

	KETelFuncMobileDataCall,

	/** TSY supports the MobilePrivacy functional unit.

	Modes: CDMA */

	KETelFuncMobilePrivacy,

	/** TSY supports the MobileEmergencyCall functional unit.

	Modes: Common */

	KETelFuncMobileEmergencyCall,

	/** TSY supports the MobileSmsMessaging functional unit.

	Modes: Common */

	KETelFuncMobileSmsMessaging,

	/** TSY supports the MobileBroadcastMessaging functional unit.

	Modes: Common */

	KETelFuncMobileBroadcastMessaging,

	/** TSY supports the MobileUssdMessaging functional unit.

	Modes: GSM/WCDMA */

	KETelFuncMobileUssdMessaging,

	/** TSY supports the MobileConferenceCall functional unit.

	Modes: Common */

	KETelFuncMobileConferenceCall,

	/** TSY supports the MobilePhonebookStore functional unit.

	Modes: Common */

	KETelFuncMobilePhonebook,

	/** TSY supports the MobileSmsStore functional unit.

	Modes: Common */

	KETelFuncMobileSmsStore,

	/** TSY supports the MobileNamStore functional unit.

	Modes: CDMA */

	KETelFuncMobileNamStore,

	/** TSY supports the MobileONStore functional unit.

	Modes: Common */

	KETelFuncMobileOwnNumberStore,

	/** TSY supports the MobileENStore functional unit.

	Modes: Common */

	KETelFuncMobileEmergencyNumberStore,

	/** TSY supports the MobileMultimedia functional unit.

	Modes: GSM/WCDMA */

	KETelFuncMobileMulticall,

	/** TSY supports the MobileNextIncomingCall functional unit.

	Modes: GSM/WCDMA */

	KETelFuncMobileNextIncomingCall,

	/** TSY supports the MobileMultimediaCall functional unit.

	Modes: GSM/WCDMA */

	KETelFuncMobileMultimediaCall,

	/** TSY supports the MobileUserSignalling functional unit.

	Modes: GSM/WCDMA */

	KETelFuncMobileUserSignalling

	};

/** Unique API identifier and Functional Unit constants.

Modes: WCDMA 

*/

enum TMultimodeETelV2Api

	{

	/** TSY supports the Multimode ETel v2.0 API.

	Modes: WCDMA */

	KETelExtMultimodeV2=7000,  // 7000 is unique reference for Multimode Etel v2.0 API

	/** TSY supports the MobileMultimediaCallSettings functional unit.

	Modes: WCDMA */

	KEtelFuncMobileMultimediaCallSettings,

	/** TSY supports the MobileNetworkSecurity functional unit.

	Modes: WCDMA */

	KEtelFuncMobileNetworkSecurity,

	KEtelFuncMobileUSIMApplications

	};

/**

Enum to define the v3.0 API additions

*/

enum TMultimodeETelV3Api

	{

	/**

	Indicator that the TSY supports the Multimode ETel v3.0 API.

	*/

	KETelExtMultimodeV3 = 10000,	

	/**

	TSY supports the MobileMMSInformation functional unit.

	*/

	KEtelFuncMobileMMSInformation,       // 10001

	/**

	TSY supports the KEtelFuncMobileAirTime functional unit.

	*/

	KEtelFuncMobileAirTime,              // 10002

	/**

	TSY supports the KEtelFuncMobileAutoRedial functional unit.

	*/

	KEtelFuncMobileAutoRedial,           // 10003

	/**

	TSY supports the KEtelFuncMobilePersonalisation functional unit.

	*/

	KEtelFuncMobilePersonalisation,      // 10004

	/**

	TSY supports the KEtelMobileMailboxNumbers functional unit.

	*/

	KEtelFuncMobileMailboxNumbers,       // 10005

	/**

	TSY supports the Mobile APN Control List functional unit.

	*/

	KEtelFuncMobileAPNControlList        // 10006

	};

/**

Enum to define the v4.0 API additions

*/

enum TMultimodeETelV4Api

	{

	/**

	Indicator that the TSY supports the Multimode ETel v4.0 API.

	*/

	KETelExtMultimodeV4	= 15000

	};

/** Enum to define Release 5 enabling API and data structures

*/

enum TMultimodeEtelV5Api

	{

	/**

	Indicator that the TSY supports the Multimode ETel v5.0 API.

	*/	

	KEtelExtMultimodeV5=20000,

	/**

	Indicator that the TSY supports the IMS functional unit.

	*/	

	KEtelFuncMobileIMS,                  // 20001

	/**

	TSY supports the KEtelFuncMobileSmartCardApplications functional unit.

	*/

	KEtelFuncMobileSmartCardApplications // 20002

	};

/**

Enum to define the v6.0 API additions.

*/

enum TMultimodeEtelV6Api

	{

	/**

	Indicator that the TSY supports the Multimode ETel v6.0 API.

	*/	

	KEtelExtMultimodeV6=25000,

	/**

	Indicator that the TSY supports the EAP supporting functional unit.

	*/	

	KEtelSmartCardEap                    // 25001

	};

/**

Enum to define the v7.0 API additions.

*/

enum TMultimodeEtelV7Api

	{

	/**

	Indicator that the TSY supports the Multimode ETel v7.0 API.

	*/	

	KEtelExtMultimodeV7=30000,

	/**

	Indicator that the TSY supports the LocationServices supporting functional unit.

	*/	

	KEtelLocationControlServices                    // 30001

	};		

/**

Enum to define the Etel 3rdParty V1 API additions

*/

enum TMultimodeETel3rdPartyV1Api 

	{

	/**

	Indicator that the TSY supports the Etel 3rd Party v1.0 API

	*/

	KETelExt3rdPartyV1 = 40000

	};

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

//

// Phone based functionality (RMobilePhone)

// 

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

class CMobilePhonePtrHolder;

class CMobilePhoneStoredNetworkList;

class RMobileSmartCardEap;

class RMobilePhone : public RPhone

/**

Provides client access to mobile phone functionality provided by TSY.

Encapsulates access to a mobile phone. The functionality of RMobilePhone 

is divided into a number of functional units, for the purpose of easier documentation 

and navigation and selectable support by TSY.

Note: Some RMobilePhone function members must be supported by the TSY while 

others are part of optional "functional unit" and only need to be supported 

if the TSY supports that functional unit. When a functional unit is mandatory 

then the unit should at least support the Get...Caps() member function to 

indicate the member functions that are supported for this unit.

*/

	{

public:

	friend class CAsyncRetrievePhoneList;

	IMPORT_C RMobilePhone();

	// Global multimode types

	class TMultimodeType

	/**

	Base class for all the V1 parameter types defined within the API.

	@publishedPartner

	@released

	*/

		{

	public:

		IMPORT_C TInt ExtensionId() const;

	protected:

		TMultimodeType();

		void InternalizeL(RReadStream& aStream);

		void ExternalizeL(RWriteStream& aStream) const;

	protected:

		TInt iExtensionId;

		};

	/** A typedef'd packaged TMultimodeType for passing through a generic API 

	function member. */

	typedef TPckg<TMultimodeType> TMultimodeTypePckg;

	// Types used in RMobilePhone::TMobileAddress

/** Address types.

Modes: Common */

	enum TMobileTON

		{

	/** User or the network has no knowledge of the type of number.