PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFBPhoneCtl
Wrapper class fot the IPhoneCtl interface.
#include <SFBPhoneCtl.h.hpp>
class SFBPhoneCtl : public SFBQuery;
SFMTYPEDEFWRAPPER(SFBPhoneCtl)

Inheritance diagram

 Inheritance diagram of SFBPhoneCtlClass

Version

BREW 2.0 BREW 2.1 BREW 3.1 BREW 4.0
X X O O

Reference

BREW API IPhoneCtl

Member

Public Functions
SFCError AvoidServingSystem( AEETAvoidSSPref pref , UInt32 duration )
Avoid the current serving system for the specified duration under given conditions.
SFCError EnableLineSwitch( Bool enable )
Enable or disable line switching.
SFCError GetSuppsTrans( AEETSuppsTransId id , ISuppsTrans** trans )
Create an instance of new supplementary services transaction.
SFCError IsSuppsCallOp( ACharConstPtr string , UInt32Ptr num )
Verifies the given string is good call related supplementary service request.
SFCError IsSuppsCallOp( SFXAnsiStringConstRef string , UInt32Ptr num )
Verifies the given string is good call related supplementary service request.
static
SFBPhoneCtlSmp
NewInstance( SFCErrorPtr exception = null )
Create a new SFBPhoneCtl instance.
static
SFBPhoneCtlSmp
NewInstance( AEECLSID id , SFCErrorPtr exception = null )
Create a new SFBPhoneCtl instance.
SFCError ResetACM( Void )
Reset the Accumulate Call Meter to 0 in a system supporting Advice of Charge.
SFCError SelectLine( UInt32 id )
Select a line if the device supports alternate lines.
SFCError SetACMMax( UInt32 newMax )
Set the maximum value for Accumulate call meter.
SFCError SetAnswerVoicePref( AEETAnsVoicePref pref , UInt32 duration )
Typically phone answers incoming calls as voice call. This allows changing the answer preference setting.
SFCError SetDDTMPref( AEETDDTMPref pref )
Change the phone's data dedicated transmission mode (DDTM) preference to the specified selection, such as ON or OFF etc.
SFCError SetNAMSel( AEETNAM nam )
Changes NAM selection preference.
SFCError SetOperatingMode( AEETOprtMode mode )
Change the devices' operating mode.
SFCError SetPrefNetworks( SFXCallbackPtr callback , AEETUserPLMNList* pref , UInt32 size , SInt32Ptr status )
Saves the preferred networks to the SIM/USIM.
SFCError SetRSSIDeltaThreshold( Byte delta )
Changes RSSI-reporting delta threshold.
SFCError SetRTREConfig( AEETRTREConfig config )
Changes the RTRE(Runtime RUIM Enable) configuration to the specified value.
SFCError SetSubscriptionStatus( AEETSysMode mode , Bool status )
Requests phone to process change in subscription status.
SFCError SetSystemPreference( SFXCallbackPtr callback , AEETSystemPreference* pref , UInt32 size , SInt32Ptr status )
Changes the phone's system selection preference (mode, band, and roam preference).
SFCError SetVoicePrivacy( AEETPrivacyPref pref )
Changes the privacy preference on voice calls.
SFCError SuppsCallOp( ACharConstPtr string )
This function processes call related supplementary service request.
SFCError SuppsCallOp( SFXAnsiStringConstRef string )
This function processes call related supplementary service request.
SFCError WakeupFromStandby( Void )
Informs the lower layers to wake up from deep sleep (standby mode).
SFCError QueryInterface( AEECLSID clsid , VoidHandle handle ) (inherits from SFBQuery)
Ask an object for another API contract from the object in question.
SFCError QueryInterface( AEECLSID clsid , SFBBaseSmpPtr handle ) (inherits from SFBQuery)
Ask an object for another API contract from the object in question.
SFBBaseSmp QueryInterface( AEECLSID clsid ) (inherits from SFBQuery)
Ask an object for another API contract from the object in question.
Void Self( AEECLSID clsidReq , SFBQuerySmpPtr clone , AEECLSID clsidImp ) (inherits from SFBQuery)
Helper macro for those implementing an object with a single interface.
SFBQuerySmp Self( AEECLSID clsidReq , AEECLSID clsidImp ) (inherits from SFBQuery)
Helper macro for those implementing an object with a single interface.
Protected Functions
static
SFBBaseSmp
FactoryByCreate( AEECLSID id , SFCErrorPtr exception = null ) (inherits from SFBBase)
Create the instance for the specified ClassID's interface.
static
SFBBaseSmp
FactoryByQuery( SFBQuerySmpConstRef query , AEECLSID id , SFCErrorPtr exception = null ) (inherits from SFBBase)
Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBPhoneCtl::AvoidServingSystem
Avoid the current serving system for the specified duration under given conditions.
[ public ]
SFCError AvoidServingSystem(
    AEETAvoidSSPref pref   // conditions
    UInt32 duration        // span for the preference in seconds
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • Not supported: SFERR_UNSUPPORTED
  • Current system mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Reference

BREW API IPhoneCtl_AvoidServingSystem


SFBPhoneCtl::EnableLineSwitch
Enable or disable line switching.
[ public ]
SFCError EnableLineSwitch(
    Bool enable   // true enables, false disables line switching
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • Not supported: SFERR_UNSUPPORTED
  • Curret device operation mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Reference

BREW API IPhoneCtl_EnableLineSwitch


SFBPhoneCtl::GetSuppsTrans
Create an instance of new supplementary services transaction.
[ public ]
SFCError GetSuppsTrans(
    AEETSuppsTransId id   // transaction id
    ISuppsTrans** trans   // on success an instance of SFBSuppsTrans is returned
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • trans is null: SFERR_INVALID_PARAM
  • If insufficient memory: SFERR_NO_MEMORY

Reference

BREW API IPhoneCtl_GetSuppsTrans


SFBPhoneCtl::IsSuppsCallOp
Verifies the given string is good call related supplementary service request.
[ public ]
SFCError IsSuppsCallOp(
    ACharConstPtr string   // request string
    UInt32Ptr num          // returns the Call X if any in the request
);
[ public ]
SFCError IsSuppsCallOp(
    SFXAnsiStringConstRef string   // request string
    UInt32Ptr num                  // returns the Call X if any in the request
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • String is null: SFERR_INVALID_PARAM
  • String is completely unusable: SFERR_INVALID_FORMAT
  • String is a partial request : EINCOMPLETEITEM

Reference

BREW API IPhoneCtl_IsSuppsCallOp


SFBPhoneCtl::NewInstance
Create a new SFBPhoneCtl instance.
[ public, static ]
SFBPhoneCtlSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);
[ public, static ]
SFBPhoneCtlSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBPhoneCtl::ResetACM
Reset the Accumulate Call Meter to 0 in a system supporting Advice of Charge.
[ public ]
SFCError ResetACM(Void);

Return value

  • If succeeds: SFERR_NO_ERROR
  • Current system mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Reference

BREW API IPhoneCtl_ResetACM


SFBPhoneCtl::SelectLine
Select a line if the device supports alternate lines.
[ public ]
SFCError SelectLine(
    UInt32 id   // line to use
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • Not supported: SFERR_UNSUPPORTED
  • Line switching is disabled : AEET_ERR_OP_NOT_ALLOWED
  • Line id is out of supported range : AEET_ERR_BADDESC

Description

The change is effective after the phone info is updated with new line identifier. Once effective outgoing calls will use the selected line.

Reference

BREW API IPhoneCtl_SelectLine


SFBPhoneCtl::SetACMMax
Set the maximum value for Accumulate call meter.
[ public ]
SFCError SetACMMax(
    UInt32 newMax   // new value for Maximum allowed Accumulated Call Meter
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • Current system mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Reference

BREW API IPhoneCtl_SetACMMax


SFBPhoneCtl::SetAnswerVoicePref
Typically phone answers incoming calls as voice call. This allows changing the answer preference setting.
[ public ]
SFCError SetAnswerVoicePref(
    AEETAnsVoicePref pref   // indicate whether the phone should answer incoming calls as voice, fax, or data calls
    UInt32 duration         // span of this preference in seconds
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • Device does not support this function: SFERR_UNSUPPORTED
  • Current system mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Reference

BREW API IPhoneCtl_SetAnswerVoicePref


SFBPhoneCtl::SetDDTMPref
Change the phone's data dedicated transmission mode (DDTM) preference to the specified selection, such as ON or OFF etc.
[ public ]
SFCError SetDDTMPref(
    AEETDDTMPref pref   // dedicated data transmission mode
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • Device does not support this function: SFERR_UNSUPPORTED

Reference

BREW API IPhoneCtl_SetDDTMPref


SFBPhoneCtl::SetNAMSel
Changes NAM selection preference.
[ public ]
SFCError SetNAMSel(
    AEETNAM nam   // identifies the nam to activate
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • Current system mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED
  • Given nam exceeds the maximum device is capable : AEET_ERR_OUTOF_RESOURCES
  • Phone is likely powered off or shutting down : AEET_ERR_PHONE_NOT_ACTIVE
  • Phone is in use (traffic state) on the current NAM : AEET_ERR_PHONE_IN_USE

Reference

BREW API IPhoneCtl_SetNAMSel


SFBPhoneCtl::SetOperatingMode
Change the devices' operating mode.
[ public ]
SFCError SetOperatingMode(
    AEETOprtMode mode   // switch to this operating mode
);

Return value

Return SFERR_NO_ERROR.

Reference

BREW API IPhoneCtl_SetOperatingMode


SFBPhoneCtl::SetPrefNetworks
Saves the preferred networks to the SIM/USIM.
[ public ]
SFCError SetPrefNetworks(
    SFXCallbackPtr callback   // callback function
    AEETUserPLMNList* pref    // buffer containing networks
    UInt32 size               // sizeof AEETUserPLMNList
    SInt32Ptr status          // status of processing
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • Device does not support this function: SFERR_UNSUPPORTED
  • Current system mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Description

Gives an asynchronous response when done.

Reference

BREW API IPhoneCtl_SetPrefNetworks


SFBPhoneCtl::SetRSSIDeltaThreshold
Changes RSSI-reporting delta threshold.
[ public ]
SFCError SetRSSIDeltaThreshold(
    Byte delta   // delta threshold in dBm for RSSI reporting
);

Return value

Return SFERR_NO_ERROR.

Reference

BREW API IPhoneCtl_SetRSSIDeltaThreshold


SFBPhoneCtl::SetRTREConfig
Changes the RTRE(Runtime RUIM Enable) configuration to the specified value.
[ public ]
SFCError SetRTREConfig(
    AEETRTREConfig config   // requested configuration
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • The configuration is not supported: SFERR_UNSUPPORTED
  • Current system mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Reference

BREW API IPhoneCtl_SetRTREConfig


SFBPhoneCtl::SetSubscriptionStatus
Requests phone to process change in subscription status.
[ public ]
SFCError SetSubscriptionStatus(
    AEETSysMode mode   // system mode 
    Bool status        // true to activate the mode
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • Current system mode does not allow this operation: SFERR_UNSUPPORTED

Description

Device capable of supporting the mode may activate the corresponding protocol stack.

Reference

BREW API IPhoneCtl_SetSubscriptionStatus


SFBPhoneCtl::SetSystemPreference
Changes the phone's system selection preference (mode, band, and roam preference).
[ public ]
SFCError SetSystemPreference(
    SFXCallbackPtr callback      // callback for asynchronous completion status.
    AEETSystemPreference* pref   // preferences data
    UInt32 size                  // size of data
    SInt32Ptr status             // status of the request
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • If failed: SFERR_FAILED

Description

The status pointer Status and callback should be valid till the callback is invoked.

If asynchrounous result in not required, both Status and callback can be null.

Reference

BREW API IPhoneCtl_SetSystemPreference


SFBPhoneCtl::SetVoicePrivacy
Changes the privacy preference on voice calls.
[ public ]
SFCError SetVoicePrivacy(
    AEETPrivacyPref pref   // new privacy preference.
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • Device does not support this function: SFERR_UNSUPPORTED
  • Current system mode does not allow this operation : AEET_ERR_OP_NOT_ALLOWED

Description

If the device is not in voice call, this will be enforced on the next voice call.

Reference

BREW API IPhoneCtl_SetVoicePrivacy


SFBPhoneCtl::SuppsCallOp
This function processes call related supplementary service request.
[ public ]
SFCError SuppsCallOp(
    ACharConstPtr string   // request string
);
[ public ]
SFCError SuppsCallOp(
    SFXAnsiStringConstRef string   // request string
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • string is null: SFERR_INVALID_PARAM
  • string is completely unusable: SFERR_INVALID_FORMAT
  • string is a partial request : EINCOMPLETEITEM
  • Call descriptor in the request is bad : AEET_ERR_BADDESC

Reference

BREW API IPhoneCtl_SuppsCallOp


SFBPhoneCtl::WakeupFromStandby
Informs the lower layers to wake up from deep sleep (standby mode).
[ public ]
SFCError WakeupFromStandby(Void);

Return value

  • If succeeds: SFERR_NO_ERROR
  • This request is not valid in the current device mode : AEET_ERR_OP_NOT_ALLOWED

Reference

BREW API IPhoneCtl_WakeupFromStandby