Creating File Shortcuts

To create file shortcuts (FileShortcut entities) in the Documents and Media library, you must use the DLAppService interface’s 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 DLAppService method addFileShortcut:

  1. Get a reference to DLAppService:

    private DLAppService _dlAppService;
  2. Get the data needed to populate the addFileShortcut method’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 javax.portlet.ActionRequest and 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);
  1. Call the service reference’s addFileShortcut method with the data from the previous step:

    FileShortcut fileShortcut = _dlAppService.addFileShortcut(
                                        repositoryId, folderId, toFileEntryId, 

    The method returns a FileShortcut object, 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 updateFileShortcut method of Liferay DXP’s EditFileShortcutMVCActionCommand 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 this updateFileShortcut method, as well as the rest of EditFileShortcutMVCActionCommand, contains additional logic to suit the specific needs of the Documents and Media app.

Deleting File Shortcuts

Updating File Shortcuts

« Creating FoldersDeleting Entities »
¿Fue útil este artículo?
Usuarios a los que les pareció útil: 0 de 0