ContentHub クラス

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

例

この例では、バイナリコンテンツなし (メタデータのみ) のファイルを Google ドライブリポジトリフォルダに作成します。ファイルを作成した後、ファイルの ID、名前、説明、外部 URL、およびダウンロード URL を表示します。

1final String gDriveRepositoryId = '0XCxx00000000ODGAY', gDriveFolderId = 'folder:0B0lTys1KmM3sSVJ2bjIzTGFqSWs';
2
3final ConnectApi.ContentHubItemInput newItem = new ConnectApi.ContentHubItemInput();
4newItem.itemTypeId = 'document'; //see getAllowedTypes for any file item types available for creation/update
5newItem.fields = new List<ConnectApi.ContentHubFieldValueInput>();
6
7//Metadata: name field
8final ConnectApi.ContentHubFieldValueInput fieldValueInput = new ConnectApi.ContentHubFieldValueInput();
9fieldValueInput.name = 'name';
10fieldValueInput.value = 'new folder item name.txt';
11newItem.fields.add(fieldValueInput);
12
13//Metadata: description field
14final ConnectApi.ContentHubFieldValueInput fieldValueInputDesc = new ConnectApi.ContentHubFieldValueInput();
15fieldValueInputDesc.name = 'description';
16fieldValueInputDesc.value = 'It does describe it';
17newItem.fields.add(fieldValueInputDesc);
18
19final ConnectApi.RepositoryFolderItem newFolderItem = ConnectApi.ContentHub.addRepositoryItem(gDriveRepositoryId, gDriveFolderId, newItem);
20final ConnectApi.RepositoryFileSummary newFile = newFolderItem.file;
21System.debug(String.format('New file - id: \'\'{0}\'\', name: \'\'{1}\'\', description: \'\'{2}\'\' \n external URL: \'\'{3}\'\', download URL: \'\'{4}\'\'', new String[]{ newFile.id, newFile.name, newFile.description, newFile.externalDocumentUrl, newFile.downloadUrl}));

addRepositoryItem(communityId, repositoryId, repositoryFolderId, file)

Experience Cloud サイトのリポジトリ項目を追加します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFolderItem addRepositoryItem(String communityId, String repositoryId, String repositoryFolderId, ConnectApi.ContentHubItemInput file)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。
file: 型: ConnectApi.ContentHubItemInput; 項目種別の項目種別 ID と項目。

戻り値

使用方法

addRepositoryItem(repositoryId, repositoryFolderId, file, fileData)

リポジトリ項目 (バイナリファイルを含む) を追加します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFolderItem addRepositoryItem(String repositoryId, String repositoryFolderId, ConnectApi.ContentHubItemInput file, ConnectApi.BinaryInput fileData)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。
file: 型: ConnectApi.ContentHubItemInput; 項目種別の項目種別 ID と項目。
fileData: 型: ConnectApi.BinaryInput; バイナリファイル。

戻り値

使用方法

例

この例では、バイナリコンテンツとメタデータを含むファイルを Google ドライブリポジトリフォルダに作成します。ファイルを作成した後、ファイルの ID、名前、説明、外部 URL、およびダウンロード URL を表示します。

1final String gDriveRepositoryId = '0XCxx00000000ODGAY', gDriveFolderId = 'folder:0B0lTys1KmM3sSVJ2bjIzTGFqSWs';
2
3final ConnectApi.ContentHubItemInput newItem = new ConnectApi.ContentHubItemInput();
4newItem.itemTypeId = 'document'; //see getAllowedTypes for any file item types available for creation/update
5newItem.fields = new List<ConnectApi.ContentHubFieldValueInput>();
6
7//Metadata: name field
8Final String newFileName = 'new folder item name.txt';
9final ConnectApi.ContentHubFieldValueInput fieldValueInput = new ConnectApi.ContentHubFieldValueInput();
10fieldValueInput.name = 'name';
11fieldValueInput.value = newFileName;
12newItem.fields.add(fieldValueInput);
13
14//Metadata: description field
15final ConnectApi.ContentHubFieldValueInput fieldValueInputDesc = new ConnectApi.ContentHubFieldValueInput();
16fieldValueInputDesc.name = 'description';
17fieldValueInputDesc.value = 'It does describe it';
18newItem.fields.add(fieldValueInputDesc);
19
20//Binary content
21final Blob newFileBlob = Blob.valueOf('awesome content for brand new file');
22final String newFileMimeType = 'text/plain';
23final ConnectApi.BinaryInput fileBinaryInput = new ConnectApi.BinaryInput(newFileBlob, newFileMimeType, newFileName);
24
25final ConnectApi.RepositoryFolderItem newFolderItem = ConnectApi.ContentHub.addRepositoryItem(gDriveRepositoryId, gDriveFolderId, newItem, fileBinaryInput);
26final ConnectApi.RepositoryFileSummary newFile = newFolderItem.file;
27System.debug(String.format('New file - id: \'\'{0}\'\', name: \'\'{1}\'\', description: \'\'{2}\'\' \n external URL: \'\'{3}\'\', download URL: \'\'{4}\'\'', new String[]{ newFile.id, newFile.name, newFile.description, newFile.externalDocumentUrl, newFile.downloadUrl}));

addRepositoryItem(communityId, repositoryId, repositoryFolderId, file, fileData)

Experience Cloud サイトのリポジトリ項目 (バイナリファイルを含む) を追加します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFolderItem addRepositoryItem(String communityId, String repositoryId, String repositoryFolderId, ConnectApi.ContentHubItemInput file, ConnectApi.BinaryInput fileData)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。
file: 型: ConnectApi.ContentHubItemInput; 項目種別の項目種別 ID と項目。
fileData: 型: ConnectApi.BinaryInput; バイナリファイル。

戻り値

型: ConnectApi.ContentHubAllowedItemTypeCollection

使用方法

getAllowedItemTypes(repositoryId, repositoryFolderId)

コンテキストユーザがリポジトリフォルダに作成できる項目種別を取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ContentHubAllowedItemTypeCollection getAllowedItemTypes(String repositoryId, String repositoryFolderId)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。

