RDRMHelper Class Reference

API published in: S60 2nd Ed FP 2

Link against: drmhelper.lib

Capability Information

Required Capabilities

None

Exceptions

The capability DRM is required in:

CDRMHelper::Consume2( const TDesC8& aContentURI, TUint32 aRightsSpec, TDRMHelperConsumeAction anAction); If the calling process doesn't have Nokia VID and "aRightsSpec is EInstall or EPeek"

CDRMHelper::ConsumeFile2( const TDesC& aFileName, TUint32 aRightsSpec, TDRMHelperConsumeAction anAction); If the calling process doesn't have Nokia VID and "aRightsSpec is EInstall or EPeek"

CDRMHelper::ConsumeFile2( RFile& aFileHandle, TUint32 aRightsSpec, TDRMHelperConsumeAction anAction); If the calling process doesn't have Nokia VID and "aRightsSpec is EInstall or EPeek"


#include <rdrmhelper.h>

Detailed Description

This class provides the client-side interface to the server session.

Public Member Functions

  RDRMHelper ()
  C++ default constructor.
TInt  Connect ()
  Connects to server.
TVersion  Version () const
  Gets the version number.
TInt  SetAutomated (const TDesC8 &aUri, TBool aActive, TInt aAutomatedType, TInt aIntent) const
  Register the given content uri as an automated content.
TInt  RemoveAutomated (const TDesC8 &aUri, TBool aActive, TInt aAutomatedType, TInt aIntent) const
  Unregister the given content.
TInt  RemoveAutomatedAll (const TDesC8 &aUri, TBool aActive, TInt aAutomatedType, TInt aIntent) const
  Unregister all instances of the given content.
TInt  IndicateIdle () const
  Indicate that idle-screen has been activated.
TInt  IsAutomated (const TDesC8 &aUri, TInt aAutomatedType, TInt aIntent, TBool &aAutomated, TInt &aType) const
  Has given content been registered as automated content.

Constructor & Destructor Documentation

RDRMHelper::RDRMHelper  ) 
 

C++ default constructor.


Member Function Documentation

TInt RDRMHelper::Connect  ) 
 

Connects to server.

Returns:
System-wide error code
TInt RDRMHelper::IndicateIdle  )  const
 

Indicate that idle-screen has been activated.

Returns:
System-wide error code
TInt RDRMHelper::IsAutomated const TDesC8 &  aUri,
TInt  aAutomatedType,
TInt  aIntent,
TBool &  aAutomated,
TInt &  aType
const
 

Has given content been registered as automated content.

Parameters:
aUri  content URI of the content
aAutomated  (out) ETrue if registered as automated.
aType  (out) Tells whether content has been registered as active or passive.
Returns:
System-wide error code
TInt RDRMHelper::RemoveAutomated const TDesC8 &  aUri,
TBool  aActive,
TInt  aAutomatedType,
TInt  aIntent
const
 

Unregister the given content.

Parameters:
aUri,:  content URI
aActive,:  active or passive registration
aAutomatedType,:  type of automated content
aIntent,:  intent how content is used
Returns:
System-wide error code
TInt RDRMHelper::RemoveAutomatedAll const TDesC8 &  aUri,
TBool  aActive,
TInt  aAutomatedType,
TInt  aIntent
const
 

Unregister all instances of the given content.

Parameters:
aUri,:  content URI
aActive,:  active or passive registration
aAutomatedType,:  type of automated content
aIntent,:  intent how content is used
Returns:
System-wide error code
TInt RDRMHelper::SetAutomated const TDesC8 &  aUri,
TBool  aActive,
TInt  aAutomatedType,
TInt  aIntent
const
 

Register the given content uri as an automated content.

Parameters:
aUri,:  content URI
aActive,:  active or passive registration
aAutomatedType,:  type of automated content
aIntent,:  intent how content is used
Returns:
System-wide error code
TVersion RDRMHelper::Version  )  const
 

Gets the version number.

Returns:
version number

The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2008
Back to top