// Copyright (c) 2000-2009 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:

// Multimode ETel API v1.0

// Header file for asynchronous list retrieval classes

// 

//

/**

 @file

 @publishedPartner

*/

#ifndef _MMRETRIEVE_H_

#define _MMRETRIEVE_H_

#include <etelmm.h>

#include <mmlist.h>

#include <e32base.h>

#include <etelutils.h>

/**

This class is not intended for public use.  It is a stub class to maintain a consistent def file.  

CAsyncRetrieveVariableLengthBufferV2 declared in Etel should be used instead.

@see CAsyncRetrieveVariableLengthBufferV2

@publishedPartner

@released

*/

class CAsyncRetrieveVariableLengthBuffer : public CActive

	{

protected:

	IMPORT_C void Start(TRequestStatus& aReqStatus, TDes8* aPhase1Request, TDes8* aPhase2Request);

	IMPORT_C TBool CompleteIfInUse(TRequestStatus& aReqStatus);

	IMPORT_C void FreeBuffer();

private:

	IMPORT_C virtual void DoCancel();

	IMPORT_C virtual void RunL();

protected:

	CAsyncRetrieveVariableLengthBuffer();

	};

class CAsyncRetrieveWithClientIds : public CAsyncRetrieveVariableLengthBufferV2

/**

Base class that adds passing of client ID within each phase of the retrieval.

This class is not intended for public use.

@publishedPartner

@released

*/

	{

protected:

	CAsyncRetrieveWithClientIds(TInt aSessionHandle, TInt aSubSessionHandle);

protected:

	TPckgBuf<RMobilePhone::TClientId> iId;

	};

class CAsyncRetrieveStoreList : public CAsyncRetrieveWithClientIds

/**

Class that specialises in retrieving lists from phone store classes.

@publishedPartner

@released

*/

	{

public:

	CAsyncRetrieveStoreList(RMobilePhoneStore& aStore);

	~CAsyncRetrieveStoreList();

	virtual void Get(TInt aIpc, TRequestStatus& aReqStatus, TDes8& aDes1, TDes8& aDes2);

	virtual void CancelReq(TInt aIpc1, TInt aIpc2);

	/** Starts the 2 phase retrieval.

	@param aReqStatus On return, KErrNone if successful. */

	IMPORT_C void Start(TRequestStatus& aReqStatus);

protected:

	RMobilePhoneStore& iStore;

	};

class CAsyncRetrievePhoneList : public CAsyncRetrieveWithClientIds

/**

Class that specialises in retrieving lists from a phone or network

@publishedPartner

@released

*/

	{

public:

	IMPORT_C CAsyncRetrievePhoneList(RMobilePhone& aPhone);

	IMPORT_C ~CAsyncRetrievePhoneList();

	IMPORT_C virtual void Get(TInt aIpc, TRequestStatus& aReqStatus, TDes8& aDes1, TDes8& aDes2);

	IMPORT_C virtual void CancelReq(TInt aIpc1, TInt aIpc2);

protected:

	RMobilePhone& iPhone;

	};

class CRetrieveMobilePhoneDetectedNetworks : public CAsyncRetrievePhoneList

/**

Retrieves a list of all networks that are currently detected by 

the phone. 

Each detected network will be represented by an entry in the list 

class CMobilePhoneNetworkList, CMobilePhoneNetworkListV2 or 

CMobilePhoneNetworkListV5 or CMobilePhoneNetworkListV8 depending on which API method is used. 

Due to the probable time taken to retrieve a list, clients must use an asynchronous 

approach based around the use of this object.

@publishedPartner

@released

*/

	{

public:

	IMPORT_C static CRetrieveMobilePhoneDetectedNetworks* NewL(RMobilePhone& aPhone);

	IMPORT_C ~CRetrieveMobilePhoneDetectedNetworks();

	IMPORT_C void Start(TRequestStatus& aReqStatus);

	IMPORT_C void StartV2(TRequestStatus& aReqStatus);

	IMPORT_C void StartV5(TRequestStatus& aReqStatus);

	IMPORT_C void StartV8(TRequestStatus& aReqStatus);

	IMPORT_C CMobilePhoneNetworkList* RetrieveListL();

	IMPORT_C CMobilePhoneNetworkListV2* RetrieveListV2L();

	IMPORT_C CMobilePhoneNetworkListV5* RetrieveListV5L();

	IMPORT_C CMobilePhoneNetworkListV8* RetrieveListV8L();

protected:

	CRetrieveMobilePhoneDetectedNetworks(RMobilePhone& aPhone);

	void ConstructL();

	virtual void RestoreListL();

private:

	CMobilePhoneNetworkList* iResults;

	CMobilePhoneNetworkListV2* iResultsV2;

	CMobilePhoneNetworkListV5* iResultsV5;

	CMobilePhoneNetworkListV8* iResultsV8;

	TInt iListExtensionId;

	};

