diff -r 000000000000 -r bde4ae8d615e os/security/contentmgmt/contentaccessfwfordrm/engineering/dox/RightsManagerAPI.dox --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/os/security/contentmgmt/contentaccessfwfordrm/engineering/dox/RightsManagerAPI.dox Fri Jun 15 03:10:57 2012 +0200 @@ -0,0 +1,138 @@ +// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies). +// All rights reserved. +// This component and the accompanying materials are made available +// under the terms of the License "Eclipse Public License v1.0" +// which accompanies this distribution, and is available +// at the URL "http://www.eclipse.org/legal/epl-v10.html". +// +// Initial Contributors: +// Nokia Corporation - initial contribution. +// +// Contributors: +// +// Description: +//
ContentAccess::CRightsInfo
class. This simple class
+// just holds a text description of the rights and some simple properties assocaiated with those
+// rights.
+// The Rights manager also allows applications to determine which content files are assocated with
+// each Rights object and vice versa.
+// ContentAccess::CRightsManager
object is created by the ContentAccess::CManager
object to look at the rights stored by a
+// particular content access agent.
+// // create the CManager object
+// CManager* manager = CManager::NewL();
+// //Create RPointerArray to store pointers to the agents
+// RPointerArray ContentAccess::CRightsManager::ListAllRightsL()
function produces a list of all the rights stored
+// in the given a DRM agent.
+// // Create the array to store Rights objects
+// RStreamablePtrArrayContentAccess::CRightsManager::ListRightsL()
function produces a list of all the rights stored
+// in the given a DRM agent that are associated with the file at a given URI.
+// // Create the array to store Rights objects
+// RStreamablePtrArrayContentAccess::CRightsManager::ListRightsL()
function produces a list of all the rights stored
+// in the given a DRM agent that are associated with the content object at a given virtual path
+// // Create the array to store Rights objects
+// RStreamablePtrArrayContentAccess::CRightsManager::ListContentL()
function produces a list of all the content
+// that is associated with the given Rights object.
+// // Create the array to store Rights objects
+// RStreamablePtrArrayContentAccess::CRightsManager::GetRightsDataL()
function allows an application to
+// retrieve a pointer to a Rights object. The Rights object is derived from MAgentRightsBase
.
+// // Retrieve the full Rights object
+// // The application will need to cast it to the agent's derived Rights class before using it.
+// MAgentRightsBase* rightsObject = rightsManager->GetRightsDataL(rightsObject);
+// ContentAccess::CRightsManager::DeleteRightsObject()
function allows an application to
+// delete rights stored by the agent.
+// // Delete the Rights object
+// TInt result = rightsManager->DeleteRightsObject(rightsObject);
+// It is also possible to delete all the rights associated with a particular content object.
+// // Delete all the Rights objects associated with the given content object
+// TInt result = rightsManager->DeleteAllRights(virtualPath);
+//