/*

* Copyright (c) 2009 Sony Ericsson Mobile Communications AB

* 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:

* Sony Ericsson Mobile Communications AB - initial contribution.

* Nokia Corporation - additional changes.

* 

* Contributors:

* 

* Description:

* Etel3rdParty.dll interface, using CTelephony class defined here.

* Etel 3rd Party API Header file

* Describes the Etel 3rd Party API - classes, methods and types.

*

*/

/**

 @file

*/

#ifndef ETEL3RDPARTY_H__

#define ETEL3RDPARTY_H__

#include <e32base.h>

const TInt	KTelephonyMajorVersionNumber=7; ///< Major version-number

const TInt	KTelephonyMinorVersionNumber=0; ///< Minor version-number

const TInt	KTelephonyBuildVersionNumber=0; ///< Build version-number

// Panic numbers returned to applications. 0 upwards...

const TInt KTelephonyPanicIllegalReuse = 0;	///< Client code has attempted to re-post an asynchronous request before the original request has completed.

class CTelephonyFunctions;		// forward declaration

/**

This class provides a simple interface to the phone's telephony

system. It provides two services:

1. You can find out information about the phone. This class

provides support for retrieving Phone Settings, Line Information, Call

Functionality, Network Information and (basic) Supplementary Service

Settings.

2. You can dial, answer and control voice calls.  You cannot make fax or data calls.

Architecturally, CTelephony provides an interface to the Telephony

Multimode API.  This interface exposes only a subset of the complete

Multimode functionality.

Note that a CActiveScheduler is required to be installed for all asynchronous CTelephony calls. 

@publishedAll

@released

 */

