Telephony/ctsydispatchlayer/exportinc/mltsydispatchsiminterface.h
changeset 22 e3587ca0d5e1
parent 21 ab1d0f4d2aa4
equal deleted inserted replaced
21:ab1d0f4d2aa4 22:e3587ca0d5e1
     1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
   480 	 * It is a request call that is completed by invoking
   480 	 * It is a request call that is completed by invoking
   481 	 * CCtsyDispatcherCallback::CallbackSimGetAnswerToResetComp()
   481 	 * CCtsyDispatcherCallback::CallbackSimGetAnswerToResetComp()
   482 	 * 
   482 	 * 
   483 	 * Implementation of this interface should retrieve the answer to reset. 
   483 	 * Implementation of this interface should retrieve the answer to reset. 
   484 	 *
   484 	 *
   485 	 * @param aAnswerToReset The answer to reset information which contains details of the request.
   485 	 * @return KErrNone on success, otherwise another error code indicating the
   486 	 *
   486 	 * failure.
   487 	 * @return KErrNone on success, otherwise another error code indicating the
   487 	 */
   488 	 * failure.
   488 	virtual TInt HandleGetAnswerToResetReqL() = 0;
   489 	 */
       
   490 	virtual TInt HandleGetAnswerToResetReqL(const TDesC8& aAnswerToReset) = 0;
       
   491 
   489 
   492 	}; // class MLtsyDispatchSimGetAnswerToReset
   490 	}; // class MLtsyDispatchSimGetAnswerToReset
   493 
   491 
   494 
   492 
   495 class MLtsyDispatchSimGetSimCardReaderStatus : public MLtsyDispatchInterface
   493 class MLtsyDispatchSimGetSimCardReaderStatus : public MLtsyDispatchInterface
   530 	 * CCtsyDispatcherCallback::CallbackSimGetSimAuthenticationEapSimDataComp()
   528 	 * CCtsyDispatcherCallback::CallbackSimGetSimAuthenticationEapSimDataComp()
   531 	 * 
   529 	 * 
   532 	 * Implementation of this interface should retrieve Sim Authentication Data for EapSim authentication method.
   530 	 * Implementation of this interface should retrieve Sim Authentication Data for EapSim authentication method.
   533 	 *
   531 	 *
   534 	 * @param aRandomParameters The random parameters from the client.
   532 	 * @param aRandomParameters The random parameters from the client.
   535 	 * @param aRFStateInfo The RF state info.
   533 	 * 
   536 	 * 
   534 	 * @return KErrNone on success, otherwise another error code indicating the
   537 	 * @return KErrNone on success, otherwise another error code indicating the
   535 	 * failure.
   538 	 * failure.
   536 	 */
   539 	 */
   537 	virtual TInt HandleGetSimAuthenticationEapSimDataReqL(const TDesC8& aRandomParameters) = 0;
   540 	virtual TInt HandleGetSimAuthenticationEapSimDataReqL(const TDesC8& aRandomParameters, TInt aRFStateInfo) = 0;
       
   541 
   538 
   542 	}; // class MLtsyDispatchSimGetSimAuthenticationEapSimData
   539 	}; // class MLtsyDispatchSimGetSimAuthenticationEapSimData
   543 
   540 
   544 class MLtsyDispatchSimGetSimAuthenticationEapAkaData : public MLtsyDispatchInterface
   541 class MLtsyDispatchSimGetSimAuthenticationEapAkaData : public MLtsyDispatchInterface
   545 	{
   542 	{
   558 	 * Implementation of this interface should retrieve Sim Authentication Data for EapAka authentication method.
   555 	 * Implementation of this interface should retrieve Sim Authentication Data for EapAka authentication method.
   559 	 *
   556 	 *
   560 	 * @param aRandomParameters The random parameters from the client.
   557 	 * @param aRandomParameters The random parameters from the client.
   561 	 * @param aAUTN The AUTN parameter. AUTN is an authentication value generated by
   558 	 * @param aAUTN The AUTN parameter. AUTN is an authentication value generated by
   562 	 *        the Authentication Centre, which, together with the random parameters, authenticates the server to the peer, 128 bits.
   559 	 *        the Authentication Centre, which, together with the random parameters, authenticates the server to the peer, 128 bits.
   563 	 * @param aRFStateInfo The RF state info.
   560 	 *
   564 	 *
   561 	 * @return KErrNone on success, otherwise another error code indicating the
   565 	 * @return KErrNone on success, otherwise another error code indicating the
   562 	 * failure.
   566 	 * failure.
   563 	 */
   567 	 */
   564 	virtual TInt HandleGetSimAuthenticationEapAkaDataReqL(const TDesC8& aRandomParameters, const TDesC8& aAUTN) = 0;
   568 	virtual TInt HandleGetSimAuthenticationEapAkaDataReqL(const TDesC8& aRandomParameters, const TDesC8& aAUTN, TInt aRFStateInfo) = 0;
       
   569 
   565 
   570 	}; // class MLtsyDispatchSimGetSimAuthenticationEapAkaData
   566 	}; // class MLtsyDispatchSimGetSimAuthenticationEapAkaData
   571 
   567 
   572 class MLtsyDispatchSimPowerSimOff : public MLtsyDispatchInterface
   568 class MLtsyDispatchSimPowerSimOff : public MLtsyDispatchInterface
   573 	{
   569 	{
   770 	virtual TInt HandleSetSimMessageStatusReadReqL(const TTime& aTimestamp, TInt aTimezoneDiff) = 0;
   766 	virtual TInt HandleSetSimMessageStatusReadReqL(const TTime& aTimestamp, TInt aTimezoneDiff) = 0;
   771 
   767 
   772 	}; // class MLtsyDispatchSimSetSimMessageStatusRead
   768 	}; // class MLtsyDispatchSimSetSimMessageStatusRead
   773 
   769 
   774 
   770 
       
   771 class MLtsyDispatchCellBroadcastStartSimCbTopicBrowsing : public MLtsyDispatchInterface
       
   772     {
       
   773 public:
       
   774 
       
   775     static const TInt KLtsyDispatchCellBroadcastStartSimCbTopicBrowsingApiId = KDispatchSimFuncUnitId + 29;
       
   776 
       
   777     /**
       
   778      * The CTSY Dispatcher shall invoke this function on receiving the ECustomStartSimCbTopicBrowsingIPC
       
   779      * request from the CTSY.
       
   780      *
       
   781      * It is a request call that is completed by invoking
       
   782      * CCtsyDispatcherCallback::CallbackCellBroadcastStartSimCbTopicBrowsingComp()
       
   783      *     
       
   784      *
       
   785      * @return KErrNone on success, otherwise another error code indicating the
       
   786      * failure.
       
   787      */
       
   788     virtual TInt HandleStartSimCbTopicBrowsingReqL() = 0;
       
   789 
       
   790     }; // class MLtsyDispatchCellBroadcastStartSimCbTopicBrowsing   
       
   791 
       
   792 
       
   793 class MLtsyDispatchCellBroadcastDeleteSimCbTopic : public MLtsyDispatchInterface
       
   794     {
       
   795 public:
       
   796 
       
   797     static const TInt KLtsyDispatchCellBroadcastDeleteSimCbTopicApiId = KDispatchSimFuncUnitId + 30;
       
   798 
       
   799     /**
       
   800      * The CTSY Dispatcher shall invoke this function on receiving the ECustomDeleteSimCbTopicIPC
       
   801      * request from the CTSY.
       
   802      *
       
   803      * It is a request call that is completed by invoking
       
   804      * CCtsyDispatcherCallback::CallbackCellBroadcastDeleteSimCbTopicComp()
       
   805      *     
       
   806      *
       
   807      * @return KErrNone on success, otherwise another error code indicating the
       
   808      * failure.
       
   809      */
       
   810     virtual TInt HandleDeleteSimCbTopicReqL(TUint aIndex, TBool aDeleteFlag) = 0;
       
   811 
       
   812     }; // class MLtsyDispatchCellBroadcastDeleteSimCbTopic  
       
   813 
       
   814 
       
   815 class MLtsyDispatchSmsGetSmspList : public MLtsyDispatchInterface
       
   816     {
       
   817 public:
       
   818 
       
   819     static const TInt KLtsyDispatchSmsGetSmspListApiId = KDispatchSimFuncUnitId + 31;
       
   820 
       
   821     /**
       
   822      * The CTSY Dispatcher shall invoke this function on receiving the EMobileSmsMessagingGetSmspListPhase1
       
   823      * request from the CTSY.
       
   824      *
       
   825      * It is a request call that is completed by invoking
       
   826      * CCtsyDispatcherCallback::CallbackSmsGetSmspListComp()
       
   827      *
       
   828      * Implementation of this interface should request to read the SMS parameter list from the SIM's SMSP store.
       
   829      *
       
   830      *
       
   831      * @return KErrNone on success, otherwise another error code indicating the
       
   832      * failure.
       
   833      * 
       
   834      * @see CMobilePhoneSmspList()
       
   835      * @see CRetrieveMobilePhoneSmspList()
       
   836      */
       
   837     virtual TInt HandleGetSmspListReqL() = 0;
       
   838 
       
   839     }; // class MLtsyDispatchSmsGetSmspList
       
   840 
       
   841 
       
   842 class MLtsyDispatchSmsStoreSmspListEntry : public MLtsyDispatchInterface
       
   843     {
       
   844 public:
       
   845 
       
   846     static const TInt KLtsyDispatchSmsStoreSmspListEntryApiId = KDispatchSimFuncUnitId + 32;
       
   847 
       
   848     /**
       
   849      * The CTSY Dispatcher shall invoke this function on receiving the EMobileSmsMessagingStoreSmspList
       
   850      * request from the CTSY.
       
   851      * 
       
   852      * It is a request call that is completed by invoking
       
   853      * CCtsyDispatcherCallback::CallbackSmsStoreSmspListEntryComp()
       
   854      * 
       
   855      * Implementation of this interface should handle the request to store a SMSP entry 
       
   856      * in the SIM's SMSP file
       
   857      *
       
   858      * @param aSmspEntry Defines a set of SMS parameters
       
   859      *
       
   860      * @return KErrNone on success, otherwise another error code indicating the
       
   861      * failure.
       
   862      */
       
   863     virtual TInt HandleStoreSmspListEntryReqL(const RMobileSmsMessaging::TMobileSmspEntryV1& aSmspEntry) = 0;
       
   864 
       
   865     }; // class MLtsyDispatchSmsStoreSmspList
       
   866 
       
   867 
       
   868 class MLtsyDispatchSmsGetSmsStoreInfo : public MLtsyDispatchInterface
       
   869     {
       
   870 public:
       
   871 
       
   872     static const TInt KLtsyDispatchSmsGetSmsStoreInfoApiId = KDispatchSimFuncUnitId + 33;
       
   873 
       
   874     /**
       
   875      * The CTSY Dispatcher shall invoke this function on receiving the EMobileSmsMessagingGetMessageStoreInfo
       
   876      * request from the CTSY.
       
   877      *
       
   878      * It is a request call that is completed by invoking
       
   879      * CCtsyDispatcherCallback::CallbackSmsGetSmsStoreInfoComp()
       
   880      *
       
   881      * Implementation of this interface should retrieve the current Sms store information.
       
   882      *
       
   883      *
       
   884      * @return KErrNone on success, otherwise another error code indicating the
       
   885      * failure.
       
   886      * 
       
   887      * @see RMobileSmsMessaging::GetMessageStoreInfo
       
   888      */
       
   889     virtual TInt HandleGetSmsStoreInfoReqL() = 0;
       
   890 
       
   891     }; // class MLtsyDispatchSmsGetSmsStoreInfo
       
   892 
       
   893 
       
   894 class MLtsyDispatchCallControlGetCallForwardingIndicator : public MLtsyDispatchInterface
       
   895     {
       
   896 public:
       
   897 
       
   898     static const TInt KLtsyDispatchCallControlGetCallForwardingIndicatorApiId = KDispatchSimFuncUnitId + 34;
       
   899 
       
   900     /**
       
   901      * The CTSY Dispatcher shall invoke this function on receiving the ECustomGetIccCallForwardingStatusIPC
       
   902      * request from the CTSY.
       
   903      *
       
   904      * It is a request call that is completed by invoking one of the 
       
   905      * CCtsyDispatcherCallback::CallbackCallControlGetCallForwardingIndicatorComp()
       
   906      *
       
   907      * Implementation of this interface should return the call forwarding indicator from the network.
       
   908      *
       
   909      * @return KErrNone on success, otherwise another error code indicating the
       
   910      * failure.
       
   911      *
       
   912      * @see RMmCustomAPI::GetIccCallForwardingIndicatorStatus()
       
   913      */
       
   914     virtual TInt HandleGetCallForwardingIndicatorL() = 0;
       
   915 
       
   916     }; // class MLtsyDispatchCallControlGetCallForwardingIndicator
       
   917 
       
   918 class MLtsyDispatchSimGetImsAuthorizationInfo : public MLtsyDispatchInterface
       
   919     {
       
   920 public:
       
   921 
       
   922     static const TInt KLtsyDispatchSimGetImsAuthorizationInfoApiId = KDispatchSimFuncUnitId + 35;
       
   923 
       
   924     /**
       
   925      * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneAuthorizationInfoPhase1
       
   926      * request from the CTSY.
       
   927      *
       
   928      * It is a request call that is completed by invoking one of the 
       
   929      * CCtsyDispatcherCallback::CallbackSimGetImsAuthorizationInfoComp
       
   930      *
       
   931      * Implementation of this interface should return the call forwarding indicator from the network.
       
   932      *
       
   933      * @return KErrNone on success, otherwise another error code indicating the
       
   934      * failure.
       
   935      *
       
   936      * @see CMmNetTsy::GetAuthorizationInfoPhase1L()
       
   937      */
       
   938     virtual TInt HandleGetImsAuthorizationInfoReqL() = 0;    
       
   939 
       
   940     }; // class MLtsyDispatchSimGetImsAuthorizationInfo
       
   941 
       
   942 
       
   943 
   775 #endif /*MLTSYDISPATCHSIMINTERFACE_H_*/
   944 #endif /*MLTSYDISPATCHSIMINTERFACE_H_*/