戻り値

使用方法

getAllowedItemTypes(repositoryId, repositoryFolderId, filter)

コンテキストユーザがリポジトリフォルダに作成できる項目種別を種別で絞り込まれた状態で取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ContentHubAllowedItemTypeCollection getAllowedItemTypes(String repositoryId, String repositoryFolderId, ConnectApi.ConnectContentHubItemType filter)

パラメータ

repositoryId

型: String

リポジトリの ID。

repositoryFolderId

型: String

リポジトリフォルダの ID。

filter

型: ConnectApi.ContentHubAllowedItemTypeCollection

項目種別。値は次のとおりです。

Any — ファイルとフォルダを含めます。
FilesOnly — ファイルのみを含めます。
FoldersOnly — フォルダのみを含めます。

戻り値

使用方法

このメソッドを使用するコード��テストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

例

この例では、getAllowedItemTypes(repositoryId, repositoryFolderId, ConnectApi.ContentHubItemType.FilesOnly) をコールして、ファイルの最初の ConnectApi.ContentHubItemTypeSummary.id を取得します。コンテキストユーザは外部システムのリポジトリフォルダに、許可されたファイルを作成できます。

1final ConnectApi.ContentHubAllowedItemTypeCollection allowedItemTypesColl = ConnectApi.ContentHub.getAllowedItemTypes(repositoryId, repositoryFolderId, ConnectApi.ContentHubItemType.FilesOnly);
2final List<ConnectApi.ContentHubItemTypeSummary> allowedItemTypes = allowedItemTypesColl.allowedItemTypes;
3string allowedFileItemTypeId = null;
4if(allowedItemTypes.size() > 0){
5   ConnectApi.ContentHubItemTypeSummary allowedItemTypeSummary = allowedItemTypes.get(0);
6   allowedFileItemTypeId = allowedItemTypeSummary.id;
7}

getAllowedItemTypes(communityId, repositoryId, repositoryFolderId)

コンテキストユーザが Experience Cloud サイトのリポジトリフォルダに作成できる項目種別を取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ContentHubAllowedItemTypeCollection getAllowedItemTypes(String communityId, String repositoryId, String repositoryFolderId)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。

戻り値

型: ConnectApi.ContentHubAllowedItemTypeCollection

使用方法

getAllowedItemTypes(communityId, repositoryId, repositoryFolderId, filter)

コンテキストユーザが Experience Cloud サイトのリポジトリフォルダに作成できる項目種別を種別で絞り込まれた状態で取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ContentHubAllowedItemTypeCollection getAllowedItemTypes(String communityId, String repositoryId, String repositoryFolderId, ConnectApi.ConnectContentHubItemType filter)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null を使用します。

repositoryId

型: String

リポジトリの ID。

repositoryFolderId

型: String

リポジトリフォルダの ID。

filter

型: ConnectApi.ContentHubAllowedItemTypeCollection

項目種別。値は次のとおりです。

Any — ファイルとフォルダを含めます。
FilesOnly — ファイルのみを含めます。
FoldersOnly — フォルダのみを含めます。

戻り値

使用方法

getFilePreview(repositoryId, repositoryFileId, formatType)

リポジトリファイルのプレビューを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.FilePreview getFilePreview(String repositoryId, String repositoryFileId, ConnectApi.FilePreviewFormat formatType)

パラメータ

repositoryId

型: String

リポジトリの ID。

repositoryFileId

型: String

リポジトリファイルの ID。

formatType

ファイルプレビューの形式を指定します。値は次のとおりです。

Jpg — プレビュー形式は JPG です。
Pdf — プレビュー形式は PDF です。
Svg — プレビュー形式は圧縮 SVG です。
Thumbnail — プレビュー形式は 240×180 の PNG です。
ThumbnailBig — プレビュー形式は 720×480 の PNG です。
ThumbnailTiny — プレビュー形式は 120×90 の PNG です。

PDF プレビューは、DOC、DOCX、PPT、PPTX、TEXT、XLS、および XLSX タイプのファイルで利用できます。SVG ファイルはオンデマンドで生成されます。

組織で機能の豊富な SVG プレビューが動作しないと思われる場合は、代替ファイルプレビューを選択します。JPG ファイルプレビューを使用するには、[設定] で [クイック検索] ボックスに「一般」と入力します。[一般設定] を選択して、[代替ファイルプレビューを表示] を選択します。

戻り値

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、��ードで例外が発生します。

例

この例では、getFilePreview(repositoryId, repositoryFileId, ConnectApi.FilePreviewFormat.Thumbnail) をコールして、サムネール形式のプレビューと共にその各 URL とサムネール変換の数を取得します。サムネール形式ごとに、使用可能な各変換 URL を表示します。

1final String gDriveRepositoryId = '0XCxx00000000ODGAY', gDriveFileId =
2'document:1-zcA1BaeoQbo2_yNFiHCcK6QJTPmOke-kHFC4TYg3rk';final ConnectApi.FilePreview filePreview =
3ConnectApi.ContentHub.getFilePreview(gDriveRepositoryId, gDriveFileId,
4ConnectApi.FilePreviewFormat.Thumbnail);System.debug(String.format('Preview - URL: \'\'{0}\'\', format: \'\'{1}\'\', nbr of
5renditions for this format: {2}', new String[]{ filePreview.url,
6filePreview.format.name(),String.valueOf(filePreview.previewUrls.size())}));for(ConnectApi.FilePreviewUrl filePreviewUrl : filePreview.previewUrls){
7   System.debug('-----> Rendition URL: ' + filePreviewUrl.previewUrl);
8}

getFilePreview(repositoryId, repositoryFileId, formatType, startPageNumber, endPageNumber)

リポジトリファイルのプレビューのページまたはページ範囲を取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.FilePreview getFilePreview(String repositoryId, String repositoryFileId, ConnectApi.FilePreviewFormat formatType, Integer startPageNumber, Integer endPageNumber)

パラメータ

repositoryId

型: String

リポジトリの ID。

repositoryFileId