class CTelephony : public CBase

	{

public:

//////////////////////////////////////////////////////////

//General Functionality

//////////////////////////////////////////////////////////

	/**

	Unique parameter class identifier.

	*/

	enum

		{

		/**

		Unique reference identifier for Etel 3rd Party v1.0 parameter classes.

		*/

		KEtelISVV1 = 1,

		/**

		Unique reference identifier for Etel 3rd Party v2.0 parameter classes.

		*/

		KEtelISVV2 = 2

		};

	class TEtelISVType

	/**

	Specifies which version of an API parameter a client has used.

 	For most ETel ISV v1.0/2.0 parameters this will equal KETelISV1.

	*/

		{

	public:

		IMPORT_C TInt VersionId() const;

	protected:

		TEtelISVType();

	protected:

		TInt iVersionId;

		};

	/**

	The maximum number of digits allowed in a multimode telephone number.

	*/

	enum { KMaxTelNumberSize = 100 };

	/**

	Address types.

	*/

	enum TTelNumberTON

		{

		/**

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

	    */

		EUnknownNumber,

		/**

		International number.

	    */

		EInternationalNumber,

		/**

		National number.

	    */

		ENationalNumber,

		/**

		Administration/service number specific to the serving network, e.g. used to

		access an operator.

	    */

		ENetworkSpecificNumber,

		/**

		Subscriber number.

	    */

		ESubscriberNumber,

		/**

		Alphanumeric number.

	    */

		EAlphanumericNumber,

		/**

		Abbreviated number.

	    */

		EAbbreviatedNumber

		};

	/**

	Number Plan Indicator.

	*/

	enum TTelNumberNPI

		{

		/**

		User or the network has no knowledge of the numbering plan.

	    */

		EUnknownNumberingPlan		= 0,

		/**

		ISDN/telephony numbering plan.

	    */

		EIsdnNumberPlan				= 1,

		/**

		Data numbering plan.

	    */

		EDataNumberPlan				= 3,

		/**

		Telex numbering plan.

	    */

		ETelexNumberPlan			= 4,

		/**

		Service centre specific plan used to indicate a numbering plan specific to external

		Short Message entities attached to the SMSC.

	    */

		EServiceCentreSpecificPlan1	= 5,

		/**

		Service centre specific plan used to indicate a numbering plan specific to external

		Short Message entities attached to the SMSC.

	    */

		EServiceCentreSpecificPlan2	= 6,

		/**

		National numbering plan.

	    */

		ENationalNumberPlan			= 8,

		/**

		Private numbering plan.

	    */

		EPrivateNumberPlan			= 9,

		/**

		ERMES numbering plan.

	    */

		EERMESNumberPlan			= 10

		};

	/**

	A typedef to hold the telephone number.

	*/

	typedef TBuf<KMaxTelNumberSize> TTelNumber;

	class TTelAddress

	/**

	Defines API abstraction of a mobile telephone number.

	*/

		{

	public:

		IMPORT_C TTelAddress();

	public:

		/**

		Type of number.

		*/

		TTelNumberTON 				iTypeOfNumber;

		/**

		Number plan.

		*/

		TTelNumberNPI 				iNumberPlan;

		/**

		Telephone number.

		*/

		TTelNumber					iTelNumber;

		};

//////////////////////////////////////////////////////////

// Phone Functionality

//////////////////////////////////////////////////////////

	/**

	Max size of Manufacturer Id.

	*/

	enum { KPhoneManufacturerIdSize = 50 };

	/**

	Max size of Phone Model Id.

	*/

	enum { KPhoneModelIdSize 		= 50 };

	/**

	Max size ofSerial Number.

	*/

	enum { KPhoneSerialNumberSize 	= 50 };

	class TPhoneIdV1 : public TEtelISVType

	/**

	Defines the mobile phone identity.

	*/

		{

	public:

		IMPORT_C TPhoneIdV1();

	public:

		/**

		Phone manufacturer identification, in character string format.

		*/

		TBuf<KPhoneManufacturerIdSize> 	iManufacturer;

		/**

		Phone model identification, in character string format.

		*/

		TBuf<KPhoneModelIdSize> 		iModel;

		/**

		Phone serial number (IMEI or ESN), in character string format.

		*/

		TBuf<KPhoneSerialNumberSize> 	iSerialNumber;

		};

	/**

	A typedef'd packaged CTelephony::TPhoneIdV1 for passing through a generic API method

	*/

	typedef TPckg<TPhoneIdV1> TPhoneIdV1Pckg;

	/**

	Maximum size of IMSI identifier.

	*/

	enum { KIMSISize = 15 };

	class TSubscriberIdV1 : public TEtelISVType

	/**

	Defines the Subscriber (IMSI) Id

	*/

		{

	public:

		IMPORT_C TSubscriberIdV1();

	public:

		/**

		IMSI identifier.

		*/

		TBuf<KIMSISize> iSubscriberId;

		};

	/**

	A typedef'd packaged CTelephony::TSubscriberIdV1 for passing through a generic API method.

	*/

	typedef TPckg<TSubscriberIdV1> TSubscriberIdV1Pckg;

	/**

	The flight mode status.

	*/

	enum TFlightModeStatus

		{

		/**

		Flight mode is off.

		*/

		EFlightModeOff	= 0,

		/**

		Flight mode is on.

		*/

		EFlightModeOn	= 1,

		};

	class TFlightModeV1 : public TEtelISVType

	/**

	Defines the flight mode status.

	*/

		{

	public:

		IMPORT_C TFlightModeV1();

	public:

		/**

		The current status of the mobile radio interface and bluetooth.

		*/

		TFlightModeStatus iFlightModeStatus;

		};

	/**

	A typedef'd packaged CTelephony::TFlightModeV1 for passing through a generic API method.

	*/

	typedef TPckg<TFlightModeV1> TFlightModeV1Pckg;

	/**

	The mobile phone indicators.

	*/

	enum TPhoneIndicators

		{

		/**

		If bit-flag is set to '1' indicates that the battery charger

		is connected to the phone. If bit-flag is set to '0' indicates

		that the battery charger is disconnected

		For capability: If bit-flag is set to '0' indicates that the

		battery charger indication reporting is unavailable.

		*/

		KIndChargerConnected	= 0x00000001,

		/**

		If bit-flag is set to '1' indicates that network service is

		available. If bit-flag is set to '0' indicates that network

		service is unavailable

		For capability: If bit-flag is set to '0' indicates that the

		network availability indication reporting is unavailable.

		*/

		KIndNetworkAvailable	= 0x00000002,

		/**

		If bit-flag is set to '1' indicates that a call is in

		progress. If set to '0' indicates that a call is not in

		progress

		For capability: If bit-flag is set to '0' indicates

		that the call is in progress indication reporting is

		unavailable.

		*/

		KIndCallInProgress		= 0x00000004

		};

	class TIndicatorV1 : public TEtelISVType

	/**

	Contains indicator parameters:

	@see TPhoneIndicators

	*/

		{

	public:

		IMPORT_C TIndicatorV1();

	public:

		/**

		The value of the indicators.  It is the sum

		of CTelephony::TPhoneIndicators constants.

		*/

		TUint32 iIndicator;

		/**

		The supported (available) indicator capability that the telephony service module offers.

		It is the sum of CTelephony::TPhoneIndicators constants.

		*/

		TUint32 iCapabilities;

		};

	/**

	A typedef'd packaged CTelephony::TIndicatorV1 for passing through a generic API method.

	*/

	typedef TPckg<TIndicatorV1> TIndicatorV1Pckg;

	/**

	The mobile phone battery status.

	*/

	enum TBatteryStatus

		{

		/**

		The phone software can not determine the phone's current power status.

		*/

		EPowerStatusUnknown,

		/**

		The phone is powered by the battery.

		*/

		EPoweredByBattery,

		/**

		A battery is connected, but the phone is externally powered.

		*/

		EBatteryConnectedButExternallyPowered,

		/**

		No battery is connected.

		*/

		ENoBatteryConnected,

		/**

		Power fault.

		*/

		EPowerFault

		};

	class TBatteryInfoV1 : public TEtelISVType

	/**

	Defines contents of the battery status of the phone.

	*/

		{

	public:

		IMPORT_C TBatteryInfoV1();

	public:

		/**

		The power and battery status.

		*/

		TBatteryStatus iStatus;

		/**

		The percentage battery charge level.

		*/

		TUint iChargeLevel;

		};

	/**

	A typedef'd packaged CTelephony::TBatteryInfoV1 for passing through a generic API method.

	*/

	typedef TPckg<TBatteryInfoV1> TBatteryInfoV1Pckg;

	class TSignalStrengthV1 : public TEtelISVType

	/**

	Defines the phone's current signal strength.

	*/

		{

	public:

		IMPORT_C TSignalStrengthV1();

	public:

		/**

		The value of signal strength.

		*/

		TInt32 iSignalStrength;

		/**

		The absolute number of signal "bars" that the phone should display.

		*/

		TInt8 iBar;

		};

	/**

	A typedef'd packaged CTelephony::TSignalStrengthV1 for passing through a generic API method.

	*/

	typedef TPckg<TSignalStrengthV1> TSignalStrengthV1Pckg;

	/**

	Pin 1/Pin 2 security

	*/

	enum TIccLock

		{

		/**

		Lock PIN1 on the ICC.

		*/

		ELockPin1,

		/**

		Lock PIN2 on the ICC.

		*/

		ELockPin2

		};

	/**

	Status of an ICC lock.

	*/

	enum TIccLockStatus

		{

		/**

		The status of the lock is unknown.

		*/

		EStatusLockUnknown,

		/**

		Lock is closed.

		User can not access functionality governed by this lock until

		user correctly enters associated security code.

		*/

		EStatusLocked,

		/**

		Lock is open.

		User can access functionality governed by this lock

		*/

		EStatusUnlocked,

		/**

		Lock is blocked.

		User should enter the unblocking code to be able to switch back to the unlocked mode.

		Blocking is enabled after a number of unsuccessful attempts to verify PIN1/2.

		*/

		EStatusBlocked

		};

	/**

	Setting of the ICC lock.

	*/

	enum TIccLockSetting

		{

		/**

		The setting of the lock is unknown.

		*/

		ELockSetUnknown,

		/**

		Lock is enabled, and is available for use. Its status may be

		CTelephony::EStatusLocked, CTelephony::EStatusUnlocked,

		or CTelephony::EStatusBlocked.

		The associated security code will be required to unlock the lock

		the next time the lock's status is CTelephony::EStatusLocked.

		*/

		ELockSetEnabled,

		/**

		Lock is disabled.  It is not available for use, so its status

		is always CTelephony::EStatusUnlocked.

		*/

		ELockSetDisabled

		};

	class TIccLockInfoV1 : public TEtelISVType

	/**

	Defines the Icc Lock parameters.

	*/

		{

	public:

		IMPORT_C TIccLockInfoV1();

	public:

		/**