MProEngProfile Class Reference

API published in: S60 3rd Ed FP 1

Link against: profileengine.lib

Capability Information

Required Capabilities

WriteDeviceData

Exceptions

No capabilities needed for reading profiles.

#include <mproengprofile.h>

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 );

Public Member Functions
virtual void  Release ()=0
  Free resources of the profile.
virtual const TArray< TContactItemId >  AlertForL ()=0
  Return the alert for item array.
virtual TInt  SetAlertForL (const TArray< TContactItemId > &aAlertFor)=0
  This method set alert for items to the profile.
virtual TBool  IsSilent () const =0
  Return whether this profile is silent.
virtual MProEngProfileName &  ProfileName () const =0
  Return profile name interface.
virtual MProEngTones &  ProfileTones () const =0
  Return profile tones interface.
virtual MProEngToneSettings &  ToneSettings () const =0
  Returns tone settings of this profile.
virtual void  CommitChangeL ()=0
  Store profile settings.

Protected Member Functions
virtual  ~MProEngProfile ()

Constructor & Destructor Documentation

virtual MProEngProfile::~MProEngProfile (   )  [inline, protected, virtual]
 

Member Function Documentation

virtual const TArray<TContactItemId> MProEngProfile::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.

Returns:
Alert for array
virtual void MProEngProfile::CommitChangeL (   )  [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.

virtual TBool MProEngProfile::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".

Returns:
ETrue if this profile is silent.
virtual MProEngProfileName& MProEngProfile::ProfileName (   )  const [pure virtual]
 

Return profile name interface.

Returns:
Instance of the profile name interface.
virtual MProEngTones& MProEngProfile::ProfileTones (   )  const [pure virtual]
 

Return profile tones interface.

Returns:
Instance of the profile tones interface.
virtual void MProEngProfile::Release (   )  [pure virtual]
 

Free resources of the profile.

virtual TInt MProEngProfile::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.

Parameters:
aAlertFor  Alert 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.
virtual MProEngToneSettings& MProEngProfile::ToneSettings (   )  const [pure virtual]
 

Returns tone settings of this profile.

Returns:
Returns tone settings of this profile.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top