MProEngProfile Class Reference

#include <mw/MProEngProfile.h>

Link against: ProfileEngine.lib

class MProEngProfile
Public Member Functions
pure virtual const TArray< TContactItemId >AlertForL()
pure virtual voidCommitChangeL()
pure virtual TBool IsSilent()
pure virtual MProEngProfileName &ProfileName()
pure virtual MProEngTones &ProfileTones()
pure virtual voidRelease()
pure virtual TInt SetAlertForL(const TArray< TContactItemId > &)
pure virtual MProEngToneSettings &ToneSettings()
Protected Member Functions
virtual ~MProEngProfile()

Detailed Description

Profile settings interface. MProEngProfile offers methods to get the alert for items, profile settings and profile name interface. How to use: 
  // Get active profile with MProEngEngine::ActiveProfileL().
  MProEngProfile* profile = iProfileEngine->ActiveProfileL();

  // Use profile object here...

  // When you are ready, free resources with MProEngProfile::Release()
  profile->Release();

  // If you release resources in destructor then:
  if( iProfile )
      {
      iProfile->Release();
      }

  // If you put this class to CleanupStack then use void CleanupReleasePushL()
  CleanupReleasePushL( *profile );
Since
3.1

Constructor & Destructor Documentation

~MProEngProfile ( )

~MProEngProfile()[protected, inline, virtual]

Member Function Documentation

AlertForL ( )

const TArray< TContactItemId >AlertForL()[pure virtual]
Return the alert for item array. Only the calls coming from people who belong to one or more "Alert for" groups returned here trigger an audible alert.
Since
3.1

Returns: Alert for array

CommitChangeL ( )

voidCommitChangeL()[pure virtual]

Store profile settings. Leaves with: KErrAccessDenied if one or more of the settings of this profile is/are read-only, KErrAlreadyExists if the profile name has been changed and there already is a profile with the same name, KErrNotFound if a file set as an alert tone cannot be found, KErrNotSupported if the MIME type of a file set as an alert tone is not supported to be used as an alert tone, KErrArgument if a file set as an alert tone is DRM-protected but the platform does not allow the files of this MIME type to be set as alert tones when protected, KErrPermissionDenied, if a file set as an alert tone is not DRM-protected and the platform does not allow the files of this MIME type to be set as alert tones when unprotected, KErrCancel, if a file set as an alert tone is an unactivated DRM file and user does not want to activate it, KErrTooBig if the tone file set for ringing tone (line 1 or line 2) is too big in case the platform has this kind of limitation set, another system-wide error code.

Only processes with WriteDeviceData capability can succesfully call this method.
Since
3.1

IsSilent ( )

TBool IsSilent()const [pure virtual]
Return whether this profile is silent. A profile being silent means that either the ringing type is silent or all the alert tones are set to "None".
Since
3.1

Returns: ETrue if this profile is silent.

ProfileName ( )

MProEngProfileName &ProfileName()const [pure virtual]
Return profile name interface.
Since
3.1

Returns: Instance of the profile name interface.

ProfileTones ( )

MProEngTones &ProfileTones()const [pure virtual]
Return profile tones interface.
Since
3.1

Returns: Instance of the profile tones interface.

Release ( )

voidRelease()[pure virtual]
Free resources of the profile.
Since
3.1

SetAlertForL ( const TArray< TContactItemId > & )

TInt SetAlertForL(const TArray< TContactItemId > &aAlertFor)[pure virtual]
This method set alert for items to the profile. Only the calls coming from people who belong to one or more "Alert for" groups set here trigger an audible alert.
Since
3.1
ParameterDescription
aAlertForAlert for array. If the length of this array is 0, it is interpreted: "alert for all calls".

Returns: KErrAccessDenied, if the "Alert for" groups setting of the profile is unmodifiable. KErrArgument, if the argument array is too large. KErrNone, if succesful.

ToneSettings ( )

MProEngToneSettings &ToneSettings()const [pure virtual]
Returns tone settings of this profile.
Since
3.1

Returns: Returns tone settings of this profile.

© Nokia 2011.