CDRMHelper Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Enumerator:

EAutomatedTypeRingingTone
EAutomatedTypeMessageAlert
EAutomatedTypeEmailAlert
EAutomatedTypeIMAlert
EAutomatedTypeCalendarAlarm
EAutomatedTypeScreenSaver
EAutomatedTypeWallpaper
EAutomatedTypeTheme
EAutomatedTypeClockAlarm
EAutomatedTypeOther

Enumerator:

EStart
EFinish
EPause
EContinue

Enumerator:

EForwardLock
ECombinedDelivery
ESeparateDelivery
ESuperDistribution

Enumerator:

ETActivateTextId
ETCountBasedErrorTextId
ETCountUsageReduceId
ETCountUsageReduceMediaId

Enumerator:

EOMA_None
EOMA_1_0
EOMA_2_0

Enumerator:

ENoPreview
EEmbeddedPreview
EPreviewRights

Destructor.

Acquires rights for given content if rights have been expired or rights are missing.

If content already has valid or future rights, does nothing. This function should be called when user selects activate from options menu. Leaves with system-wide error code in case of error.

Parameters:

aFileName,:

Full path to file

Acquires rights for given content if rights have been expired or rights are missing.

If content already has valid or future rights, does nothing. This function should be called when user selects activate from options menu. Leaves with system-wide error code in case of error.

Parameters:

aContent,:

Content object

Checks if given content can be set as an automated content.

Parameters:

	aFileHandle,:	file handle to the file
	aValue,:	ETrue if content can be set as automated.

Returns:

System wide or DRM specific error code.

Checks if given content can be set as an automated content.

Parameters:

	aFileName,:	Full path to file
	aValue,:	ETrue if content can be set as automated.

Returns:

System wide or DRM specific error code.

Checks if given content can be set as an automated content.

Parameters:

	aURI,:	content URI
	aValue,:	ETrue if content can be set as automated.

Returns:

System wide or DRM specific error code.

Check rights for the file.

If there is less than given amount of usage time/count left, one of the following note is displayed depending on situation: 'Usage rights about to expire. View details?' 'Usage rights about to expire. N days left. View details?' 'Usage rights about to expire. 1 day left. View details?' 'Usage rights about to expire. N counts left. View details?' 'Usage rights about to expire. 1 count left. View details?' It also checks that rights are valid and displays appropriate note, if they are not.

Parameters:

	aUri,:	Content URI
	aCount,:	Threshold value for count limit
	aDays,:	Threshold value for time limit in days

Returns:

Button code

Check rights for the file.

If there is less than given amount of usage time/count left, one of the following note is displayed depending on situation: 'Usage rights about to expire. View details?' 'Usage rights about to expire. N days left. View details?' 'Usage rights about to expire. 1 day left. View details?' 'Usage rights about to expire. N counts left. View details?' 'Usage rights about to expire. 1 count left. View details?' It also checks that rights are valid and displays appropriate note, if they are not.

Parameters:

	aFileHandle,:	file handle to the file
	aCount,:	Threshold value for count limit
	aDays,:	Threshold value for time limit in days

Returns:

Button code

Check rights for the file.

If there is less than given amount of usage time/count left, one of the following note is displayed depending on situation: 'Usage rights about to expire. View details?' 'Usage rights about to expire. N days left. View details?' 'Usage rights about to expire. 1 day left. View details?' 'Usage rights about to expire. N counts left. View details?' 'Usage rights about to expire. 1 count left. View details?' It also checks that rights are valid and displays appropriate note, if they are not.

Parameters:

	aFileName,:	Full path to file
	aCount,:	Threshold value for count limit
	aDays,:	Threshold value for time limit in days

Returns:

Button code

Check rights for the file.

If there is less than aThreshold percent of usage time/count left, one of the following note is displayed depending on situation: 'Usage rights about to expire. View details?' 'Usage rights about to expire. N days left. View details?' 'Usage rights about to expire. 1 day left. View details?' 'Usage rights about to expire. N counts left. View details?' 'Usage rights about to expire. 1 count left. View details?' It also checks that rights are valid and displays appropriate note, if they are not.

Parameters:

	aFileHandle,:	file handle to the file
	aThreshold,:	Threshold value in percents for displaying the note

Returns:

Button code

Check rights for the file.