型: String

リポジトリファイルの ID。

formatType

ファイルプレビューの形式を指定します。値は次のとおりです。

Jpg — プレビュー形式は JPG です。
Pdf — プレビュー形式は PDF です。
Svg — プレビュー形式は圧縮 SVG です。
Thumbnail — プレビュー形式は 240×180 の PNG です。
ThumbnailBig — プレビュー形式は 720×480 の PNG です。
ThumbnailTiny — プレビュー形式は 120×90 の PNG です。

PDF プレビューは、DOC、DOCX、PPT、PPTX、TEXT、XLS、および XLSX タイプのファイルで利用できます。SVG ファイルはオンデマンドで生成されます。

startPageNumber

型: Integer

ファイルプレビュー URL 範囲の開始ページ番号。

endPageNumber

型: Integer

ファイルプレビュー URL 範囲の終了ページ番号。

戻り値

使用方法

getFilePreview(communityId, repositoryId, repositoryFileId, formatType)

Experience Cloud サイトのリポジトリファイルのプレビューを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.FilePreview getFilePreview(String communityId, String repositoryId, String repositoryFileId, ConnectApi.FilePreviewFormat formatType)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null を使用します。

repositoryId

型: String

リポジトリの ID。

repositoryFileId

型: String

リポジトリファイルの ID。

formatType

ファイルプレビューの形式を指定します。値は次のとおりです。

Jpg — プレビュー形式は JPG です。
Pdf — プレビュー形式は PDF です。
Svg — プレビュー形式は圧縮 SVG です。
Thumbnail — プレビュー形式は 240×180 の PNG です。
ThumbnailBig — プレビュー形式は 720×480 の PNG です。
ThumbnailTiny — プレビュー形式は 120×90 の PNG です。

PDF プレビューは、DOC、DOCX、PPT、PPTX、TEXT、XLS、および XLSX タイプのファイルで利用できます。SVG ファイルはオンデマンドで生成されます。

戻り値

使用方法

getFilePreview(communityId, repositoryId, repositoryFileId, formatType, startPageNumber, endPageNumber)

Experience Cloud サイトのリポジトリファイルのプレビューのページまたはページ範囲を取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.FilePreview getFilePreview(String communityId, String repositoryId, String repositoryFileId, ConnectApi.FilePreviewFormat formatType, Integer startPageNumber, Integer endPageNumber)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null を使用します。

repositoryId

型: String

リポジトリの ID。

repositoryFileId

型: String

リポジトリファイルの ID。

formatType

ファイルプレビューの形式を指定します。値は次のとおりです。

Jpg — プレビュー形式は JPG です。
Pdf — プレビュー形式は PDF です。
Svg — プレビュー形式は圧縮 SVG です。
Thumbnail — プレビュー形式は 240×180 の PNG です。
ThumbnailBig — プレビュー形式は 720×480 の PNG です。
ThumbnailTiny — プレビュー形式は 120×90 の PNG です。

PDF プレビューは、DOC、DOCX、PPT、PPTX、TEXT、XLS、および XLSX タイプのファイルで利用できます。SVG ファイルはオンデマンドで生成されます。

startPageNumber

型: Integer

ファイルプレビュー URL 範囲の開始ページ番号。

endPageNumber

型: Integer

ファイルプレビュー URL 範囲の終了ページ番号。

戻り値

使用方法

getItemType(repositoryId, repositoryItemTypeId)

リポジトリに関連付けられた項目種別に関する情報を取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ContentHubItemTypeDetail getItemType(String repositoryId, String repositoryItemTypeId)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryItemTypeId: 型: String; リポジトリ項目種別の ID。

戻り値

型: ConnectApi.ContentHubItemTypeDetail

使用方法

getItemType(communityId, repositoryId, repositoryItemTypeId)

Experience Cloud サイトのリポジトリに関連付けられた項目種別に関する情報を取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ContentHubItemTypeDetail getItemType(String communityId, String repositoryId, String repositoryItemTypeId)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryItemTypeId: 型: String; リポジトリ項目種別の ID。

戻り値

型: ConnectApi.ContentHubItemTypeDetail

使用方法

getPreviews(repositoryId, repositoryFileId)

リポジトリファイルのサポートされているプレビューに関する情報を取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.FilePreviewCollection getPreviews(String repositoryId, String repositoryFileId)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFileId: 型: String; リポジトリファイルの ID。

戻り値

型: ConnectApi.FilePreviewCollection

使用方法

例

この例では、サポートされるすべてのプレビュー形式と、その各 URL および変換の数を取得します。サポートされるプレビュー形式ごとに、使用可能な各変換 URL を表示します。

1final String gDriveRepositoryId = '0XCxx00000000ODGAY', gDriveFileId = 'document:1-zcA1BaeoQbo2_yNFiHCcK6QJTPmOke-kHFC4TYg3rk';
2final ConnectApi.FilePreviewCollection previewsCollection = ConnectApi.ContentHub.getPreviews(gDriveRepositoryId, gDriveFileId);
3for(ConnectApi.FilePreview filePreview : previewsCollection.previews){
4   System.debug(String.format('Preview - URL: \'\'{0}\'\', format: \'\'{1}\'\', nbr of renditions for this format: {2}', new String[]{ filePreview.url, filePreview.format.name(),String.valueOf(filePreview.previewUrls.size())}));
5   for(ConnectApi.FilePreviewUrl filePreviewUrl : filePreview.previewUrls){
6      System.debug('-----> Rendition URL: ' + filePreviewUrl.previewUrl);
7      }
8}

getPreviews(communityId, repositoryId, repositoryFileId)

Experience Cloud サイトのリポジトリファイルのサポートされているプレビューに関する情報を取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.FilePreviewCollection getPreviews(String communityId, String repositoryId, String repositoryFileId)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFileId: 型: String; リポジトリファイルの ID。

戻り値

型: ConnectApi.FilePreviewCollection

使用方法

getRepositories()

リポジトリのリストを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ContentHubRepositoryCollection getRepositories()

戻り値

使用方法

例

