epoc32/include/app/smutsimparam.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/smutsimparam.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
williamr@2
     1
// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __SMUTSIMPARAM_H__
williamr@2
    17
#define __SMUTSIMPARAM_H__
williamr@2
    18
williamr@2
    19
#include <msvapi.h>
williamr@2
    20
#include <smcmmain.h>
williamr@2
    21
williamr@2
    22
/**
williamr@2
    23
The UID for the stream into which the SIM parameters are stored.
williamr@2
    24
williamr@2
    25
@internalComponent
williamr@2
    26
@deprecated
williamr@2
    27
Should be moved to the cpp file for this class.
williamr@2
    28
*/
williamr@2
    29
const TUid KUidMsvSimSmsParams = {0x100081BC};
williamr@2
    30
williamr@2
    31
class CMobilePhoneSmspList;
williamr@2
    32
class TSmsProgress;
williamr@2
    33
williamr@2
    34
/**
williamr@2
    35
A packaged TInt value.
williamr@2
    36
williamr@2
    37
This is used by CSmsSimParamOperation.
williamr@2
    38
williamr@2
    39
@see CSmsSimParamOperation::ProgressL()
williamr@2
    40
williamr@2
    41
@internalComponent
williamr@2
    42
@released
williamr@2
    43
*/
williamr@2
    44
typedef TPckgBuf<TInt> TIntBuf;
williamr@2
    45
williamr@2
    46
/**
williamr@2
    47
Encapsulates an operation to read/write an array of SMS parameters from a SIM.
williamr@2
    48
williamr@2
    49
An operation of this type if returned by the SMS client MTM for the read and
williamr@2
    50
write SIM paramter operations.
williamr@2
    51
williamr@2
    52
These operations are generated from calling the SMS client MTM APIs 
williamr@2
    53
CSmsClientMtm::ReadSimParamsL and CSmsClientMtm::WriteSimParamsL. The 
williamr@2
    54
CSmsClientMtm::InvokeAsyncFunctionL API should not be used for these operations.
williamr@2
    55
williamr@2
    56
@see	CSmsClientMtm::ReadSimParamsL
williamr@2
    57
@see	CSmsClientMtm::WriteSimParamsL
williamr@2
    58
williamr@2
    59
@publishedAll
williamr@2
    60
@released
williamr@2
    61
*/
williamr@2
    62
class CSmsSimParamOperation : public CMsvOperation
williamr@2
    63
	{
williamr@2
    64
public:
williamr@2
    65
williamr@2
    66
	static CSmsSimParamOperation* ReadSimParamsL(TUid aMtm, TMsvId aService, CMsvSession& aMsvSession, TRequestStatus& aObserverRequestStatus);
williamr@2
    67
	static CSmsSimParamOperation* WriteSimParamsL(const CMobilePhoneSmspList& aList, TUid aMtm, TMsvId aService, CMsvSession& aMsvSession, TRequestStatus& aObserverRequestStatus);
williamr@2
    68
	virtual ~CSmsSimParamOperation();
williamr@2
    69
williamr@2
    70
	inline const CMobilePhoneSmspList& SmspList() const;
williamr@2
    71
williamr@2
    72
	IMPORT_C CMobilePhoneSmspList* ServiceCentersLC() const;
williamr@2
    73
	IMPORT_C const TDesC8& ProgressL();
williamr@2
    74
williamr@2
    75
	IMPORT_C static void RestoreSimParamsL(CMsvStore& aStore, CMobilePhoneSmspList& aList);
williamr@2
    76
	IMPORT_C static void StoreSimParamsL(CMsvStore& aStore, const CMobilePhoneSmspList& aList);
williamr@2
    77
williamr@2
    78
private:	// methods from CActive
williamr@2
    79
williamr@2
    80
	virtual void RunL();
williamr@2
    81
	virtual void DoCancel();
williamr@2
    82
	virtual TInt RunError(TInt aError);
williamr@2
    83
williamr@2
    84
private:
williamr@2
    85
williamr@2
    86
	CSmsSimParamOperation(TUid aMtm, TMsvId aService, CMsvSession& aMsvSession, TRequestStatus& aObserverRequestStatus);
williamr@2
    87
williamr@2
    88
	void DoReadSimParamsL();
williamr@2
    89
	void DoRunReadSimParamsL(/*TSmsProgress aProgress*/);
williamr@2
    90
	void DoWriteSimParamsL(const CMobilePhoneSmspList& aList);
williamr@2
    91
williamr@2
    92
	void TransferCommandL(TInt aCommandId);
williamr@2
    93
	void Complete();
williamr@2
    94
williamr@2
    95
private:
williamr@2
    96
williamr@2
    97
/**
williamr@2
    98
This defines the state machine.
williamr@2
    99
*/
williamr@2
   100
	enum TReadSimParamsState
williamr@2
   101
		{
williamr@2
   102
/**
williamr@2
   103
Specifies waiting state
williamr@2
   104
*/
williamr@2
   105
		EStateWaiting,
williamr@2
   106
/**
williamr@2
   107
Specifies reading state
williamr@2
   108
*/
williamr@2
   109
		EStateReadingSimParams,	 
williamr@2
   110
/**
williamr@2
   111
Specifies writing state
williamr@2
   112
*/
williamr@2
   113
		EStateWritingSimParams
williamr@2
   114
		} iState;
williamr@2
   115
williamr@2
   116
/**
williamr@2
   117
A list containing the SMS parameters
williamr@2
   118
*/
williamr@2
   119
	CMobilePhoneSmspList* iSimParams;	
williamr@2
   120
	TInt iError;
williamr@2
   121
	TIntBuf iProgressBuf;
williamr@2
   122
	CMsvOperation* iOperation;
williamr@2
   123
	};
williamr@2
   124
williamr@2
   125
/**
williamr@2
   126
Gets the list of SMS parameters on the SIM, after a successfully completed 
williamr@2
   127
read operation.
williamr@2
   128
williamr@2
   129
If the operation has not successfully completed, this function returns an 
williamr@2
   130
empty list.
williamr@2
   131
williamr@2
   132
This function should ot be used with a write SIM parameters operation.
williamr@2
   133
williamr@2
   134
@return
williamr@2
   135
The list of SMS parameters read from the SIM.
williamr@2
   136
williamr@2
   137
@panic	SMCM	3
williamr@2
   138
This operation was not reading the SIM parameters. The operation was not returned
williamr@2
   139
from CSmsClientMtm::ReadSimParamsL (debug only).
williamr@2
   140
*/
williamr@2
   141
inline const CMobilePhoneSmspList& CSmsSimParamOperation::SmspList() const
williamr@2
   142
	{
williamr@2
   143
	__ASSERT_DEBUG(iState == EStateReadingSimParams, Panic(ESmscPanicUnexpectedCommand));
williamr@2
   144
	return *iSimParams;
williamr@2
   145
	}
williamr@2
   146
williamr@2
   147
#endif // __SMUTSIMPARAM_H__