If there is less than aThreshold percent of usage time/count left, one of the following note is displayed depending on situation: 'Usage rights about to expire. View details?' 'Usage rights about to expire. N days left. View details?' 'Usage rights about to expire. 1 day left. View details?' 'Usage rights about to expire. N counts left. View details?' 'Usage rights about to expire. 1 count left. View details?' It also checks that rights are valid and displays appropriate note, if they are not.

Parameters:

	aFileName,:	Full path to file
	aThreshold,:	Threshold value in percents for displaying the note

Returns:

Button code

Consume2.

Overrides any rights consumption. This function must only be used by applications with user interaction and not by intermediate components. The main use cases are signalling that content is to be installed (including thumbnail generation), or that content is to be consumed. They are characterized as calls to this function with the correct intent (i.e. EPlay or EInstall) and the corresponding action (i.e. telling whether the indicated intent is started or finished). Calls to this function must be the result of a user interaction or otherwise high level event.

Parameters:

	aContentURI,:	URI of the content which will be consumed
	aRightsSpec,:	the consumption intent (EPlay, EDisplay, EPrint, EExecute or EInstall)
	anAction,:	the consumption action, telling whether the content consumption starts or finishes.

Returns:

EOk if consume action was successfully signalled to the engine.

ConsumeFile2.

Overrides any rights consumption. This function must only be used by applications with user interaction and not by intermediate components. The main use cases are signalling that content is to be installed (including thumbnail generation), or that content is to be consumed. They are characterized as calls to this function with the correct intent (i.e. EPlay or EInstall) and the corresponding action (i.e. telling whether the indicated intent is started or finished). Calls to this function must be the result of a user interaction or otherwise high level event.

Parameters:

	aFileHandle,:	file handle to the file
	aRightsSpec,:	the consumption intent (EPlay, EDisplay, EPrint, EExecute or EInstall)
	anAction,:	the consumption action, telling whether the content consumption starts or finishes.

Returns:

EOk if consume action was successfully signalled to the engine.

ConsumeFile2.

Overrides any rights consumption. This function must only be used by applications with user interaction and not by intermediate components. The main use cases are signalling that content is to be installed (including thumbnail generation), or that content is to be consumed. They are characterized as calls to this function with the correct intent (i.e. EPlay or EInstall) and the corresponding action (i.e. telling whether the indicated intent is started or finished). Calls to this function must be the result of a user interaction or otherwise high level event.

Parameters:

	@param	aRightsSpec: the consumption intent (EPlay, EDisplay, EPrint, EExecute or EInstall)
	anAction,:	the consumption action, telling whether the content consumption starts or finishes.

Returns:

EOk if consume action was successfully signalled to the engine.

DataTypesCount.

Returns the number of previously registered datatypes which are supported by the DRM system and associated applications.

Parameters:

aCount,:

Out parameter for the datatype count

Returns:

EOk if the number of datatypes has been returned correctly

This method should be called after embedded preview has been played.

It asks from user if he/she wants to buy rights and acquires those if user agrees. Leaves with system-wide error code in case of error.

Parameters:

aFileName,:

Full path to file.

Returns:

ETrue if user selects to buy rights.

This method should be called after embedded preview has been played.

It asks from user if he/she wants to buy rights and acquires those if user agrees. Leaves with system-wide error code in case of error.

Parameters:

aContent,:

Content object.

Returns:

ETrue if user selects to buy rights.

GetContentURIList.

Returns a list of all content URIs that have rights in the rights database.

Parameters:

aURIList,:

Out parameter for the URI list.

Returns:

Ok if the URI list could be retreived.

Acquires preview rights for given content.

Leaves with system-wide error code in case of error.

Parameters:

aFileName,:

Full path to file.

Acquires preview rights for given content.

Leaves with system-wide error code in case of error.

Parameters:

aContent,:

Content object

Gets details of rights object associated of given file.

Parameters:

[in]	aFileHandle	file handle to the file
[in]	aIntent	ContentAccess::EPlay, ContentAccess::EView, ContentAccess::EPrint or ContentAccess::EExecute
[out]	aExpired	ETrue if rights are not valid. If this is ETrue and some constraints are returned, rights will become valid in future
[out]	aSendingAllowed	ETrue if content can be sent
[out]	aPlay	play constraints, must be deleted by caller
[out]	aDisplay	display constraints, must be deleted by caller
[out]	aExecute	execute constraints, must be deleted by caller
[out]	aPrint	print constraints, must be deleted by caller

