Collapse all Symbian^3 Application Developer Library

ContentAccess::CAgentRightsManager Class Reference

class ContentAccess::CAgentRightsManager : public CBase

Manages and retrieves rights objects from an agent.

Inherits from

ContentAccess::CAgentRightsManager
- CBase

Public Member Functions
TInt	DeleteAllRightsObjects (const TVirtualPathPtr &)
IMPORT_C TInt	DeleteAllRightsObjects ( RFile &, const TDesC &)
TInt	DeleteRightsObject (const CRightsInfo &)
MAgentRightsBase *	GetRightsDataL (const CRightsInfo &)
void	ListAllRightsL ( RStreamablePtrArray < CRightsInfo > &)
void	ListContentL ( RStreamablePtrArray < CVirtualPath > &, CRightsInfo &)
void	ListRightsL ( RStreamablePtrArray < CRightsInfo > &, const TDesC &)
void	ListRightsL ( RStreamablePtrArray < CRightsInfo > &, TVirtualPathPtr &)
IMPORT_C void	ListRightsL ( RStreamablePtrArray < CRightsInfo > &, RFile &, const TDesC &)
TInt	SetProperty ( TAgentProperty , TInt )

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Member Functions Documentation

DeleteAllRightsObjects(const TVirtualPathPtr &)

TInt

DeleteAllRightsObjects

(

const TVirtualPathPtr &

aVirtualPath

)

[pure virtual]

Deletes all rights associated with a particular content object

The agent may display a dialog asking the user to confirm the delete. Execution will be blocked until the dialog is complete. Applications can request to disable the agents user interface using the SetProperty() command

capability: DRM Access to DRM rights is not permitted for processes without DRM capability.

Parameters

const TVirtualPathPtr & aVirtualPath

The path of the content object.

DeleteAllRightsObjects(RFile &, const TDesC &)

IMPORT_C TInt	DeleteAllRightsObjects	(	RFile &	aFile,
			const TDesC &	aUniqueId
		)	[virtual]

Deletes all rights associated with a particular content object in a file specified by file handle. Can be used when the source file is in the client's private directory.

capability: DRM Access to DRM rights is not permitted for processes without DRM capability.

Parameters

RFile & aFile	The file handle for the file containing the content object.
const TDesC & aUniqueId	The unique id of the content object.

DeleteRightsObject(const CRightsInfo &)

TInt

DeleteRightsObject

(

const CRightsInfo &

aRightsInfo

)

[pure virtual]

Asks the DRM agent to delete a rights object

capability: DRM Access to DRM rights is not permitted for processes without DRM capability.

Parameters

const CRightsInfo & aRightsInfo

The rights object.

GetRightsDataL(const CRightsInfo &)

MAgentRightsBase *

GetRightsDataL

(

const CRightsInfo &

aRightsInfo

)

const [pure virtual]

This will be used by applications to retrieve an agent specific rights object

leave: KErrPermissionDenied If the agent does not permit the client to access rights information.

leave: ... One of the CAF error codes defined in caferr.h or one of the other system-wide error codes for any other errors.

capability: DRM Access to DRM rights is not permitted for processes without DRM capability.

Parameters

const CRightsInfo & aRightsInfo

The rights object.

ListAllRightsL(RStreamablePtrArray< CRightsInfo > &)

void

ListAllRightsL

(

RStreamablePtrArray < CRightsInfo > &

aArray

)

const [pure virtual]

List all rights held by the agent

leave: KErrPermissionDenied If the agent does not permit the client to access rights information.

leave: ... One of the CAF error codes defined in caferr.h or one of the other system-wide error codes for any other errors.

capability: DRM Access to DRM rights is not permitted for processes without DRM capability.

Parameters

RStreamablePtrArray < CRightsInfo > & aArray

The client supplied array used to store the CRightsInfo objects. The agent will add CRightsInfo objects to the supplied array.

ListContentL(RStreamablePtrArray< CVirtualPath > &, CRightsInfo &)

void	ListContentL	(	RStreamablePtrArray < CVirtualPath > &	aArray,
			CRightsInfo &	aRightsInfo
		)	const [pure virtual]

List all content associated with a particular rights object

leave: KErrPermissionDenied If the agent does not permit the client to access rights information.

leave: ... One of the CAF error codes defined in caferr.h or one of the other system-wide error codes for any other errors.

capability: DRM Access to DRM rights is not permitted for processes without DRM capability.

Parameters

RStreamablePtrArray < CVirtualPath > & aArray	The client supplied array used to store the list of content objects. The agent will add CVirtualPath objects to the supplied array.
CRightsInfo & aRightsInfo	The rights object.

ListRightsL(RStreamablePtrArray< CRightsInfo > &, const TDesC &)

void	ListRightsL	(	RStreamablePtrArray < CRightsInfo > &	aArray,
			const TDesC &	aUri
		)	const [pure virtual]

List all rights associated with a particular file

leave: KErrPermissionDenied If the agent does not permit the client to access rights information.

leave: ... One of the CAF error codes defined in caferr.h or one of the other system-wide error codes for any other errors.

capability: DRM Access to DRM rights is not permitted for processes without DRM capability.

Parameters

RStreamablePtrArray < CRightsInfo > & aArray	The client supplied array used to store the CRightsInfo objects. The agent will add CRightsInfo objects to the supplied array.
const TDesC & aUri	The name of the file.

ListRightsL(RStreamablePtrArray< CRightsInfo > &, TVirtualPathPtr &)

void	ListRightsL	(	RStreamablePtrArray < CRightsInfo > &	aArray,
			TVirtualPathPtr &	aVirtualPath
		)	const [pure virtual]

List all rights associated with a particular content object

leave: KErrPermissionDenied If the agent does not permit the client to access rights information.

leave: ... One of the CAF error codes defined in caferr.h or one of the other system-wide error codes for any other errors.

capability: DRM Access to DRM rights is not permitted for processes without DRM capability.

Parameters

RStreamablePtrArray < CRightsInfo > & aArray	The client supplied array used to store the CRightsInfo objects. The agent will add CRightsInfo objects to the supplied array.
TVirtualPathPtr & aVirtualPath	The content object.

ListRightsL(RStreamablePtrArray< CRightsInfo > &, RFile &, const TDesC &)

IMPORT_C void	ListRightsL	(	RStreamablePtrArray < CRightsInfo > &	aArray,
			RFile &	aFile,
			const TDesC &	aUniqueId
		)	const [virtual]

List all rights associated with a particular content object in a file specified by file handle. Can be used when the source file is in the client's private directory.

leave: KErrCANotSupported if the feature not supported.

leave: KErrPermissionDenied If the agent does not permit the client to access rights information.

leave: ... One of the CAF error codes defined in caferr.h or one of the other system-wide error codes for any other errors.

capability: DRM Access to DRM rights is not permitted for processes without DRM capability.

Parameters

RStreamablePtrArray < CRightsInfo > & aArray	The client supplied array used to store the CRightsInfo objects. The agent will add CRightsInfo objects to the supplied array.
RFile & aFile	The file handle for the file containing the content object.
const TDesC & aUniqueId	The unique id of the content object.

SetProperty(TAgentProperty, TInt)

TInt	SetProperty	(	TAgentProperty	aProperty,
			TInt	aValue
		)	[pure virtual]

Allows an application to request the modification of a property within the agent. The agent may or may not permit the property to be changed

capability: DRM Access to DRM protected content is not permitted for processes without DRM capability. Access to unprotected content is unrestricted

Parameters

TAgentProperty aProperty	The property to set.
TInt aValue	The value of the property.