この例では、すべてのリポジトリを取得し、見つかった最初の SharePoint オンラインリポジトリを取得します。

1final string sharePointOnlineProviderType ='ContentHubSharepointOffice365';
2final ConnectApi.ContentHubRepositoryCollection repositoryCollection = ConnectApi.ContentHub.getRepositories();
3ConnectApi.ContentHubRepository sharePointOnlineRepository = null;
4for(ConnectApi.ContentHubRepository repository : repositoryCollection.repositories){
5   if(sharePointOnlineProviderType.equalsIgnoreCase(repository.providerType.type)){
6      sharePointOnlineRepository = repository;
7      break;
8   }
9}

getRepositories(communityId)

Experience Cloud サイトのリポジトリのリストを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ContentHubRepositoryCollection getRepositories(String communityId)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。

戻り値

使用方法

getRepositories(pageParam, pageSize)

リポジトリのページを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ContentHubRepositoryCollection getRepositories(Integer pageParam, Integer pageSize)

パラメータ

pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトのページサイズの 25 に設定されます。

戻り値

使用方法

getRepositories(communityId, pageParam, pageSize)

Experience Cloud サイトのリポジトリのページを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ContentHubRepositoryCollection getRepositories(String communityId, Integer pageParam, Integer pageSize)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトのページサイズの 25 に設定されます。

戻り値

使用方法

getRepository(repositoryId)

リポジトリを取得します。

API バージョン

369.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ContentHubRepository getRepository(String repositoryId)

パラメータ

repositoryId: 型: String; リポジトリの ID。

戻り値

型: ConnectApi.ContentHubRepository

使用方法

例

1final string repositoryId = '0XCxx0000000123GAA';
2final ConnectApi.ContentHubRepository repository = ConnectApi.ContentHub.getRepository(repositoryId);

getRepository(communityId, repositoryId)

Experience Cloud サイトのリポジトリを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ContentHubRepository getRepository(String communityId, String repositoryId)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。

戻り値

型: ConnectApi.ContentHubRepository

使用方法

getRepositoryFile(repositoryId, repositoryFileId)

リポジトリファイルを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFileDetail getRepositoryFile(String repositoryId, String repositoryFileId)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFileId: 型: String; リポジトリファイルの ID。

戻り値

使用方法

例

1final String gDriveRepositoryId = '0XCxx00000000ODGAY', gDriveFileId = 'file:0B0lTys1KmM3sTmxKNjVJbWZja00';
2final ConnectApi.RepositoryFileDetail file = ConnectApi.ContentHub.getRepositoryFile(gDriveRepositoryId, gDriveFileId);
3System.debug(String.format('File - name: \'\'{0}\'\', size: {1}, external URL: \'\'{2}\'\', download URL: \'\'{3}\'\'', 
4   new String[]{ file.name, String.valueOf(file.contentSize), file.externalDocumentUrl, file.downloadUrl}));

getRepositoryFile(repositoryId, repositoryFileId, includeExternalFilePermissionsInfo)

リポジトリファイル (権限情報あり/なし) を取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFileDetail getRepositoryFile(String repositoryId, String repositoryFileId, Boolean includeExternalFilePermissionsInfo)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFileId: 型: String; リポジトリファイルの ID。
includeExternalFilePermissionsInfo: 型: Boolean; ファイルを共有するかどうか、使用可能な権限タイプなど��権限情報を含めるかどうかを指定します。
外部ファイル権限の管理は、Google ドライブ、SharePoint Online、OneDrive for Business でサポートされています。

戻り値

使用方法

例

1final String gDriveRepositoryId = '0XCxx00000000ODGAY', gDriveFileId = 'file:0B0lTys1KmM3sTmxKNjVJbWZja00';
2
3final ConnectApi.RepositoryFileDetail file = ConnectApi.ContentHub.getRepositoryFile(gDriveRepositoryId, gDriveFileId, true);
4System.debug(String.format('File - name: \'\'{0}\'\', size: {1}, external URL: \'\'{2}\'\', download URL: \'\'{3}\'\'', new String[]{ file.name, String.valueOf(file.contentSize), file.externalDocumentUrl, file.downloadUrl}));
5final ConnectApi.ExternalFilePermissionInformation externalFilePermInfo = file.externalFilePermissionInformation;
6
7//permission types
8final List<ConnectApi.ContentHubPermissionType> permissionTypes = externalFilePermInfo.externalFilePermissionTypes;
9for(ConnectApi.ContentHubPermissionType permissionType : permissionTypes){
10   System.debug(String.format('Permission type - id: \'\'{0}\'\', label: \'\'{1}\'\'', new String[]{ permissionType.id, permissionType.label}));
11}
12
13//permission groups
14final List<ConnectApi.RepositoryGroupSummary> groups = externalFilePermInfo.repositoryPublicGroups;
15for(ConnectApi.RepositoryGroupSummary ggroup : groups){
16   System.debug(String.format('Group - id: \'\'{0}\'\', name: \'\'{1}\'\', type: \'\'{2}\'\'', new String[]{ ggroup.id, ggroup.name, ggroup.type.name()}));
17}

getRepositoryFile(communityId, repositoryId, repositoryFileId)

Experience Cloud サイトのリポジトリファイルを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFileDetail getRepositoryFile(String communityId, String repositoryId, String repositoryFileId)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFileId: 型: String; リポジトリファイルの ID。

戻り値

使用方法

getRepositoryFile(communityId, repositoryId, repositoryFileId, includeExternalFilePermissionsInfo)

Experience Cloud サイトのリポジトリファイル (権限情報あり/なし) を取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFileDetail getRepositoryFile(String communityId, String repositoryId, String repositoryFileId, Boolean includeExternalFilePermissionsInfo)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFileId: 型: String; リポジトリファイルの ID。
includeExternalFilePermissionsInfo: 型: Boolean; ファイルを共有するかどうか、使用可能な権限タイプなどの権限情報を含めるかどうかを指定します。
外部ファイル権限の管理は、Google ドライブ、SharePoint Online、OneDrive for Business でサポートされています。