Leave:

KErrArgument file is not DRM-protected.

Leave:

KErrCANoRights no rights

See also:

caferr.h

caftypes.h

Gets details of rights object associated of given file.

Parameters:

[in]	aFileName	Full path to file
[in]	aIntent	ContentAccess::EPlay, ContentAccess::EView, ContentAccess::EPrint or ContentAccess::EExecute
[out]	aExpired	ETrue if rights are not valid. If this is ETrue and some constraints are returned, rights will become valid in future
[out]	aSendingAllowed	ETrue if content can be sent
[out]	aPlay	play constraints, must be deleted by caller
[out]	aDisplay	display constraints, must be deleted by caller
[out]	aExecute	execute constraints, must be deleted by caller
[out]	aPrint	print constraints, must be deleted by caller

Leave:

KErrArgument file is not DRM-protected.

Leave:

KErrCANoRights no rights

See also:

caferr.h

caftypes.h

Gets details of rights object associated of given file.

Parameters:

[in]	aFileHandle	file handle to the file
[in]	aIntent	ContentAccess::EPlay, ContentAccess::EView, ContentAccess::EPrint or ContentAccess::EExecute
[out]	aExpired	ETrue if rights are not valid. If this is ETrue and some constraints are returned, rights will become valid in future
[out]	aSendingAllowed	ETrue if content can be sent
[out]	aPlay	play constraints, must be deleted by caller
[out]	aDisplay	display constraints, must be deleted by caller
[out]	aExecute	execute constraints, must be deleted by caller
[out]	aPrint	print constraints, must be deleted by caller

Leave:

KErrArgument file is not DRM-protected.

Leave:

KErrCANoRights no rights

See also:

caferr.h

caftypes.h

Gets details of rights object associated of given file.

Parameters:

[in]	aFileName	Full path to file
[in]	aIntent	ContentAccess::EPlay, ContentAccess::EView, ContentAccess::EPrint or ContentAccess::EExecute
[out]	aExpired	ETrue if rights are not valid. If this is ETrue and some constraints are returned, rights will become valid in future
[out]	aSendingAllowed	ETrue if content can be sent
[out]	aPlay	play constraints, must be deleted by caller
[out]	aDisplay	display constraints, must be deleted by caller
[out]	aExecute	execute constraints, must be deleted by caller
[out]	aPrint	print constraints, must be deleted by caller

Leave:

KErrArgument file is not DRM-protected.

Leave:

KErrCANoRights no rights

See also:

caferr.h

caftypes.h

Displays: Handles error situations 'rights expired', 'no rights' and 'rights database corrupted'.

Parameters:

	aError,:	error code returned by DRM engine
	aFileHandle,:	file handle to the file

Returns:

• Button code, if user selected "buy rights" or "launch rights manager" in query.
• 0 if user selected "No", "Back" or "Cancel" (or anything that just dismisses the query)
• 0 if just a simple error note is displayed

Displays: Handles error situations 'rights expired', 'no rights' and 'rights database corrupted'.

Parameters:

	aError,:	error code returned by DRM engine
	aFileName,:	full path to file

Returns:

• Button code, if user selected "buy rights" or "launch rights manager" in query.
• 0 if user selected "No", "Back" or "Cancel" (or whatever which just dismiss the query)
• 0 if just a simple error note is displayed

Displays appropriate error note depending on error code.

Parameters:

	aError,:	error code returned by DRM engine
	aURI,:	URI of the file

Returns:

• Button code, if user selected "buy rights" or "launch rights manager" in query.
• 0 if user selected "No", "Back" or "Cancel" (or whatever which just dismiss the query)
• 0 if just a simple error note is displayed

Handles DRM specific error situations.

Should be called instead of HandleErrorL if user should be asked to play embedded preview or get preview/silent rights if there is no valid rights and either embedded preview or preview rights are available.

Parameters:

	aError,:	error code to be handled.
	aFileName,:	name of file for which error was received.
	aEmbeddedPreviewUri,:	contain URI of embedded preview part upon return if caller should play the embedded preview. If embedded preview should not be played this is NULL. Must be freed by caller.

Returns:

KErrNone if the content is now usable (e.g. silent rights or preview rights were gotten). If the return code is KErrNone and the aEmbeddedPreviewUri parameter is not NULL, the player should use embedded preview KErrCancel if the user cancelled any of the actions within the function KErrCANoRights and KErrCANoPermission if after the function call, still no rights exist KErrCompletion if the user did launch the browser, but it is not clear whether the content was activated

