Class RSat

class RSat : public RTelSubSessionBase

Support

Supported from 6.1

Description

Provides access to the class 2+ GSM feature: SIM Toolkit.

RSat inherits from RTelSubSessionBase defined by the core ETel API, in the header file etel.h. It reuses the RTelSubSessionBase methods that manage IPC communication with the ETel server.

Derivation

RSat Provides access to the class 2+ GSM feature: SIM Toolkit RTelSubSessionBase A base class used in the derivation of RCall, RLine, and RPhone

Defined in RSat:
(anonymous), (anonymous), (anonymous), (anonymous), (anonymous), (anonymous), (anonymous), (anonymous), (anonymous), (anonymous), (anonymous), (anonymous), (anonymous), (anonymous), (anonymous), (anonymous), (anonymous), ClientSatProfileIndication(), Close(), ConstructL(), Destruct(), EAllowedNoModification, EAllowedWithModifications, EAlphaIdNotPresent, EAlphaIdNull, EAlphaIdProvided, EAlphaIdValidityNotSet, ECcAddress, ECcSsString, ECcTypeNotSet, ECcUssdString, ECharSmsDefaultAlphabet, ECharUcs2Alphabet, EClearAfterDelay, EClearScreenTriggerNotSet, EControlResultNotSet, EDataNumberPlan, EDataValues, EDedicatedNumber, EDigitOnly, EDigitOnlyPacked, EDigitOnlyUnpacked, EDisconnectOtherCalls, EDisconnectOtherCallsWithRedial, EDisplayPriorityNotSet, EDisplayText, EDisplayUserInput, EFileChangeNotification, EGetInkey, EGetInkeyRspFormatNotSet, EGetInput, EGetInputRspFormatNotSet, EHelpAvailable, EHelpNotRequested, EHelpNotSet, EHelpRequestNotSet, EHelpRequested, EHideUserInput, EHighPriority, EHoldOtherCalls, EHoldOtherCallsWithRedial, EIconQualifierNotSet, EImmediateRsp, EImmediateRspNotSet, EInputDisplayOptionNotSet, EInternationalNumber, EIsdnNumberPlan, EMinutes, ENationalNumber, ENationalNumberPlan, ENavigationOptions, ENetworkSpecificNumber, ENoAlphaId, ENoDurationAvailable, ENoHelpAvailable, ENoIconId, ENoImmediateRsp, ENormalPriority, ENotAllowed, ENotSelfExplanatory, ENotSpecified, ENullAlphaId, ENumberingPlanNotSet, EOnlyIfNotBusy, EOnlyIfNotBusyWithRedial, EPlayTone, EPresentationTypeNotSet, EPrivateNumberPlan, ERefresh, ERefreshTypeNotSet, ERemoveExistingEventList, ERemoveExistingIdleModeText, ESeconds, ESelectItem, ESelfExplanatory, ESendDtmf, ESendSm, ESendSs, ESendUssd, ESetUpCall, ESetUpCallTypeNotSet, ESetUpEventList, ESetUpEventListTypeNotSet, ESetUpIdleModeText, ESetUpIdleModeTextTypeNotSet, ESetUpMenu, ESimInit, ESimInitFileChangeNotification, ESimInitFullFileChangeNotification, ESimReset, ESmsDefaultAlphabetPacked, ESmsDefaultAlphabetUnpacked, ETelexNumberPlan, ETenthsOfSeconds, ETimeUnitNotSet, ETypeOfNumberNotSet, EUcs2Alphabet, EUnknownNumber, EUnknownNumberingPlan, EUpdateEventList, EUpdateIdleModeText, EUserClear, EValidAlpaId, EYesNo, EventDownload(), EventDownloadCancel(), GetClut(), GetClutCancel(), GetIcon(), GetIconCancel(), GetImageInstance(), GetImageInstanceCancel(), GetMeSideSatProfile(), GetMeSideSatProfileCancel(), KAaemef, KAccBar, KAccEf, KAcmEf, KAcmMaxEf, KAdEf, KAdditionalInfoMaxSize, KAdnEf, KAlphaIdMaxSize, KBackwardModeRequestedByUser, KBdnEf, KCallClearedBeforeConnectionOrReleased, KCallConnected, KCallDisconnected, KCallSetUpNotAcceptedByUser, KCallWaitingTone, KCalledSubscriberBusy, KCaps2ndAlphaIdSetUpCall, KCaps2ndCapabilityConfigParam, KCaps9EXX, KCapsAlphaIdHandling, KCapsBinaryChoiceGetInkey, KCapsCCBySim, KCapsCallConnectedEvent, KCapsCallDisconnectedEvent, KCapsCardReaderStatusEvent, KCapsCbDataDownload, KCapsCellIdInCCBySim, KCapsCommandResult, KCapsDisplayText, KCapsExtensionTextDisplay, KCapsGetInkey, KCapsGetInput, KCapsGetReaderStatus, KCapsIdleScreenAvailableEvent, KCapsLocationStatusEvent, KCapsMOSMControl, KCapsMenuSelection, KCapsMoreTime, KCapsMtCallEvent, KCapsPerformCardApdu, KCapsPlayTone, KCapsPollInterval, KCapsPollingOff, KCapsPowerOffCard, KCapsPowerOnCard, KCapsProfileDownload, KCapsProvideLocalInfoBcchCoding, KCapsProvideLocalInfoDateTimeTimeZone, KCapsProvideLocalInformation, KCapsProvideLocalInformationNMR, KCapsRefresh, KCapsRfu1, KCapsRunAtCmd, KCapsSelectItem, KCapsSendDTMFCmd, KCapsSendSM, KCapsSendSS, KCapsSendUSSD, KCapsSetUpCall, KCapsSetUpEventList, KCapsSetUpIdleModeText, KCapsSetUpMenu, KCapsSmsPpDataDownload, KCapsSustainedDisplayText, KCapsTimerExpiration, KCapsTimerManagementGetCurrentValue, KCapsTimerManagementStartStop, KCapsUcs2Display, KCapsUcs2Entry, KCapsUserActivityEvent, KCapsUssdStringInCC, KCbmiEf, KCbmidEf, KCbmirEf, KCcpEf, KCcpMaxSize, KCmdBeyondMeCapabilities, KCmdDataNotUnderstood, KCmdNumberNotKnown, KCmdTypeNotUnderstood, KCnlEf, KCongestion, KContradictionWithTimerState, KDckEf, KDialTone, KDtmfStringMaxSize, KEccEf, KElpEf, KErrorRequiredValuesMissing, KErrorSpecialInfo, KExt1Ef, KExt2Ef, KExt3Ef, KExt4Ef, KFPlmnEf, KFdnEf, KGeneralBeep, KGetInkeyTextMaxSize, KGetInputDefaultTextMaxSize, KGetInputTextMaxSize, KGid1Ef, KGid2Ef, KHelpRequestedByUser, KHplmnEf, KIdleModeTextMaxSize, KIdleScreenAvailable, KImageInstanceDescriptorsMaxSize, KImgEf, KImsiEf, KInteractionWithCCPermanentError, KInteractionWithCCTemporaryError, KItemIconIds, KItemIdentifier, KItemListMaxSize, KItemNextActions, KItems, KLndEf, KLocationStatus, KLociGprsEf, KLpEf, KMTCall, KMaxMobileTelNumberSize, KMeBusyOnCall, KMeBusyOnSendDtmf, KMeBusyOnSs, KMeBusyOnUssd, KMeProblem, KMeUnableToProcessCmd, KMenuItemMaxSize, KMissingInformation, KModifiedByCallControl, KMsisdnEf, KNegativeTone, KNetworkUnableToProcessCmd, KNiaEf, KNoAdditionalInfo, KNoResponseFromUser, KNoService, KNoSpecificCause, KNotInSpeechCall, KPCmdResultNotSet, KPSessionTerminatedByUser, KPartialComprehension, KPhaseEf, KPlmnSelEf, KPositiveTone, KPuctEf, KRadioPathAcknowledge, KRadioPathNotAvailableCallDropped, KRadioRessourceNotGranted, KRefreshAdditionEFRead, KRefreshedFileListMaxSize, KRingingTone, KSatNetworkErrorInfo, KSatV1, KSatVersionNotSet, KScreenBusy, KSdnEf, KSendSsInfo, KSmsEf, KSmsRpError, KSmspEf, KSmsrEf, KSmssEf, KSpnEf, KSsReturnError, KSstEf, KStringMaxSize, KSubAddressMaxSize, KSuccess, KSuccessRequestedIconNotDisplayed, KSumeEf, KTextString, KTextToDisplayMaxSize, KToneNotSet, KTpduMaxSize, KUserActivity, KUssdReturnError, KUssdTransactionTerminatedByUser, KVbsEf, KVbssEf, KVcgsEf, KVgcssEf, KeMlppEf, MenuSelection(), MenuSelectionCancel(), N/a, NotifyCallControlRequest(), NotifyCallControlRequestCancel(), NotifyDisplayTextPCmd(), NotifyDisplayTextPCmdCancel(), NotifyGetInkeyPCmd(), NotifyGetInkeyPCmdCancel(), NotifyGetInputPCmd(), NotifyGetInputPCmdCancel(), NotifyMoSmControlRequest(), NotifyMoSmControlRequestCancel(), NotifyPlayTonePCmd(), NotifyPlayTonePCmdCancel(), NotifyProactiveSimSessionEnd(), NotifyProactiveSimSessionEndCancel(), NotifyProactiveSimSessionStart(), NotifyProactiveSimSessionStartCancel(), NotifyRefreshPCmd(), NotifyRefreshPCmdCancel(), NotifySelectItemPCmd(), NotifySelectItemPCmdCancel(), NotifySendDtmfPCmd(), NotifySendDtmfPCmdCancel(), NotifySendSmPCmd(), NotifySendSmPCmdCancel(), NotifySendSsPCmd(), NotifySendSsPCmdCancel(), NotifySendUssdPCmd(), NotifySendUssdPCmdCancel(), NotifySetUpCallPCmd(), NotifySetUpCallPCmdCancel(), NotifySetUpEventListPCmd(), NotifySetUpEventListPCmdCancel(), NotifySetUpIdleModeTextPCmd(), NotifySetUpIdleModeTextPCmdCancel(), NotifySetUpMenuPCmd(), NotifySetUpMenuPCmdCancel(), Open(), RSat(), RSat(), SendMessageNoLogging(), SendMessageNoLoggingCancel(), TAdditionalInfo, TAdditionalInfoType, TAddress, TAlphaId, TAlphaIdBuf, TAlphaIdStatus, TAlphaIdValidity, TCallControlType, TCallControlV1, TCallControlV1Pckg, TCallSetUpParams, TCcp, TClearScreenTrigger, TControlResult, TDisplayPriority, TDisplayTextRspV1, TDisplayTextRspV1Pckg, TDisplayTextV1, TDisplayTextV1Pckg, TDtmfString, TDuration, TElementaryFiles, TEventDownloadV1, TEventDownloadV1Pckg, TEventList, TGetInkeyRspFormat, TGetInkeyRspV1, TGetInkeyRspV1Pckg, TGetInkeyText, TGetInkeyV1, TGetInkeyV1Pckg, TGetInputDefaultText, TGetInputRspFormat, TGetInputRspV1, TGetInputRspV1Pckg, TGetInputText, TGetInputV1, TGetInputV1Pckg, THelp, THelpRequest, TIcon, TIconId, TIconQualifier, TIdleModeText, TImmediateRsp, TInputDisplayOption, TInstanceNumberAndOffset, TItem, TItemList, TMeProblem, TMenuContent, TMenuItemBaseV1, TMenuSelectionV1, TMenuSelectionV1Pckg, TMoSmControlV1, TMoSmControlV1Pckg, TNumberingPlan, TPCmd, TPCmdResult, TPlayToneRspV1, TPlayToneRspV1Pckg, TPlayToneV1, TPlayToneV1Pckg, TPresentationType, TRefreshFileList, TRefreshRspV1, TRefreshRspV1Pckg, TRefreshType, TRefreshV1, TRefreshV1Pckg, TRspLength, TSatBase, TSatPCmdBase, TSatProfileByte1, TSatProfileByte2, TSatProfileByte3, TSatProfileByte4, TSatProfileByte5, TSatProfileByte6, TSatProfileByte7, TSatProfileByte8, TSatProfileByte9, TSatProfileV1, TSatProfileV1Pckg, TSatSmsV1, TSatSmsV1Pckg, TSatTelNumber, TSatVersion, TSelectItemRspV1, TSelectItemRspV1Pckg, TSelectItemV1, TSelectItemV1Pckg, TSendDtmfRspV1, TSendDtmfRspV1Pckg, TSendDtmfV1, TSendDtmfV1Pckg, TSendSmRspV1, TSendSmRspV1Pckg, TSendSmV1, TSendSmV1Pckg, TSendSsRspV1, TSendSsRspV1Pckg, TSendSsV1, TSendSsV1Pckg, TSendUssdRspV1, TSendUssdRspV1Pckg, TSendUssdV1, TSendUssdV1Pckg, TSetUpCallRspV1, TSetUpCallRspV1Pckg, TSetUpCallType, TSetUpCallV1, TSetUpCallV1Pckg, TSetUpEventListRspV1, TSetUpEventListRspV1Pckg, TSetUpEventListType, TSetUpEventListV1, TSetUpEventListV1Pckg, TSetUpIdleModeTextRspV1, TSetUpIdleModeTextRspV1Pckg, TSetUpIdleModeTextType, TSetUpIdleModeTextV1, TSetUpIdleModeTextV1Pckg, TSetUpMenuRspV1, TSetUpMenuRspV1Pckg, TSetUpMenuV1, TSetUpMenuV1Pckg, TSsString, TSubAddress, TTextToDisplay, TTimeUnit, TTone, TTpdu, TTypeOfNumber, TUssdString, TerminalRsp(), TerminalRspCancel(), iEtelSatPtrHolder