class CRetrieveMobilePhoneCFList : public CAsyncRetrievePhoneList

/** Retrieves the Call Forwarding status list from the phone.

Due to the probable time taken to retrieve a list, clients must use an asynchronous 

approach based around the use of this object.

@publishedPartner

@released 

*/

	{

public:

	// for use by client-side API code and TSY only

	struct TGetCallForwardingRequest

		{

		RMobilePhone::TClientId iClient;

		RMobilePhone::TMobilePhoneCFCondition iCondition;

		RMobilePhone::TMobileInfoLocation iLocation;

		RMobilePhone::TMobileService iServiceGroup;

		};

public:

	IMPORT_C static CRetrieveMobilePhoneCFList* NewL(RMobilePhone& aPhone);

	IMPORT_C ~CRetrieveMobilePhoneCFList();

	IMPORT_C void Start(TRequestStatus& aReqStatus, 

						RMobilePhone::TMobilePhoneCFCondition aCondition, 

						RMobilePhone::TMobileInfoLocation aLocation = RMobilePhone::EInfoLocationCachePreferred); /** @deprecated 7.0s.  Deprecated use other overload*/

	IMPORT_C void Start(TRequestStatus& aReqStatus, 

						RMobilePhone::TMobilePhoneCFCondition aCondition, 

						RMobilePhone::TMobileService aServiceGroup,

						RMobilePhone::TMobileInfoLocation aLocation = RMobilePhone::EInfoLocationCachePreferred

						);

	IMPORT_C CMobilePhoneCFList* RetrieveListL();

protected:

	CRetrieveMobilePhoneCFList(RMobilePhone& aPhone);

	void ConstructL();

	virtual void RestoreListL();

private:

	CMobilePhoneCFList* iResults;

	TPckgBuf<TGetCallForwardingRequest> iCFRequestData;

	};

class CRetrieveMobilePhoneCBList : public CAsyncRetrievePhoneList

/** Retrieves the Call Barring status list from the phone.

The following are all described as applicable to both GSM and CDMA because

although it is not possible to interrogate CDMA networks for call barring 

service status there is nothing inherently "GSM" about these types. So if 

the phone has attempted to internally support Call Barring in CDMA mode then 

these types are applicable.

Due to the probable time taken to retrieve a list, clients must use an asynchronous 

approach based around the use this object. 

@publishedPartner

@released

*/

	{

public:

	// for use by client-side API code and TSY only

	struct TGetCallBarringRequest

		{

		RMobilePhone::TClientId iClient;

		RMobilePhone::TMobilePhoneCBCondition iCondition;

		RMobilePhone::TMobileInfoLocation iLocation;

		};

public:

	IMPORT_C static CRetrieveMobilePhoneCBList* NewL(RMobilePhone& aPhone);

	IMPORT_C ~CRetrieveMobilePhoneCBList();

	IMPORT_C void Start(TRequestStatus& aReqStatus, 

						RMobilePhone::TMobilePhoneCBCondition aCondition, 

						RMobilePhone::TMobileInfoLocation aLocation = RMobilePhone::EInfoLocationCachePreferred);

	IMPORT_C CMobilePhoneCBList* RetrieveListL();

protected:

	CRetrieveMobilePhoneCBList(RMobilePhone& aPhone);

	void ConstructL();

	virtual void RestoreListL();

private:

	CMobilePhoneCBList* iResults;

	TPckgBuf<TGetCallBarringRequest> iCBRequestData;

	TInt iListExtensionId;

	};