Handles DRM-specific error situations.

Should be called instead of HandleErrorL if user should be asked to play embedded preview or get preview/silent rights if there is no valid rights and either embedded preview or preview rights are available.

Parameters:

	aError,:	error code to be handled.
	aFile,:	handle of file for which error was received.
	aEmbeddedPreviewUri,:	contain URI of embedded preview part upon return if caller should play the embedded preview. If embedded preview should not be played this is NULL. Must be freed by caller.

Returns:

KErrNone if the content is now usable (e.g. silent rights or preview rights were gotten). If the return code is KErrNone and the aEmbeddedPreviewUri parameter is not NULL, the player should use embedded preview KErrCancel if the user cancelled any of the actions within the function KErrCANoRights and KErrCANoPermission if after the function call, still no rights exist KErrCompletion if the user did launch the browser, but it is not clear whether the content was activated

Checks if given content has InfoUrl.

Leaves with system-wide error code in case of error.

Parameters:

	aFileName,:	Full path to file.
	aInfoUrl,:	Out: InfoUrl. Must be freed by caller.

Returns:

ETrue if content has InfoUrl.

Checks if given content has InfoUrl.

Leaves with system-wide error code in case of error.

Parameters:

	aContent,:	Content object.
	aInfoUrl,:	Out: InfoUrl. Must be freed by caller.

Returns:

ETrue if content has InfoUrl.

Checks if given content has embedded preview or if it is possible to get preview rights for it.

Leaves with system-wide error code in case of error.

Parameters:

	aFileName,:	Full path to file.
	aPreviewUri,:	Out: URI of the embedded preview or PreviewRights URL. Must be freed by caller

Returns:

preview type

Checks if given content has embedded preview or if it is possible to get preview rights for it.

Leaves with system-wide error code in case of error.

Parameters:

	aContent,:	Content object
	aPreviewUri,:	Out: URI of the embedded preview or PreviewRights URL. Must be freed by caller

Returns:

preview type

Informs DRMHelper that idle-screen has been activated.

Returns:

-

Launches DRM Rights Manager UI embedded with details view related to given content.

Parameters:

aContentURI,:

URI of the content

Returns:

-

Launches DRM Rights Manager UI embedded with details view related to given file.

Parameters:

aFileHandle,:

file handle to the file

Returns:

-

Launches DRM Rights Manager UI embedded with details view related to given file.

Parameters:

aFileName,:

Full path to file

Returns:

-

Launches DRM Rights Manager UI embedded with details view related to given content.

Parameters:

aURI,:

URI of the file

Returns:

-

Two-phased constructor.

Two-phased constructor.

Two-phased constructor.

Two-phased constructor.

Opens browser with InfoUrl of the content.

Leaves with system-wide error code in case of error.

Parameters:

aFileName,:

Full path to file.

Opens browser with InfoUrl of the content.

Leaves with system-wide error code in case of error.

Parameters:

aContent,:

Content object.

RegisterDataType.

Registers a datatype as a supported datatype.

Parameters:

aDataType,:

Datatype to register

Returns:

EOk if the datatype has been registered

Unregisters given content to be used as an automated content.

Parameters:

aFileHandle,:

file handle to the file

Returns:

System wide error code.

Unregisters given content to be used as an automated content.

Parameters:

aFileName,:

Full path to file

Returns:

System wide error code.

Unregisters given content to be used as an automated content.

Parameters:

aURI,:

content URI

Returns:

System wide error code.

Unregisters given content to be used as an automated content.

This function must be used when content was registered using SetAutomatedPassive.

Parameters:

aFileHandle,:

file handle to the file

Returns:

System wide error code.

Unregisters given content to be used as an automated content.

This function must be used when content was registered using SetAutomatedPassive.

Parameters:

aFileName,:

Full path to file

Returns:

System wide error code.

Unregisters given content to be used as an automated content.

This function must be used when content was registered using SetAutomatedPassive.

Parameters:

aURI,:

content URI

Returns:

System wide error code.

Registers given content to be used as an automated content.

This function is used when registering application listens expiry

Parameters:

aFileHandle,:

file handle to the file

Returns:

System wide error code (KErrCancel if user pressed no to query).