RSat();

Description

Default constructor.

protected: virtual void ConstructL();

Description

Second phase constructor.

protected: virtual void Destruct();

Description

Deletes all resources belonging to the RSat object.

TInt Open(RPhone& aPhone);

Description

Opens a session between an RSat object and a phone referenced by aPhone.

Parameters

RPhone& aPhone The open phone to attach the RSat object to.

Return value

TInt The return status. If an error occurs, Destruct() is called.

void Close();

Description

Closes the session between the RSat object and RPhone and then calls Destruct().

void NotifyProactiveSimSessionStart(TRequestStatus& aReqStatus) const;

Description

Enables notification (to the client) of the start of a proactive SIM session.

Parameters

TRequestStatus& aReqStatus A request status that is completed when the proactive SIM session starts.

void NotifyProactiveSimSessionStartCancel() const;

Description

Cancels an outstanding request to be notified of the start of a proactive SIM session, placed by NotifyProactiveSimSessionStart().

void NotifyProactiveSimSessionEnd(TRequestStatus& aReqStatus) const;

Description

Enables notification (to the client) of the end of the on-going proactive SIM session.

Parameters

TRequestStatus& aReqStatus A request status that is completed when the on-going proactive SIM session ends.

void NotifyProactiveSimSessionEndCancel() const;