class CRetrieveMobilePhoneCWList : public CAsyncRetrievePhoneList

/**

Retrieves the Call Waiting status list from the phone.

Due to the probable time taken to retrieve a list, clients must use an asynchronous 

approach based around the use this object.

@publishedPartner

@released

*/

	{

public:

	// for use by client-side API code and TSY only

	struct TGetCallWaitingRequest

		{

		RMobilePhone::TClientId iClient;

		RMobilePhone::TMobileInfoLocation iLocation;

		};

public:

	IMPORT_C static CRetrieveMobilePhoneCWList* NewL(RMobilePhone& aPhone);

	IMPORT_C ~CRetrieveMobilePhoneCWList();

	IMPORT_C void Start(TRequestStatus& aReqStatus,RMobilePhone::TMobileInfoLocation aLocation = RMobilePhone::EInfoLocationCachePreferred);

	IMPORT_C CMobilePhoneCWList* RetrieveListL();

protected:

	CRetrieveMobilePhoneCWList(RMobilePhone& aPhone);

	void ConstructL();

	virtual void RestoreListL();

private:

	CMobilePhoneCWList* iResults;

	TPckgBuf<TGetCallWaitingRequest> iCWRequestData;

	};

class CRetrieveMobilePhoneCcbsList : public CAsyncRetrievePhoneList

/** Retrieve a list of all active CCBS requests from the phone.

Each CCBS request will be represented by an entry in CMobilePhoneCcbsList. 

The client is able to use the member functions of this class to enumerate 

and read the CCBS request entries.

Due to the probable time taken to retrieve a list, clients must use an asynchronous 

approach based around the use of CRetrieveMobilePhoneCcbsList.

@publishedPartner

@released

*/

	{

public:

	IMPORT_C static CRetrieveMobilePhoneCcbsList* NewL(RMobilePhone& aPhone);

	IMPORT_C ~CRetrieveMobilePhoneCcbsList();

	IMPORT_C void Start(TRequestStatus& aReqStatus);

	IMPORT_C CMobilePhoneCcbsList* RetrieveListL();

protected:

	CRetrieveMobilePhoneCcbsList(RMobilePhone& aPhone);

	void ConstructL();

	virtual void RestoreListL();

private:

	CMobilePhoneCcbsList* iResults;

	};

class CRetrieveMobilePhoneSmsList : public CAsyncRetrieveStoreList

/** Reads stored, fixed length SMS message list from the phone or SIM message store

Instead of reading each message individually, a client may be able to retrieve 

multiple messages currently stored in one go. This functionality will be available 

if the TSY supports reading all SMS. The SMS storage capabilities are returned 

within the iCaps field of RMobilePhoneStore::TMobilePhoneStoreInfoV1 and this 

will inform a client what type(s) of storage access the TSY supports. These 

capabilities will also indicate whether the SMS store contains GSM/WCDMA or 

CDMA SMS messages. When all SMS entries in a store are read in one go, a list 

(CMobilePhoneGsmSmsList or CMobilePhoneCdmaSmsList) object will be returned 

to the client. This object will contain the message entries and the client

is able to use the function members of the list class to enumerate and read 

the message entries. 

Due to the probable time taken to retrieve a list, clients must use an asynchronous 

approach based around the use of this object. 

@publishedPartner

@released

*/

	{

public:

	IMPORT_C static CRetrieveMobilePhoneSmsList* NewL(RMobilePhoneStore& aStore, RMobileSmsStore::TMobileSmsEntryExtensionId aType);

	IMPORT_C ~CRetrieveMobilePhoneSmsList();

	enum

		{

		KValueNotUsed = -1

		};

	struct TBatchRequestData

		{

		RMobilePhone::TClientId iClient;

		RMobileSmsStore::TMobileSmsEntryExtensionId iEntryType;

		TBool iBatchRequest;

		TInt iStartIndex;

		TInt iBatchSize;

		};

	IMPORT_C void Start(TRequestStatus& aReqStatus);

	IMPORT_C void StartBatch(TRequestStatus& aReqStatus, TInt aStartIndex, TInt aBatchSize);

	IMPORT_C CMobilePhoneGsmSmsList* RetrieveGsmListL();

	/* 

	 @deprecated 9.5	  

	 */

	IMPORT_C CMobilePhoneCdmaSmsList* RetrieveCdmaListL();

protected:

	CRetrieveMobilePhoneSmsList(RMobilePhoneStore& aStore, RMobileSmsStore::TMobileSmsEntryExtensionId aType);

	void ConstructL();

	void InitiateRequest(TRequestStatus& aReqStatus, TBool aBatch, TInt aStartIndex, TInt aBatchSize);

	virtual void RestoreListL();

private:

	CMobilePhoneGsmSmsList* iGsmResults;

	CMobilePhoneCdmaSmsList* iCdmaResults;

	RMobileSmsStore::TMobileSmsEntryExtensionId iEntryType;

	TPckgBuf<TBatchRequestData> iRequestData;

	};