戻り値

使用方法

getRepositoryFolder(repositoryId, repositoryFolderId)

リポジトリフォルダを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFolderDetail getRepositoryFolder(String repositoryId, String repositoryFolderId)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。

戻り値

型: ConnectApi.RepositoryFolderDetail

使用方法

例

1final String gDriveRepositoryId = '0XCxx00000000ODGAY', gDriveFolderId = 'folder:0B0lTys1KmM3sSVJ2bjIzTGFqSWs';
2final ConnectApi.RepositoryFolderDetail folder = ConnectApi.ContentHub.getRepositoryFolder(gDriveRepositoryId, gDriveFolderId);
3System.debug(String.format('Folder - name: \'\'{0}\'\', description: \'\'{1}\'\', external URL: \'\'{2}\'\', folder items URL: \'\'{3}\'\'', 
4   new String[]{ folder.name, folder.description, folder.externalFolderUrl, folder.folderItemsUrl}));

getRepositoryFolder(communityId, repositoryId, repositoryFolderId)

Experience Cloud サイトのリポジトリフォルダを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFolderDetail getRepositoryFolder(String communityId, String repositoryId, String repositoryFolderId)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。

戻り値

型: ConnectApi.RepositoryFolderDetail

使用方法

getRepositoryFolderItems(repositoryId, repositoryFolderId)

リポジトリフォルダ項目を取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFolderItemsCollection getRepositoryFolderItems(String repositoryId, String repositoryFolderId)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。

戻り値

使用方法

例

この例では、リポジトリフォルダ内の項目のコレクションを取得します。ファイルの場合、ファイルの名前、サイズ、外部 URL、およびダウンロード URL を表示します。フォルダの場合、フォルダの名前、説明、および外部 URL を表示します。

1final String gDriveRepositoryId = '0XCxx00000000ODGAY', gDriveFolderId = 'folder:0B0lTys1KmM3sSVJ2bjIzTGFqSWs';
2final ConnectApi.RepositoryFolderItemsCollection folderItemsColl = ConnectApi.ContentHub.getRepositoryFolderItems(gDriveRepositoryId,gDriveFolderId);
3final List<ConnectApi.RepositoryFolderItem> folderItems = folderItemsColl.items;
4System.debug('Number of items in repository folder: ' + folderItems.size());
5for(ConnectApi.RepositoryFolderItem item : folderItems){
6   ConnectApi.RepositoryFileSummary fileSummary = item.file;
7   if(fileSummary != null){
8      System.debug(String.format('File item - name: \'\'{0}\'\', size: {1}, external URL: \'\'{2}\'\', download URL: \'\'{3}\'\'', new String[]{ fileSummary.name, String.valueOf(fileSummary.contentSize), fileSummary.externalDocumentUrl, fileSummary.downloadUrl}));
9      }else{
10         ConnectApi.RepositoryFolderSummary folderSummary = item.folder;
11         System.debug(String.format('Folder item - name: \'\'{0}\'\', description: \'\'{1}\'\'',  new String[]{ folderSummary.name, folderSummary.description}));
12      }
13}

getRepositoryFolderItems(communityId, repositoryId, repositoryFolderId)

Experience Cloud サイトのリポジトリフォルダ項目を取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFolderItemsCollection getRepositoryFolderItems(String communityId, String repositoryId, String repositoryFolderId)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。

戻り値

使用方法

getRepositoryFolderItems(repositoryId, repositoryFolderId, pageParam, pageSize)

リポジトリフォルダ項目のページを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFolderItemsCollection getRepositoryFolderItems(String repositoryId, String repositoryFolderId, Integer pageParam, Integer pageSize)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。
pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトのページサイズの 25 に設定されます。

戻り値

使用方法

getRepositoryFolderItems(communityId, repositoryId, repositoryFolderId, pageParam, pageSize)

Experience Cloud サイトのリポジトリフォルダ項目のページを取得します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFolderItemsCollection getRepositoryFolderItems(String communityId, String repositoryId, String repositoryFolderId, Integer pageParam, Integer pageSize)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。
pageParam: 型: Integer; 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトのページサイズの 25 に設定されます。

戻り値

使用方法

updateRepositoryFile(repositoryId, repositoryFileId, file)

リポジトリファイルの名前を更新します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFileDetail updateRepositoryFile(String repositoryId, String repositoryFileId, ConnectApi.ContentHubItemInput file)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFileId: 型: String; リポジトリファイルの ID。
file: 型: ConnectApi.ContentHubItemInput; 項目種別の項目種別 ID と項目。
リポジトリファイルのメタデータを更新する場合、更新できるのは名前項目のみです。

戻り値

使用方法

例

この例では、Google ドライブリポジトリ内のファイル名を更新します。ファイルを更新した後、ファイルの ID、名前、説明、外部 URL、およびダウンロード URL を表示します。

1final String gDriveRepositoryId = '0XCxx00000000ODGAY', gDriveFolderId = 'folder:0B0lTys1KmM3sSVJ2bjIzTGFqSWs', gDriveFileId = 'document:1q9OatVpcyYBK-JWzp_PhR75ulQghwFP15zhkamKrRcQ';
2
3final ConnectApi.ContentHubItemInput updatedItem = new ConnectApi.ContentHubItemInput();
4updatedItem.itemTypeId = 'document'; //see getAllowedTypes for any file item types available for creation/update
5updatedItem.fields = new List<ConnectApi.ContentHubFieldValueInput>();
6
7//Metadata: name field
8final ConnectApi.ContentHubFieldValueInput fieldValueInputName = new ConnectApi.ContentHubFieldValueInput();
9fieldValueInputName.name = 'name';
10fieldValueInputName.value =  'updated file name.txt';
11updatedItem.fields.add(fieldValueInputName);
12
13final ConnectApi.RepositoryFileDetail updatedFile = ConnectApi.ContentHub.updateRepositoryFile(gDriveRepositoryId, gDriveFileId, updatedItem);
14System.debug(String.format('Updated file - id: \'\'{0}\'\', name: \'\'{1}\'\', description: \'\'{2}\'\',\n external URL: \'\'{3}\'\', download URL: \'\'{4}\'\'',  new String[]{ updatedFile.id, updatedFile.name, updatedFile.description, updatedFile.externalDocumentUrl, updatedFile.downloadUrl}));