Description

Cancels an outstanding request to be notified of the end of an on-going proactive SIM session, placed by NotifyProactiveSimSessionEnd().

void GetIcon(TRequestStatus& aReqStatus, TUint8 aRecordNumber, TIcon& aIconEf) const;

Description

Enables the client to retrieve the content of the EF_IMG record specified by aRecordNumber.

The content of the record is a descriptor with a fixed length of 9 bytes.

Parameters

TRequestStatus& aReqStatus A request status that is completed when the operation has finished. TUint8 aRecordNumber The number of the EF_IMG record that contains the icon to be retrieved. TIcon& aIconEf On return, contains the specified icon descriptor.

void GetIconCancel() const;

Description

Cancels an outstanding GetIcon() request.

void GetImageInstance(TRequestStatus& aReqStatus, TUint aInstanceNumber, TDes8& aInstance) const;

Description

Enables the client to retrieve a specified image instance.

Before calling this function the client must first determine the size of the image instance to retrieve and create a suitably sized buffer. The client can then pass the reference to that buffer to GetImageInstance() in aInstance.

Parameters

TRequestStatus& aReqStatus A request status that is completed when the operation has finished. TUint aInstanceNumber The instance number of the image to retrieve. TDes8& aInstance On completion, contains the image instance.

void GetImageInstanceCancel() const;