class CRetrieveMobilePhoneSmspList : public CAsyncRetrieveWithClientIds

/** Reads SMS parameter list from the SIM's SMSP store.

Instead of reading each SMSP entry individually, a client will retrieve all 

the entries currently stored in one go. A list object (CMobilePhoneSmspList) 

will be returned to the client. The list object that is returned to the client 

will contain an entry for each set of SMS parameters.

Due to the probable time taken to retrieve a list, clients must use an asynchronous 

approach based around the use of this object. 

@publishedPartner

@released

*/

	{

public:

	IMPORT_C static CRetrieveMobilePhoneSmspList* NewL(RMobileSmsMessaging& aMessaging);

	IMPORT_C ~CRetrieveMobilePhoneSmspList();

	IMPORT_C CMobilePhoneSmspList* RetrieveListL();

	IMPORT_C void Start(TRequestStatus& aReqStatus);

protected:

	CRetrieveMobilePhoneSmspList(RMobileSmsMessaging& aMessaging);

	void ConstructL();

	virtual void RestoreListL();

private:

	virtual void Get(TInt aIpc, TRequestStatus& aReqStatus, TDes8& aDes1, TDes8& aDes2);

	virtual void CancelReq(TInt aIpc1, TInt aIpc2);

private:

	RMobileSmsMessaging& iMessaging;

	CMobilePhoneSmspList* iResults;

	};

class CRetrieveMobilePhoneBroadcastIdList : public CAsyncRetrieveWithClientIds

/** Reads CBMI list from the phone. This list may be stored on SIM.

Due to the probable time taken to retrieve a list, clients must use an asynchronous 

approach based around the use of this class. 

@publishedPartner

@released

*/

	{

public:

		// for use by client-side API code and TSY only

	struct TGetBroadcastIdRequest

		{

		RMobileBroadcastMessaging::TMobileBroadcastIdType iIdType;

		RMobilePhone::TClientId iClient;

		};

public:

	IMPORT_C static CRetrieveMobilePhoneBroadcastIdList* NewL(RMobileBroadcastMessaging& aMessaging);

	IMPORT_C ~CRetrieveMobilePhoneBroadcastIdList();

	IMPORT_C CMobilePhoneBroadcastIdList* RetrieveListL();

	IMPORT_C void Start(TRequestStatus& aReqStatus, RMobileBroadcastMessaging::TMobileBroadcastIdType aIdType);

protected:

	CRetrieveMobilePhoneBroadcastIdList(RMobileBroadcastMessaging& aMessaging);

	void ConstructL();

	virtual void RestoreListL();

private:

	virtual void Get(TInt aIpc, TRequestStatus& aReqStatus, TDes8& aDes1, TDes8& aDes2);

	virtual void CancelReq(TInt aIpc1, TInt aIpc2);

protected:

	RMobileBroadcastMessaging& iMessaging;

	CMobilePhoneBroadcastIdList* iResults;

	TPckgBuf<TGetBroadcastIdRequest> iBroadcastIdRequestData;

	};

class CRetrieveMobilePhoneNamList : public CAsyncRetrieveStoreList

/** The phone's NAM store.

Instead of reading each NAM entry individually, a client may be able to retrieve 

all the parameters in one NAM in one go.

This functionality will be available if the TSY supports reading all entries