updateRepositoryFile(repositoryId, repositoryFileId, file, fileData)

リポジトリファイルの内容を更新します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFileDetail updateRepositoryFile(String repositoryId, String repositoryFileId, ConnectApi.ContentHubItemInput file, ConnectApi.BinaryInput fileData)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFileId: 型: String; リポジトリファイルの ID。
file: 型: ConnectApi.ContentHubItemInput; 項目種別の項目種別 ID と項目。
リポジトリファイルのメタデータを更新する場合、更新できるのは名前項目のみです。
fileData: 型: ConnectApi.BinaryInput; バイナリファイル。

戻り値

使用方法

例

この例では、Google ドライブリポジトリ内のファイルの内容と名前を更新します。ファイルを更新した後、ファイルの ID、名前、説明、外部 URL、およびダウンロード URL を表示します。

1final String gDriveRepositoryId = '0XCxx00000000ODGAY', gDriveFolderId = 'folder:0B0lTys1KmM3sSVJ2bjIzTGFqSWs', gDriveFileId = 'document:1q9OatVpcyYBK-JWzp_PhR75ulQghwFP15zhkamKrRcQ';
2
3final ConnectApi.ContentHubItemInput updatedItem = new ConnectApi.ContentHubItemInput();
4updatedItem.itemTypeId = 'document'; //see getAllowedTypes for any file item types available for creation/update
5updatedItem.fields = new List<ConnectApi.ContentHubFieldValueInput>();
6
7//Metadata: name field
8final ConnectApi.ContentHubFieldValueInput fieldValueInputName = new ConnectApi.ContentHubFieldValueInput();
9fieldValueInputName.name = 'name';
10fieldValueInputName.value =  'updated file name.txt';
11updatedItem.fields.add(fieldValueInputName);
12
13//Binary content
14final Blob updatedFileBlob = Blob.valueOf('even more awesome content for updated file');
15final String updatedFileMimeType = 'text/plain';
16final ConnectApi.BinaryInput fileBinaryInput = new ConnectApi.BinaryInput(updatedFileBlob, updatedFileMimeType, updatedFileName);
17
18final ConnectApi.RepositoryFileDetail updatedFile = ConnectApi.ContentHub.updateRepositoryFile(gDriveRepositoryId, gDriveFileId, updatedItem);
19System.debug(String.format('Updated file - id: \'\'{0}\'\', name: \'\'{1}\'\', description: \'\'{2}\'\',\n external URL: \'\'{3}\'\', download URL: \'\'{4}\'\'',  new String[]{ updatedFile.id, updatedFile.name, updatedFile.description, updatedFile.externalDocumentUrl, updatedFile.downloadUrl}));

updateRepositoryFile(communityId, repositoryId, repositoryFileId, file)

Experience Cloud サイトのリポジトリファイルの名前を更新します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFileDetail updateRepositoryFile(String communityId, String repositoryId, String repositoryFileId, ConnectApi.ContentHubItemInput file)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFileId: 型: String; リポジトリファイルの ID。
file: 型: ConnectApi.ContentHubItemInput; 項目種別の項目種別 ID と項目。
リポジトリファイルのメタデータを更新する場合、更新できるのは名前項目のみです。

戻り値

使用方法

updateRepositoryFile(communityId, repositoryId, repositoryFileId, file, fileData)

Experience Cloud サイトのリポジトリファイルの内容を更新します。

API バージョン

39.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.RepositoryFileDetail updateRepositoryFile(String communityId, String repositoryId, String repositoryFileId, ConnectApi.ContentHubItemInput file, ConnectApi.BinaryInput fileData)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFileId: 型: String; リポジトリファイルの ID。
file: 型: ConnectApi.ContentHubItemInput; 項目種別の項目種別 ID と項目。
リポジトリファイルのメタデータを更新する場合、更新できるのは名前項目のみです。
fileData: 型: ConnectApi.BinaryInput; バイナリファイル。

戻り値

使用方法

ContentHub テストメソッド

ContentHub のテストメソッドを次に示します。すべてのメソッドが静的です。

これらのメソッドを使用して ConnectApi コードをテストする方法の詳細は、「ConnectApi コードのテスト」を参照してください。

setTestAddRepositoryItem(repositoryId, repositoryFolderId, file, result)

一致する addRepositoryItem(repositoryId, repositoryFolderId, file) メソッドをテストコンテキストでコールするときに返される ConnectApi.RepositoryFolderItem オブジェクトを登録します。メソッドでは、同じパラメータを使用します。パラメータが同じでないと、例外が発生します。

API バージョン

40.0

署名

public static Void setTestAddRepositoryItem(String repositoryId, String repositoryFolderId, ConnectApi.ContentHubItemInput file, ConnectApi.RepositoryFolderItem result)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。
file: 型: ConnectApi.ContentHubItemInput; 項目種別の項目種別 ID と項目。
result: 型: ConnectApi.RepositoryFolderItem; テストデータを含むオブジェクト。

戻り値

型: Void

setTestAddRepositoryItem(communityId, repositoryId, repositoryFolderId, file, result)

一致する addRepositoryItem(communityId, repositoryId, repositoryFolderId, file) メソッドをテストコンテキストでコールするときに返される ConnectApi.RepositoryFolderItem オブジェクトを登録します。メソッドでは、同じパラメータを使用します。パラメータが同じでないと、例外が発生します。

API バージョン

40.0

署名

public static Void setTestAddRepositoryItem(String communityId, String repositoryId, String repositoryFolderId, ConnectApi.ContentHubItemInput file, ConnectApi.RepositoryFolderItem result)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。
file: 型: ConnectApi.ContentHubItemInput; 項目種別の項目種別 ID と項目。
result: 型: ConnectApi.RepositoryFolderItem; テストデータを含むオブジェクト。