Description

Cancels an outstanding GetImageInstance() request.

void GetClut(TRequestStatus& aReqStatus, TUint aInstanceNumber, TUint aOffset, TDes8& aClut) const;

Description

Enables the client to retrieve a specified colour look-up table (CLUT).

Before calling this function, the client must first determine the image instance number, and the offset and size of the CLUT.

Parameters

TRequestStatus& aReqStatus A request status that is completed when the operation has finished. TUint aInstanceNumber The image instance number of the CLUT to retrieve. TUint aOffset The offset of the CLUT. TDes8& aClut On completion, contains the CLUT.

void GetClutCancel() const;

Description

Cancels an outstanding GetClut() request.

void TerminalRsp(TRequestStatus& aReqStatus, TPCmd aPCmd, const TDesC8& aRsp) const;

Description

Enables the client to reply to any proactive command it receives.

The TSY uses the command specified in aPCmd to determine which response data package to unpack. For example, if aPCmd equals EDisplayText, then aRsp would have to be a packaged version of the TDisplayTextRspV1 class.

Parameters

TRequestStatus& aReqStatus A request status that is completed when the operation has finished. TPCmd aPCmd The command the client is responding to. const TDesC8& aRsp On completion, the corresponding response data package for the command specified in aPCmd.

See also:

