Collapse all Symbian^3 Application Developer Library

RSsmSimAdaptation Class Reference

class RSsmSimAdaptation : public RSsmAdaptationBase

Client interface for Sim Adaptation part of the Adaptation server.

Inherits from

RSsmSimAdaptation
- RSsmAdaptationBase
  - RSessionBase
    - RHandleBase

Public Member Functions
IMPORT_C void	GetCancel ()
IMPORT_C void	GetLastSimEvent ( TDes8 &)
IMPORT_C void	GetSimOwned ( TDes8 &, TRequestStatus &)
IMPORT_C void	NotifyCancel ()
IMPORT_C void	NotifySimEvent ( TDes8 &, TRequestStatus &)

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()
	RSsmAdaptationBase::Connect()
	RSsmAdaptationBase::Connect(TInt)

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Inherited Attributes
	RHandleBase::iHandle

Member Functions Documentation

GetCancel()

IMPORT_C void

GetCancel

(

)

Cancels the current outstanding request for either the SIM changed or SIM owned information.

Calling this API does not cancel any outstanding notification request. Use NotifyCancel() to cancel outstanding notification requests.

If the request is successfully cancelled then the TRequestStatus associated with that request will be completed with KErrCancel.

GetLastSimEvent(TDes8 &)

IMPORT_C void

GetLastSimEvent

(

TDes8 &

aTypePckg

)

Returns the last event occured in the aTypePckg which is a package of TSsmSimEventType

Calling this API will get the last notification received by Adaptation server.If the client needs to be notified about the notifications client has to register using NotifySimEvent But once the client receives a notification it has to register again using NotifySimEvent for further notification. To get any events that are missed between two notification requests the API GetLastSimEvent can be used. This API can also be used to just get the last notified Sim event from Adaptation server.

Parameters

TDes8 & aTypePckg

GetSimOwned(TDes8 &, TRequestStatus &)

IMPORT_C void	GetSimOwned	(	TDes8 &	aOwnedPckg,
			TRequestStatus &	aStatus
		)

Retrieve information about if the current SIM card, if any, is classed as owned.

The conditions on a SIM card being classed as owned are dependent on the adaptation implementation.

Parameters

TDes8 & aOwnedPckg	A descriptor packaging a TBool object, such as TPckg<TBool>. The descriptor referenced should exist until aStatus is completed. When aStatus is completed with KErrNone this descriptor will contain ETrue if the SIM card is owned, EFalse otherwise.
TRequestStatus & aStatus	The request status. This is set to KErrNone on completion, KErrNotSupported if this operations is not supported by the adaptation, otherwise one of the other system-wide error codes.

NotifyCancel()

IMPORT_C void

NotifyCancel

(

)

Cancels the current outstanding request for notification of SIM events.

Calling this API does not cancel any outstanding 'Get...' request. Use GetCancel() to cancel outstanding 'Get...' requests.

If the request is successfully cancelled then the TRequestStatus associated with the notification request will be completed with KErrCancel.

NotifySimEvent(TDes8 &, TRequestStatus &)

IMPORT_C void	NotifySimEvent	(	TDes8 &	aTypePckg,
			TRequestStatus &	aStatus
		)

Requests notification of SIM events.

TSsmSimEventType

Parameters

TDes8 & aTypePckg
TRequestStatus & aStatus	The request status. This is set to KErrNone on completion, KErrNotSupported if this operations is not supported by the adaptation, otherwise one of the other system-wide error codes.