戻り値

型: Void

setTestAddRepositoryItem(repositoryId, repositoryFolderId, file, fileData, result)

一致する addRepositoryItem(repositoryId, repositoryFolderId, file, fileData) メソッドをテストコンテキストでコールするときに返される ConnectApi.RepositoryFolderItem オブジェクトを登録します。メソッドでは、同じパラメータを使用します。パラメータが同じでないと、例外が発生します。

API バージョン

40.0

署名

public static Void setTestAddRepositoryItem(String repositoryId, String repositoryFolderId, ConnectApi.ContentHubItemInput file, ConnectApi.BinaryInput fileData, ConnectApi.RepositoryFolderItem result)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。
file: 型: ConnectApi.ContentHubItemInput; 項目種別の項目種別 ID と項目。
fileData: 型: ConnectApi.BinaryInput; バイナリファイル。
result: 型: ConnectApi.RepositoryFolderItem; テストデータを含むオブジェクト。

戻り値

型: Void

setTestAddRepositoryItem(communityId, repositoryId, repositoryFolderId, file, fileData, result)

一致する addRepositoryItem(communityId, repositoryId, repositoryFolderId, file, fileData) メソッドをテストコンテキストでコールするときに返される ConnectApi.RepositoryFolderItem オブジェクトを登録します。メソッドでは、同じパラメータを使用します。パラメータが同じでないと、例外が発生します。

API バージョン

40.0

署名

public static Void setTestAddRepositoryItem(String communityId, String repositoryId, String repositoryFolderId, ConnectApi.ContentHubItemInput file, ConnectApi.BinaryInput fileData, ConnectApi.RepositoryFolderItem result)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。
file: 型: ConnectApi.ContentHubItemInput; 項目種別の項目種別 ID と項目。
fileData: 型: ConnectApi.BinaryInput; バイナリファイル。
result: 型: ConnectApi.RepositoryFolderItem; テストデータを含むオブジェクト。

戻り値

型: Void

setTestGetAllowedItemTypes(repositoryId, repositoryFolderId, result)

一致する getAllowedItemTypes(repositoryId, repositoryFolderId) メソッドをテストコンテキストでコールするときに返される ConnectApi.ContentHubAllowedItemTypeCollection オブジェクトを登録します。メソッドでは、同じパラメータを使用します。パラメータが同じでないと、例外が発生します。

API バージョン

40.0

署名

public static Void setTestGetAllowedItemTypes(String repositoryId, String repositoryFolderId, ConnectApi.ContentHubAllowedItemTypeCollection result)

パラメータ

repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。
result: 型: ConnectApi.ContentHubAllowedItemTypeCollection; テストデータを含むオブジェクト。

戻り値

型: Void

setTestGetAllowedItemTypes(repositoryId, repositoryFolderId, filter, result)

一致する getAllowedItemTypes(repositoryId, repositoryFolderId, filter) メソッドをテストコンテキストでコールするときに返される ConnectApi.ContentHubAllowedItemTypeCollection オブジェクトを登録します。メソッドでは、同じパラメータを使用します。パラメータが同じでないと、例外が発生します。

API バージョン

40.0

署名

public static Void setTestGetAllowedItemTypes(String repositoryId, String repositoryFolderId, ConnectApi.ContentHubItemType filter, ConnectApi.ContentHubAllowedItemTypeCollection result)

パラメータ

repositoryId

型: String

リポジトリの ID。

repositoryFolderId

型: String

リポジトリフォルダの ID。

filter

項目種別。値は次のとおりです。

Any — ファイルとフォルダを含めます。
FilesOnly — ファイルのみを含めます。
FoldersOnly — フォルダのみを含めます。

result

型: ConnectApi.ContentHubAllowedItemTypeCollection

テストデータを含むオブジェクト。

戻り値

型: Void

setTestGetAllowedItemTypes(communityId, repositoryId, repositoryFolderId, result)

一致する getAllowedItemTypes(communityId, repositoryId, repositoryFolderId) メソッドをテストコンテキストでコールするときに返される ConnectApi.ContentHubAllowedItemTypeCollection オブジェクトを登録します。メソッドでは、同じパラメータを使用します。パラメータが同じでないと、例外が発生します。

API バージョン

40.0

署名

public static Void setTestGetAllowedItemTypes(String communityId, String repositoryId, String repositoryFolderId, ConnectApi.ContentHubAllowedItemTypeCollection result)

パラメータ

communityId: 型: String; Experience Cloud サイトの ID、internal、または null を使用します。
repositoryId: 型: String; リポジトリの ID。
repositoryFolderId: 型: String; リポジトリフォルダの ID。
result: 型: ConnectApi.ContentHubAllowedItemTypeCollection; テストデータを含むオブジェクト。

戻り値

型: Void

setTestGetAllowedItemTypes(communityId, repositoryId, repositoryFolderId, filter, result)

一致する getAllowedItemTypes(communityId, repositoryId, repositoryFolderId, filter) メソッドをテストコンテキストでコールするときに返される ConnectApi.ContentHubAllowedItemTypeCollection オブジェクトを登録します。メソッドでは、同じパラメータを使用します。パラメータが同じでないと、例外が発生します。

API バージョン

40.0

署名

public static Void setTestGetAllowedItemTypes(String communityId, String repositoryId, String repositoryFolderId, ConnectApi.ContentHubItemType filter, ConnectApi.ContentHubAllowedItemTypeCollection result)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null を使用します。

repositoryId

型: String

リポジトリの ID。

repositoryFolderId

型: String

リポジトリフォルダの ID。

filter

項目種別。値は次のとおりです。

Any — ファイルとフォ��ダを含めます。
FilesOnly — ファイルのみを含めます。
FoldersOnly — フォルダのみを含めます。

result

型: ConnectApi.ContentHubAllowedItemTypeCollection

テストデータを含むオブジェクト。

戻り値

型: Void

setTestGetFilePreview(repositoryId, repositoryFileId, formatType, result)