• RSat::TDisplayTextRspV1
• RSat::TGetInkeyRspV1
• RSat::TGetInputRspV1
• RSat::TPlayToneRspV1
• RSat::TSetUpMenuRspV1
• RSat::TSelectItemRspV1
• RSat::TSendSmRspV1
• RSat::TSendSsRspV1
• RSat::TSendUssdRspV1
• RSat::TSetUpCallRspV1
• RSat::TRefreshRspV1
• RSat::TSetUpEventListRspV1
• RSat::TSetUpIdleModeTextRspV1
• RSat::TSendDtmfRspV1

void TerminalRspCancel() const;

Description

Cancels an outstanding RSat::TerminalRsp() request.

void GetMeSideSatProfile(TRequestStatus& aReqStatus, TDes8& aMeSimSatProfile) const;

Description

Enables the client to retrieve the combined SAT profile of the SIM Card and the mobile equipment (ME).

Parameters

TRequestStatus& aReqStatus A request status that is completed when the operation has finished. TDes8& aMeSimSatProfile On completion, contains the SAT profile for the SIM and ME, a RSat::TSatProfileV1 packaged in a RSat::TSatProfileV1Pckg.

void GetMeSideSatProfileCancel() const;

Description

Cancels an outstanding GetMeSideSatProfile() request.

TInt ClientSatProfileIndication(const TDesC8& aClientSatProfile) const;

Description

Enables the client to indicate its SAT profile to the ME.

Parameters

const TDesC8& aClientSatProfile The SAT profile to be indicated to the ME, a RSat::TSatProfileV1 packaged in a RSat::TSatProfileV1Pckg.

Return value

TInt KErrNone, if successful, otherwise one of the other system wide error codes.

void MenuSelection(TRequestStatus& aReqStatus, const TDesC8& aSelection) const;

Description

