To create file shortcuts (
FileShortcut entities) in the Documents and Media
library, you must use the
addFileShortcut method. The steps here show you how to do this.
For more detailed information, see
Creating Files, Folders, and Shortcuts.
For general information on using the API, see
Documents and Media API.
Follow these steps to create a file shortcut with the
Get a reference to
@Reference private DLAppService _dlAppService;
Get the data needed to populate the
addFileShortcutmethod’s arguments. Since it’s common to create a file shortcut with data submitted by the end user, you can extract the data from the request. This example does so via
ParamUtil, but you can get the data any way you wish:
long repositoryId = ParamUtil.getLong(actionRequest, "repositoryId"); long folderId = ParamUtil.getLong(actionRequest, "folderId"); long toFileEntryId = ParamUtil.getLong(actionRequest, "toFileEntryId"); ServiceContext serviceContext = ServiceContextFactory.getInstance( DLFileShortcutConstants.getClassName(), actionRequest);
Call the service reference’s
addFileShortcutmethod with the data from the previous step:
FileShortcut fileShortcut = _dlAppService.addFileShortcut( repositoryId, folderId, toFileEntryId, serviceContext);
The method returns a
FileShortcutobject, which this example sets to a variable for later use. Note, however, that you don’t have to do this.
You can find the full code for this example in the
of Liferay DXP’s
class. This class uses the Documents and Media API to implement almost all the
FileShortcut actions that the Documents and Media app supports. Also note that
updateFileShortcut method, as well as the rest of
EditFileShortcutMVCActionCommand, contains additional logic to suit the
specific needs of the Documents and Media app.