MProfileEngine Class Reference

class MProfileEngine

Profile engine interface. This class offers methods to get active profile, active profile ID, profile names array and set active profile. How to use: Create profile engine with CreateProfileEngineL() ; MProfileEngine* profileEngine = CreateProfileEngineL() ; Free resources with MProfileEngine::Release() ; profileEngine-> Release() ; or if you release resources in destructor: ( iProfileEngine ) { iProfileEngine-> Release() ; }

If you put this class to CleanupStack then use void CleanupReleasePushL() CleanupReleasePushL( *profileEngine );

N/A
Since
2.0
Public Member Functions
TInt ActiveProfileId ()
MProfile * ActiveProfileL ()
MProfile * ActiveProfileLC ()
TBool IsActiveProfileTimedL ()
TBool IsFeatureSupported ( TProfileFeatureId )
MProfilesNamesArray * ProfilesNamesArrayLC ()
void Release ()
void SetActiveProfileL ( TInt )
void SetTempMediaVolumeL ( TProfileRingingVolume )
void SetTempRingingVolumeL ( TProfileRingingVolume )
TProfileRingingVolume TempMediaVolumeL ()
TProfileRingingVolume TempRingingVolumeL ()
Protected Member Functions
~MProfileEngine ()

Constructor & Destructor Documentation

~MProfileEngine()

~MProfileEngine ( ) [protected, inline, virtual]

Member Functions Documentation

ActiveProfileId()

TInt ActiveProfileId ( ) [pure virtual]
Return active profile ID or system error code.
Since
2.0

ActiveProfileL()

MProfile * ActiveProfileL ( ) [pure virtual]
Return active profile, ownership transfered.
Since
2.0

ActiveProfileLC()

MProfile * ActiveProfileLC ( ) [pure virtual]
Return active profile, ownership transfered.
Since
2.0

IsActiveProfileTimedL()

TBool IsActiveProfileTimedL ( ) [pure virtual]
Checks if the current active profile is timed or not.
Since
3.2

IsFeatureSupported(TProfileFeatureId)

TBool IsFeatureSupported ( TProfileFeatureId aFeatureId ) const [pure virtual]
Checks whether the given feature is supported by Profiles Engine.
Since
2.8

Parameters

TProfileFeatureId aFeatureId the feature to be checked.

ProfilesNamesArrayLC()

MProfilesNamesArray * ProfilesNamesArrayLC ( ) [pure virtual]
Return profiles names array, ownership transfered.
Since
2.0

Release()

void Release ( ) [pure virtual]
Frees resources.
Since
2.0

SetActiveProfileL(TInt)

void SetActiveProfileL ( TInt aId ) [pure virtual]
Set active profile if ID is incorrect then leave with KErrNotFound.
Since
2.0

Parameters

TInt aId Profile ID

SetTempMediaVolumeL(TProfileRingingVolume)

void SetTempMediaVolumeL ( TProfileRingingVolume aVolume ) [pure virtual]
Sets the temporary media volume of the current active profile to the given value. Temporary means that if another profile is activated and after that the original is reactivated the temporary value will be lost. Leaves with KErrAccessDenied if the media volume setting of the current profile is read-only.
Since
2.6

Parameters

TProfileRingingVolume aVolume the new value for the temporary media volume level.

SetTempRingingVolumeL(TProfileRingingVolume)

void SetTempRingingVolumeL ( TProfileRingingVolume aVolume ) [pure virtual]
Sets the temporary ringing volume of the current active profile to the given value. Temporary means that if another profile is activated and after that the original is reactivated the temporary value will be lost. Leaves with KErrAccessDenied if the ringing volume setting of the current profile is read-only.
Since
2.6

Parameters

TProfileRingingVolume aVolume the new value for the temporary ringing volume level.

TempMediaVolumeL()

TProfileRingingVolume TempMediaVolumeL ( ) const [pure virtual]
Gets the temporary media volume of the current active profile. Temporary means that if another profile is activated and after that the original is reactivated the temporary value will be lost.
Since
2.6

TempRingingVolumeL()

TProfileRingingVolume TempRingingVolumeL ( ) const [pure virtual]
Gets the temporary ringing volume of the current active profile. Temporary means that if another profile is activated and after that the original is reactivated the temporary value will be lost.
Since
2.6