10.5. Portal API

Warning

You are looking at documentation for an older release. Not what you want? See the current release documentation.

The Portal API provides access to retrieving, creating and deleting Portal Sites and Portal Pages. It also provides full support for the navigation and nodes associated with a site, which can be very useful for example creating custom navigation portlets. This section only gives some basic examples of the API usage. For full documentation of all features available, please refer to the Javadoc.

PortalRequest and Portal

The PortalRequest is the entry point to the API. It provides access to the Portal, and it also provides access to information associated with the current request (such as the logged in user and the page being requested).

The example below shows how to use the PortalRequest to obtain an instance of the Portal:



Portal portal = PortalRequest.getInstance().getPortal();

This sections contains these parts:

Copyright ©. All rights reserved. eXo Platform SAS
blog comments powered byDisqus