ファイルショートカットの作成
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。
Documents and Mediaライブラリでファイルショートカット(FileShortcut
エンティティ)を作成するには、 DLAppService
インターフェイスの addFileShortcut
メソッドを使用する必要があります。
addFileShortcut(long repositoryId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
参照してください このメソッドのJavadocの パラメータの説明について。 このメソッドのパラメーターはすべて必須です。
ショートカットを作成するときは、次のことに注意してください。
- そのファイルとその結果のショートカットが同じポータルインスタンスにある場合、別のサイトのファイルへのショートカットを作成できます。
- フォルダーのショートカットを作成することはできません。
- ショートカットは、デフォルトのサイトリポジトリにのみ存在できます。 外部リポジトリのID(SharePointリポジトリなど)を使用して
addFileShortcut
を呼び出そうとすると、操作は失敗します。 すべてのリポジトリに同じ機能があるわけではないため、Documents and Media APIはすべてのリポジトリの共通の分母であるファイルとフォルダーのみをサポートします。
DLAppService
メソッド addFileShortcut
を使用してファイルショートカットを作成するには、次の手順に従います。
-
DLAppService
への参照を取得します。@Reference private DLAppService _dlAppService;
詳細については、入門チュートリアルの「サービスリファレンス 取得
」のセクションを参照してください。
2 addFileShortcut
メソッドの引数を設定するために必要なデータを取得します。 エンドユーザーから送信されたデータを使用してファイルショートカットを作成するのが一般的であるため、リクエストからデータを抽出できます。 この例では、 javax.portlet.ActionRequest
および ParamUtil
を介してこれを行いますが、任意の方法でデータを取得できます。
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);
リポジトリIDとフォルダIDの取得の詳細については、リポジトリとフォルダの指定に関する 入門チュートリアルの セクションを参照してください。 ServiceContext
詳細については、チュートリアル ServiceContextについて参照してください。
3 前の手順のデータを使用して、サービス参照の addFileShortcut
メソッドを呼び出します。
FileShortcut fileShortcut = _dlAppService.addFileShortcut(
repositoryId, folderId, toFileEntryId,
serviceContext);
このメソッドは FileShortcut
オブジェクトを返します`この例では、後で使用するために変数に設定します。 ただし、これを行う必要はありません。
この例の完全なコードは、Liferay DXPの EditFileShortcutMVCActionCommand`
クラスの `updateFileShortcut` メソッドにあります。 このクラスは、Documents and Media APIを使用して、Documents and Mediaアプリがサポートするほぼすべての `FileShortcut` アクションを実装します。 また、この `updateFileShortcut` メソッドと `つの残りのEditFileShortcutMVCActionCommand`には、Documents and Mediaアプリの特定のニーズに合う追加のロジックが含まれていることに注意してください。