/*

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

		/**

		The current status of the lock.

		*/

		TIccLockStatus iStatus;

		/**

		The current availability of the lock. When not available (i.e. the

		lock is not in use) then its status will always be CTelephony::EStatusUnlocked.

		*/

		TIccLockSetting iSetting;

		};

	/**

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

	*/

	typedef TPckg<TIccLockInfoV1> TIccLockInfoV1Pckg;

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

// Line Functionality

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

	/**

	Line types

	*/

	enum TPhoneLine

		{

		/**

		Voice line.

		*/

		EVoiceLine,

		/**

		Data line.

		*/

		EDataLine,

		/**

		Fax line.

		*/

		EFaxLine,

		};

	/**

	Describes the possible call or line states.

	*/

	enum TCallStatus

		{

		/**

		Indicates that the status is unknown.

		*/

		EStatusUnknown,

		/**

		Idle line status (no active calls).

		*/

		EStatusIdle,

		/**

		Call dialling status .

		*/

		EStatusDialling,

		/**

		Call ringing status.

		*/

		EStatusRinging,

		/**

		Call answering status.

		*/

		EStatusAnswering,

		/**

		Call connecting status.

		*/

		EStatusConnecting,

		/**

		Call connected status.

		*/

		EStatusConnected,

		/**

		Call is undergoing temporary channel loss and it may or may not be reconnected.

		*/

		EStatusReconnectPending,

		/**

		Call disconnecting status.

		*/

		EStatusDisconnecting,

		/**

		Call on hold.

		*/

		EStatusHold,

		/**

		Call is transferring.

		*/

		EStatusTransferring,

		/**

		Call in transfer is alerting the remote party.

		*/

		EStatusTransferAlerting

		};

	class TCallStatusV1 : public TEtelISVType

	/**

	Defines the current call or line status.

	*/

		{

	public:

		IMPORT_C TCallStatusV1();

	public:

		/**

		The current call or line status.

		*/

		TCallStatus iStatus;

		};

	/**

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

	*/

	typedef TPckg<TCallStatusV1> TCallStatusV1Pckg;

	/**

	Select a call defined by it current stats.

	*/

	enum TCallSelect

		{

		/**

		Currently active call.

		*/

		EActiveCall,

		/**

		Currently held (applicable only for voice) call.

		*/

		EHeldCall,

		/**

		Call during the setup/disconnecting process - (dialling/connecting/answering/hanging up).

		*/

		EInProgressCall

		};

	class TCallSelectionV1 : public TEtelISVType

	/**

	Defines parameters to select a call, determined by its call state for a specific line

	*/

		{

	public:

		IMPORT_C TCallSelectionV1();

	public:

		/**

		The current phone line selection.

		*/

		TPhoneLine iLine;

		/**

		The current call selection.

		*/

		TCallSelect iSelect;

		};

	/**

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

	*/

	typedef TPckg<TCallSelectionV1> TCallSelectionV1Pckg;

	/**

	Etel 3rd Party owned call identifiers

	*/

	enum TCallId

		{

		/**

		Call owned by this ISV application.

		*/

		EISVCall1,

		/**

		Call owned by this ISV application.

		*/

		EISVCall2,

		/**

		Max number of calls supported by Etel 3rd Party.

		*/

		EISVMaxNumOfCalls

		};

	/**

	Remote party identity status.

	*/

	enum TCallRemoteIdentityStatus

		{

		/**

		The remote party's identity can not be determined.

		*/

		ERemoteIdentityUnknown,

		/**

		The remote party's identity is available.

		*/

		ERemoteIdentityAvailable,

		/**

		The remote party has suppressed the transmission of its identity.

		*/

		ERemoteIdentitySuppressed

		};

	/**

	The direction of the call.

	*/

	enum TCallDirection

		{

		/**

		The direction of the call is unknown.

		*/

		EDirectionUnknown,

		/**

		The call was originated by this phone, i.e. it is an outgoing call.

		*/

		EMobileOriginated,

		/**

		The call was terminated by this phone, i.e. it is an incoming call.

		*/

		EMobileTerminated

		};

	/**

	Enumerated network security types.

	*/

	enum TPhoneNetworkSecurity

		{

		/**

		The encryption level is NONE.

		*/

		ECipheringOff,

		/**

		The encryption level is GSM.(standard encryption algorithms for 2nd Generation Mobile networks).

		*/

		ECipheringGSM,

		/**

		The encryption level is WDCMA.(standard encryption algorithms for 3rd Generation Mobile networks).

		*/

		ECipheringWCDMA

		};

	class TCallInfoV1 : public TEtelISVType

	/**

	Defines general information about a call.

	*/

		{

	public:

		IMPORT_C TCallInfoV1();

	public:

		/**

		The current status of the call.

		*/

		TCallStatus iStatus;

		/**

		The time & date the call started.

		*/

		TDateTime iStartTime;

		/**

		The current duration of the call.

		*/

		TTimeIntervalSeconds iDuration;

		/**

		The original number (including DTMF) dialled for an outgoing call.

		*/

		TTelAddress iDialledParty;

		/**

		The reason for termination of a finished call.

		Will equal KErrNone if the call ended normally and KErrNotFound if the call has not ended.

		*/

		TInt iExitCode;

		/**

		This attribute indicates whether Ciphering Status of a Call is enabled or disabled.

		*/

		TPhoneNetworkSecurity iSecurity;

		/**

		The call id of an ISV application owned call. For calls not owned by this ISV application (-1) is returned.

		*/

		TInt iCallId;

		};

	/**

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

	*/

	typedef TPckg<TCallInfoV1> TCallInfoV1Pckg;

	/**

	Maximum size of the calling party name.

	*/

	enum { KCallingNameSize = 80 };

	class TRemotePartyInfoV1 : public TEtelISVType

		{

		/**

		Defines information about the remote party of a call.

		*/

	public:

		IMPORT_C TRemotePartyInfoV1();

	public:

		/**

		Indicates whether the remote party information in the rest of this structure is valid or not.

		*/

		TCallRemoteIdentityStatus iRemoteIdStatus;

		/**

		Calling party name available through the CNAP supplementary service (if provisioned).

		*/

		TBuf<KCallingNameSize> iCallingName;

		/**

		The phone number of the remote party if available.

		*/

		TTelAddress iRemoteNumber;

		/**

		The direction of the call and hence the role of the remote party.

		i.e. if the call is mobile originated then the remote party is the called party.

		Whereas if the call is mobile terminated then the remote party is the calling party.

		*/

		TCallDirection iDirection;

		};

	/**

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

	*/

	typedef TPckg<TRemotePartyInfoV1> TRemotePartyInfoV1Pckg;

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