Enables the client to select a menu item from a SAT menu previously set up by a SET UP MENU proactive command.

Parameters

TRequestStatus& aReqStatus A request status that is completed when the operation has finished. const TDesC8& aSelection On completion, the requested menu item, a RSat::TMenuSelectionV1 packaged in a RSat::TMenuSelectionV1Pckg.

void MenuSelectionCancel() const;

Description

Cancels an outstanding MenuSelection() request.

void NotifyCallControlRequest(TRequestStatus& aReqStatus, TDes8& aCallControlDetails) const;

Description

Enables the client to be notified of a call control request.

Upon completion the proactive command details are returned in a packaged version of the TCallControlV1 class in aCallControlDetails.

Parameters

TRequestStatus& aReqStatus A request status that is completed when the operation has finished. TDes8& aCallControlDetails On completion, contains the details of the new action to be performed, instead of the original call set up, a RSat::TCallControlV1 packaged in a RSat::TCallControlV1Pckg.

void NotifyCallControlRequestCancel() const;

Description

Cancels an outstanding NotifyCallControlRequest() request.

void NotifyMoSmControlRequest(TRequestStatus& aReqStatus, TDes8& aMoSmDetails) const;

Description

Enables the client to be notified of a mobile originated (MO) short message (SM) control request.

Upon completion the proactive command details are returned in a packaged version of the TMoSmControlV1 class in aMoSmControlDetails.

Parameters

TRequestStatus& aReqStatus A request status that is completed when the operation has finished. TDes8& aMoSmDetails On completion, contains a RSat::TMoSmControlV1 packaged in a RSat::TMoSmControlV1Pckg.

void NotifyMoSmControlRequestCancel() const;

Description

Cancels an outstanding NotifyMoSmControlRequest() request.

void EventDownload(TRequestStatus& aReqStatus, const TDesC8& aEventList) const;

Description

Enables the client to notify the mobile equipment (ME) side that one or possibly two events have occurred.

At present, only the User Activity and Idle Screen events can be reported by the client. The remaining events (MT call, call connected, call disconnected and location status) are the responsibility of the TSY only.

Parameters

TRequestStatus& aReqStatus A request status that is completed when the operation has finished. const TDesC8& aEventList The events that must trigger a notification to the ME side, a RSat::TEventDownloadV1 packaged in a RSat::TEventDownloadV1Pckg.

See also:

• RSat::TEventList

void EventDownloadCancel() const;

Description

Cancels an outstanding EventDownload() request.

void NotifyDisplayTextPCmd(TRequestStatus& aReqStatus, TDes8& aPCmd) const;

Description

Enables the client to be notified of a DISPLAY TEXT proactive command.

Upon completion the proactive command details are returned in a packaged version of the TDisplayTextV1 class in aPCmd.

Parameters

TRequestStatus& aReqStatus A request status that is completed when the operation has finished. TDes8& aPCmd On completion, contains a TDisplayTextV1 packaged into a descriptor, TDisplayTextV1Pckg.

void NotifyDisplayTextPCmdCancel() const;

Description

Cancels an outstanding NotifyDisplayTextPCmd() request.

void NotifyGetInkeyPCmd(TRequestStatus& aReqStatus, TDes8& aPCmd) const;

Description

Enables the client to be notified of a GET INKEY proactive command.

Upon completion the proactive command details are returned in a packaged version of the TGetInkeyV1 class in aPCmd.

Parameters

TRequestStatus& aReqStatus A request status that is completed when the operation has finished. TDes8& aPCmd On completion, contains TGetInkeyV1 packaged into a descriptor, TGetInkeyV1Pckg.

void NotifyGetInkeyPCmdCancel() const;

Description

Cancels an outstanding NotifyGetInkeyPCmd() request.

void NotifyGetInputPCmd(TRequestStatus& aReqStatus, TDes8& aPCmd) const;

Description

Enables the client to be notified of a GET INKEY proactive command.

Upon completion the proactive command details are returned in a packaged version of the TGetInkeyV1 class in aPCmd.