Registers given content to be used as an automated content.

This function is used when registering application listens expiry notifications itself.

Parameters:

aFileName,:

Full path to file

Returns:

System wide error code (KErrCancel if user pressed no to query).

Registers given content to be used as an automated content.

This function is used when registering application listens expiry notifications itself

Parameters:

aURI,:

content URI

Returns:

System wide error code (KErrCancel if user pressed no to query).

Registers given content to be used as an automated content.

This function is used when phone application listens to expiry notifications.

Parameters:

aFileHandle,:

file handle to the file

Returns:

System wide error code (KErrCancel if user pressed no to query).

Registers given content to be used as an automated content.

This function is used when phone application listens to expiry notifications.

Parameters:

aFileName,:

Full path to file

Returns:

System wide error code (KErrCancel if user pressed no to query).

Registers given content to be used as an automated content.

This function is used when phone application listens to expiry notifications.

Parameters:

aURI,:

content URI

Returns:

System wide error code (KErrCancel if user pressed no to query).

Registers given content to be used as an automated content without confirmation query.

Parameters:

	aFileHandle,:	file handle to the file
	aActive,:	ETrue if registering application itself listens expiry notifications

Returns:

System wide error code (KErrCancel if user pressed no to query).

Registers given content to be used as an automated content without confirmation query.

Parameters:

	aFileName,:	Full path to file
	aActive,:	ETrue if registering application itself listens expiry notifications

Returns:

System wide error code (KErrCancel if user pressed no to query).

Registers given content to be used as an automated content without confirmation query.

Parameters:

	aURI,:	content URI
	aActive,:	ETrue if registering application itself listens expiry notifications

Returns:

System wide error code (KErrCancel if user pressed no to query).

Sets the type of automated content to be registered.

This method should be called before calling any of SetAutomated* methods.

Parameters:

aAutomatedType,:

type of automated content

Returns:

System wide error code

Set count limit for CheckRightsAmountL.

Parameters:

aCounts,:

new count limit for displaying the note.

Returns:

-

Set percentage limit for CheckRightsAmountL.

Applies to both counts and time.

Parameters:

aPercentage,:

new limit for displaying the note.

Returns:

-

Sets media type of content for preview.

Should be called prior to calling HandleErrorOrPreviewL or EmbeddedPreviewCompletedL.

Parameters:

aMediaType,:

media type of content.

Returns:

System wide error code

Set time limit in days for CheckRightsAmountL.

Parameters:

aDays,:

new time limit for displaying the note.

Returns:

-

Displays the confirmation query about setting given content as an automated content.

Note that this function does not actually register content, just displays the note

Parameters:

aFileHandle,:

file handle to the file

Returns:

System wide error code (KErrCancel if user pressed no to query).

Displays the confirmation query about setting given content as an automated content.

Note that this function does not actually register content, just displays the note

Parameters:

aFileName,:

Full path to file

Returns:

System wide error code (KErrCancel if user pressed no to query).

Displays the confirmation query about setting given content as an automated content.

Note that this function does not actually register content, just displays the note

Parameters:

aURI,:

content URI

Returns:

System wide error code (KErrCancel if user pressed no to query).

Handle the general UI based error notes.

Parameters:

	aTextId	The code for DRM general notification note.
	aFileName	The DRM file's name and path, that caused the DRM error.

Returns:

KErrnone if everything went ok, else wide scale of Symbian errors

Handle the general UI based error notes.

Parameters:

	aTextId	The code for DRM general notification note.
	aURI	The DRM files URI, that caused the DRM error.

Returns:

KErrnone if everything went ok, else wide scale of Symbian errors

SupportedDataType.

Returns a specific datatype which has been registered before by giving an index

Parameters:

	aIndex,:	Number of the datatype to return
	aDataType,:	Out parameter for the datatype

Returns:

EOk if the datatype was returned correctly

SupportedDRMMethods.

Returns the supported DRM protection methods and the OMA compliance level of the DRM engine

Parameters:

	aDRMMethod,:	Out parameter, bit mask containing any combination of EForwardLock, ECombinedDelivery, ESeparateDelivery etc.
	aOMALevel,:	OMA compliance of the DRM engine

Returns:

DRMCommon error code

UnRegisterDataType.

Unregisters a datatype via its index.

Parameters:

aIndex,:

Number of the datatype to unregister

Returns:

EOk if the datatype has been unregistered