一致する getFilePreview(repositoryId, repositoryFileId, formatType) メソッドをテストコンテキストでコールするときに返される ConnectApi.FilePreview オブジェクトを登録します。メソッドでは、同じパラメータを使用します。パラメータが同じでないと、例外が発生します。

API バージョン

40.0

署名

public static Void setTestGetFilePreview(String repositoryId, String repositoryFileId, ConnectApi.FilePreviewFormat formatType, ConnectApi.FilePreview result)

パラメータ

repositoryId

型: String

リポジトリの ID。

repositoryFileId

型: String

リポジトリファイルの ID。

formatType

ファイルプレビューの形式を指定します。値は次のとおりです。

Jpg — プレビュー形式は JPG です。
Pdf — プレビュー形式は PDF です。
Svg — プレビュー形式は圧縮 SVG です。
Thumbnail — プレビュー形式は 240×180 の PNG です。
ThumbnailBig — プレビュー形式は 720×480 の PNG です。
ThumbnailTiny — プレビュー形式は 120×90 の PNG です。

PDF プレビューは、DOC、DOCX、PPT、PPTX、TEXT、XLS、および XLSX タイプのファイルで利用できます。SVG ファイルはオンデマンドで生成されます。

result

テストデータを含むオブジェクト。

戻り値

型: Void

setTestGetFilePreview(repositoryId, repositoryFileId, formatType, startPageNumber, endPageNumber, result)

一致する getFilePreview(repositoryId, repositoryFileId, formatType, startPageNumber, endPageNumber) メソッドをテストコンテキストでコールするときに返される ConnectApi.FilePreview オブジェクトを登録します。メソッドでは、同じパラメータを使用します。パラメータが同じでないと、例外が発生します。

API バージョン

40.0

署名

public static Void setTestGetFilePreview(String repositoryId, String repositoryFileId, ConnectApi.FilePreviewFormat formatType, Integer startPageNumber, Integer endPageNumber, ConnectApi.FilePreview result)

パラメータ

repositoryId

型: String

リポジトリの ID。

repositoryFileId

型: String

リポジトリファイルの ID。

formatType

ファイルプレビューの形式を指定します。値は次のとおりです。

Jpg — プレビュー形式は JPG です。
Pdf — プレビュー形式は PDF です。
Svg — プレビュー形式は圧縮 SVG です。
Thumbnail — プレビュー形式は 240×180 の PNG です。
ThumbnailBig — プレビュー形式は 720×480 の PNG です。
ThumbnailTiny — プレビュー形式は 120×90 の PNG です。

PDF プレビューは、DOC、DOCX、PPT、PPTX、TEXT、XLS、および XLSX タイプのファイルで利用できます。SVG ファイルはオンデマンドで生成されます。

startPageNumber

型: Integer

ファイルプレビュー URL 範囲の開始ページ番号。

endPageNumber

型: Integer

ファイルプレビュー URL 範囲の終了ページ番号。

result

テストデータを含むオブジェクト。

戻り値

型: Void

setTestGetFilePreview(communityId, repositoryId, repositoryFileId, formatType, result)

一致する getFilePreview(communityId, repositoryId, repositoryFileId, formatType) メソッドをテストコンテキストでコールするときに返される ConnectApi.FilePreview オブジェクトを登録します。メソッドでは、同じパラメータを使用します。パラメータが同じでないと、例外が発生します。

API バージョン

40.0

署名

public static Void setTestGetFilePreview(String communityId, String repositoryId, String repositoryFileId, ConnectApi.FilePreviewFormat formatType, ConnectApi.FilePreview result)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null を使用します。

repositoryId

型: String

リポジトリの ID。

repositoryFileId

型: String

リポジトリファイルの ID。

formatType

ファイルプレビューの形式を指定します。値は次のとおりです。

Jpg — プレビュー形式は JPG です。
Pdf — プレビュー形式は PDF です。
Svg — プレビュー形式は圧縮 SVG です。
Thumbnail — プレビュー形式は 240×180 の PNG です。
ThumbnailBig — プレビュー形式は 720×480 の PNG です。
ThumbnailTiny — プレビュー形式は 120×90 の PNG です。

PDF プレビューは、DOC、DOCX、PPT、PPTX、TEXT、XLS、および XLSX タイプのファイルで利用できます。SVG ファイルはオンデマンドで生成されます。

result

テストデータを含むオブジェクト。

戻り値

型: Void

setTestGetFilePreview(communityId, repositoryId, repositoryFileId, formatType, startPageNumber, endPageNumber, result)

一致する getFilePreview(communityId, repositoryId, repositoryFileId, formatType, startPageNumber, endPageNumber) メソッドをテストコンテキストでコールするときに返される ConnectApi.FilePreview オブジェクトを登録します。メソッドでは、同じパラメータを使用します。パラメータが同じでないと、例外が発生します。

API バージョン

40.0

署名

public static Void setTestGetFilePreview(String communityId, String repositoryId, String repositoryFileId, ConnectApi.FilePreviewFormat formatType, Integer startPageNumber, Integer endPageNumber, ConnectApi.FilePreview result)

パラメータ

communityId

型: String

Experience Cloud サイトの ID、internal、または null を使用します。

repositoryId

型: String

リポジトリの ID。

repositoryFileId

型: String

リポジトリファイルの ID。

formatType

ファイルプレビューの形式を指定します。値は次のとおりです。

Jpg — プレビュー形式は JPG です。
Pdf — プレビュー形式は PDF です。
Svg — プレビュー形式は圧縮 SVG です。
Thumbnail — プレビュー形式は 240×180 の PNG です。
ThumbnailBig — プレビュー形式は 720×480 の PNG です。
ThumbnailTiny — プレビュー形式は 120×90 の PNG です。

PDF プレビューは、DOC、DOCX、PPT、PPTX、TEXT、XLS、および XLSX タイプのファイルで利用できます。SVG ファイルはオンデマンドで生成されます。

startPageNumber

型: Integer

ファイルプレビュー URL 範囲の開始ページ番号。

endPageNumber

型: Integer

ファイルプレビュー URL 範囲の終了ページ番号。

result