// Call Functionality

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

	/**

	Caller Id restriction settings.

	*/

	enum TCallerIdentityRestrict

		{

		/**

		The default setting should be used if the user has not explicitly requested their identity to be restricted/allowed.

		*/

		EIdRestrictDefault,

		/**

		The user has explicitly requested their identity to be sent for this call.

		*/

		ESendMyId,

		/**

		The user has explicitly requested their identity not to be sent for this call.

		*/

		EDontSendMyId

		};

	class TCallParamsV1 : public TEtelISVType

		{

		/**

		Defines the parameters used for set-up of a call.

		*/

	public:

		IMPORT_C TCallParamsV1();

	public:

		/**

		Call Id restriction setting to be used for this call.

		*/

		TCallerIdentityRestrict iIdRestrict;

		};

	/**

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

	*/

	typedef TPckg<TCallParamsV1> TCallParamsV1Pckg;

	/**

	Mobile call control capabilities.

	*/

	enum TMobileCallControlCaps

		{

		/**

		Indicates that this call can be put on hold.

		This implies that the call is currently active and that there is no other held call.

		*/

		KCapsHold 	= 0x00000200,

		/**

		Indicates that this call can be resumed.

		This implies that the call is currently on hold and that there is no other active call.

		*/

		KCapsResume = 0x00000400,

		/**

		Indicates that this call's state can be swapped to the opposite state.

		This implies that this call is either active or held.

		There may be another call in the opposite state and if this is the case then both calls will be simultaneously swapped to their opposite state.

		*/

		KCapsSwap 	= 0x00000800

		};

	class TCallCapsV1 : public TEtelISVType

		{

		/**

		Defines the dynamic capabilities of a call.

		@see TMobileCallControlCaps

		*/

	public:

		IMPORT_C TCallCapsV1();

	public:

		/**

		Call Id restriction setting to be used for this call.

		It is the sum of CTelephony::TMobileCallControlCaps constants.

		*/

		TUint32 iControlCaps;

		};

	/**

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

	*/

	typedef TPckg<TCallCapsV1> TCallCapsV1Pckg;

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

// Network Functionality

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

	/**

	The registration status of the phone.

	*/

	enum TRegistrationStatus

		{

		/**

		Registration status is unknown.

		*/

		ERegistrationUnknown,

		/**

		Not registered. The ME can not detect any other networks and is not currently searching a new operator to register to.

		*/

		ENotRegisteredNoService,

		/**

		Not registered. The ME can detect other networks on which it is possible to make emergency calls only.

		*/

		ENotRegisteredEmergencyOnly,

		/**

		Not registered, but the ME is currently searching a new operator to register to.

		*/

		ENotRegisteredSearching,

		/**

		Registered, network busy.

		*/

		ERegisteredBusy,

		/**

		Registered on home network.

		*/

		ERegisteredOnHomeNetwork,

		/**

		Registration denied.

		*/

		ERegistrationDenied,

		/**

		Registered, roaming.

		*/

		ERegisteredRoaming

		};

	class TNetworkRegistrationV1 : public TEtelISVType

		/**

		Defines the current network registration status

		*/

		{

	public:

		IMPORT_C TNetworkRegistrationV1();

	public:

		/**

        The current network registration status.

		*/

		TRegistrationStatus iRegStatus;

		};

	/**

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

	*/

	typedef TPckg<TNetworkRegistrationV1> TNetworkRegistrationV1Pckg;

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

	// CTelephony::TNetworkInfoV1

	/**