About Remote Collaboration APIs
The IDK's remote Collaboration API (com.plumtree.remote.prc.collaboration)
provides programmatic access to many of the objects stored within
AquaLogic Interaction Collaboration. Use this remote programming interface
to embed collaborative components and functions into any web application
delivered through the ALI framework.
The PRC Collaboration API can be used to access existing ALI Collaboration
objects. Each object interface provides a GetDetailsURL method that returns the URL to the associated detail page in ALI
Collaboration. To create a URL to a Collaboration component, first
obtain an instance of the associated object, then call the getDetailsURL method.
For details on remote Collaboration APIs, see the following topics:
Each object interface allows you to determine a user's permissions
for a specific Collaboration object in two ways:
- Get the access level for each role (getAccessLevel).
- Determine whether a specific action is permitted (isActionAllowed).
For details, see
Managing Collaboration Project Roles Using the IDK Remote API.
For more details on ALI Collaboration functionality, see the Administrator Guide for AquaLogic Integration Collaboration and
the Collaboration online help.
- About Remote Collaboration Project OperationsEvery Collaboration task, document and discussion is associated with a project; the project must exist before you can create any component objects. Using the PRC Collaboration API in the IDK (com.plumtree.remote.prc.collaboration.project), you can query, create and modify projects, and manage project security and subscriptions from a remote application.
- About Remote Collaboration Discussion OperationsCollaboration discussions provide a virtual forum where project users hold online conversations on subjects of interest. The PRC Collaboration API in the IDK (com.plumtree.remote.prc.collaboration.discussion ) allows you to manage discussions remotely and embed discussion functionality in your remote applications.
- About Remote Collaboration Document and Folder OperationsDocuments are any kind of file uploaded to a Collaboration project, including spreadsheets, presentations, images, and PDF files. Documents are organized in a standard folder taxonomy. The PRC Collaboration API in the IDK (com.plumtree.remote.prc.collaboration.document) provides full access to documents and folders, allowing you to query, create, or modify these objects.
- About Remote Collaboration Task OperationsCollaboration tasks can be used to track workflow and process in a wide range of applications. Using the PRC Collaboration API in the IDK (com.plumtree.remote.prc.collaboration.tasklist), you can query, create, and modify tasks and task lists, as well as manage workflow and task dependencies.
- Collaboration Access LevelsThe following matrix describes the default permissions for each access level and Collaboration component.
