ContentHub Class

Example

This example creates a file without binary content (metadata only) in a repository folder. After the file is created, we show the file’s ID, name, description, external URL, and download URL.

addRepositoryItem(communityId, repositoryId, repositoryFolderId, file)

Add a repository item in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.
repositoryFolderId: Type: String; The ID of the repository folder.
file: Type: ConnectApi.ContentHubItemInput; The item type ID and fields of the item type.

Return Value

addRepositoryItem(repositoryId, repositoryFolderId, file, fileData)

Add a repository item, including the binary file.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId: Type: String; The ID of the repository.
repositoryFolderId: Type: String; The ID of the repository folder.
file: Type: ConnectApi.ContentHubItemInput; The item type ID and fields of the item type.
fileData: Type: ConnectApi.BinaryInput; The binary file.

Return Value

Example

This example creates a file with binary content and metadata in a repository folder. After the file is created, we show the file’s ID, name, description, external URL, and download URL.

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

Add a repository item, including the binary file, in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.
repositoryFolderId: Type: String; The ID of the repository folder.
file: Type: ConnectApi.ContentHubItemInput; The item type ID and fields of the item type.
fileData: Type: ConnectApi.BinaryInput; The binary file.

Return Value

getAllowedItemTypes(repositoryId, repositoryFolderId)

Get the item types that the context user is allowed to create in the repository folder.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId: Type: String; The ID of the repository.
repositoryFolderId: Type: String; The ID of the repository folder.

Return Value

Type: ConnectApi.ContentHubAllowedItemTypeCollection

getAllowedItemTypes(repositoryId, repositoryFolderId, filter)

Get the item types, filtered by type, that the context user is allowed to create in the repository folder.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId

Type: String

The ID of the repository.

repositoryFolderId

Type: String

The ID of the repository folder.

filter

Type: ConnectApi.ContentHubItemType

Specifies the item types. Values are:

Any—Includes files and folders.
FilesOnly—Includes files only.
FoldersOnly—Includes folders only.

Return Value

Type: ConnectApi.ContentHubAllowedItemTypeCollection

Example

This example calls getAllowedItemTypes(repositoryId, repositoryFolderId, ConnectApi.ContentHubItemType.FilesOnly) to get the first ConnectApi.ContentHubItemTypeSummary.id of a file. The context user can create allowed files in a repository folder in the external system.

getAllowedItemTypes(communityId, repositoryId, repositoryFolderId)

Get the item types that the context user is allowed to create in the repository folder in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.
repositoryFolderId: Type: String; The ID of the repository folder.

Return Value

Type: ConnectApi.ContentHubAllowedItemTypeCollection

getAllowedItemTypes(communityId, repositoryId, repositoryFolderId, filter)

Get the item types, filtered by type, that the context user is allowed to create in the repository folder in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

repositoryId

Type: String

The ID of the repository.

repositoryFolderId

Type: String

The ID of the repository folder.

filter

Type: ConnectApi.ContentHubItemType

Specifies the item types. Values are:

Any—Includes files and folders.
FilesOnly—Includes files only.
FoldersOnly—Includes folders only.

Return Value

Type: ConnectApi.ContentHubAllowedItemTypeCollection

getFilePreview(repositoryId, repositoryFileId, formatType)

Get a repository file preview.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId

Type: String

The ID of the repository.

repositoryFileId

Type: String

The ID of the repository file.

formatType

Specifies the format of the file preview. Values are:

Pdf—Preview format is PDF.
Svg—Preview format is compressed SVG.
Thumbnail—Preview format is 240 x 180 PNG.
ThumbnailBig—Preview format is 720 x 480 PNG.
ThumbnailTiny—Preview format is 120 x 90 PNG.

PDF previews are available for files of type DOC, DOCX, PPT, PPTX, TEXT, XLS, and XLSX. SVG files are generated on demand.

Return Value

Example

This example calls getFilePreview(repositoryId, repositoryFileId, ConnectApi.FilePreviewFormat.Thumbnail) to get the thumbnail format preview along with its respective URL and number of thumbnail renditions. For each thumbnail format, we show every rendition URL available.

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

Get a page or page range of a repository file preview.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId

Type: String

The ID of the repository.

repositoryFileId

Type: String

The ID of the repository file.

formatType

Specifies the format of the file preview. Values are:

Pdf—Preview format is PDF.
Svg—Preview format is compressed SVG.
Thumbnail—Preview format is 240 x 180 PNG.
ThumbnailBig—Preview format is 720 x 480 PNG.
ThumbnailTiny—Preview format is 120 x 90 PNG.

PDF previews are available for files of type DOC, DOCX, PPT, PPTX, TEXT, XLS, and XLSX. SVG files are generated on demand.

startPageNumber

Type: Integer

The starting page number in the range of file preview URLs.

endPageNumber

Type: Integer

The ending page number in the range of file preview URLs.

Return Value

getFilePreview(communityId, repositoryId, repositoryFileId, formatType)

Get a repository file preview in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

repositoryId

Type: String

The ID of the repository.

repositoryFileId

Type: String

The ID of the repository file.

formatType

Specifies the format of the file preview. Values are:

Pdf—Preview format is PDF.
Svg—Preview format is compressed SVG.
Thumbnail—Preview format is 240 x 180 PNG.
ThumbnailBig—Preview format is 720 x 480 PNG.
ThumbnailTiny—Preview format is 120 x 90 PNG.

PDF previews are available for files of type DOC, DOCX, PPT, PPTX, TEXT, XLS, and XLSX. SVG files are generated on demand.

Return Value

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

Get a page or page range of a repository file preview in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

repositoryId

Type: String

The ID of the repository.

repositoryFileId

Type: String

The ID of the repository file.

formatType

Specifies the format of the file preview. Values are:

Pdf—Preview format is PDF.
Svg—Preview format is compressed SVG.
Thumbnail—Preview format is 240 x 180 PNG.
ThumbnailBig—Preview format is 720 x 480 PNG.
ThumbnailTiny—Preview format is 120 x 90 PNG.

PDF previews are available for files of type DOC, DOCX, PPT, PPTX, TEXT, XLS, and XLSX. SVG files are generated on demand.

startPageNumber

Type: Integer

The starting page number in the range of file preview URLs.

endPageNumber

Type: Integer

The ending page number in the range of file preview URLs.

Return Value

getItemType(repositoryId, repositoryItemTypeId)

Get information about an item type associated with a repository.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId: Type: String; The ID of the repository.
repositoryItemTypeId: Type: String; The ID of the repository item type.

Return Value

Type: ConnectApi.ContentHubItemTypeDetail

getItemType(communityId, repositoryId, repositoryItemTypeId)

Get information about an item type associated with a repository in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.
repositoryItemTypeId: Type: String; The ID of the repository item type.

Return Value

Type: ConnectApi.ContentHubItemTypeDetail

getPreviews(repositoryId, repositoryFileId)

Get information about a repository file’s supported previews.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId: Type: String; The ID of the repository.
repositoryFileId: Type: String; The ID of the repository file.

Return Value

Type: ConnectApi.FilePreviewCollection

Example

This example gets all supported preview formats and their respective URLs and number of renditions. For each supported preview format, we show every rendition URL available.

getPreviews(communityId, repositoryId, repositoryFileId)

Get information about a repository file’s supported previews in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.
repositoryFileId: Type: String; The ID of the repository file.

Return Value

Type: ConnectApi.FilePreviewCollection

getRepositories()

Get a list of repositories.

API Version

39.0

Requires Chatter

No

Signature

public static ConnectApi.ContentHubRepositoryCollection getRepositories()

Return Value

Example

This example gets all repositories and gets the first SharePoint online repository found.

getRepositories(communityId)

Get a list of repositories in a community.

API Version

39.0

Requires Chatter

No

Signature

public static ConnectApi.ContentHubRepositoryCollection getRepositories(String communityId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.

Return Value

getRepositories(pageParam, pageSize)

Get a page of repositories.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default page size is 25.

Return Value

getRepositories(communityId, pageParam, pageSize)

Get a page of repositories in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default page size is 25.

Return Value

getRepository(repositoryId)

Get a repository.

API Version

369.0

Requires Chatter

No

Signature

public static ConnectApi.ContentHubRepository getRepository(String repositoryId)

Parameters

repositoryId: Type: String; The ID of the repository.

Return Value

Type: ConnectApi.ContentHubRepository

Example

getRepository(communityId, repositoryId)

Get a repository in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.

Return Value

Type: ConnectApi.ContentHubRepository

getRepositoryFile(repositoryId, repositoryFileId)

Get a repository file.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId: Type: String; The ID of the repository.
repositoryFileId: Type: String; The ID of the repository file.

Return Value

Example

getRepositoryFile(repositoryId, repositoryFileId, includeExternalFilePermissionsInfo)

Get a repository file with or without permissions information.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId: Type: String; The ID of the repository.
repositoryFileId: Type: String; The ID of the repository file.
includeExternalFilePermissionsInfo: Type: Boolean; Specifies whether to include permission information, such as whether the file is shared and what are the available permission types.
Managing external file permissions is supported for Google Drive, SharePoint Online, and OneDrive for Business.

Return Value

Example

getRepositoryFile(communityId, repositoryId, repositoryFileId)

Get a repository file in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.
repositoryFileId: Type: String; The ID of the repository file.

Return Value

getRepositoryFile(communityId, repositoryId, repositoryFileId, includeExternalFilePermissionsInfo)

Get a repository file with or without permissions information in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.
repositoryFileId: Type: String; The ID of the repository file.
includeExternalFilePermissionsInfo: Type: Boolean; Specifies whether to include permission information, such as whether the file is shared and what are the available permission types.
Managing external file permissions is supported for Google Drive, SharePoint Online, and OneDrive for Business.

Return Value

getRepositoryFolder(repositoryId, repositoryFolderId)

Get a repository folder.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId: Type: String; The ID of the repository.
repositoryFolderId: Type: String; The ID of the repository folder.

Return Value

Type: ConnectApi.RepositoryFolderDetail

Example

getRepositoryFolder(communityId, repositoryId, repositoryFolderId)

Get a repository folder in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.
repositoryFolderId: Type: String; The ID of the repository folder.

Return Value

Type: ConnectApi.RepositoryFolderDetail

getRepositoryFolderItems(repositoryId, repositoryFolderId)

Get repository folder items.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId: Type: String; The ID of the repository.
repositoryFolderId: Type: String; The ID of the repository folder.

Return Value

Example

This example gets the collection of items in a repository folder. For files, we show the file’s name, size, external URL, and download URL. For folders, we show the folder’s name, description, and external URL.

getRepositoryFolderItems(communityId, repositoryId, repositoryFolderId)

Get repository folder items in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.
repositoryFolderId: Type: String; The ID of the repository folder.

Return Value

getRepositoryFolderItems(repositoryId, repositoryFolderId, pageParam, pageSize)

Get a page of repository folder items.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId: Type: String; The ID of the repository.
repositoryFolderId: Type: String; The ID of the repository folder.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default page size is 25.

Return Value

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

Get a page of repository folder items in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.
repositoryFolderId: Type: String; The ID of the repository folder.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default page size is 25.

Return Value

updateRepositoryFile(repositoryId, repositoryFileId, file)

Update the metadata of a repository file.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId: Type: String; The ID of the repository.
repositoryFileId: Type: String; The ID of the repository file.
file: Type: ConnectApi.ContentHubItemInput; The item type ID and fields of the item type.

Return Value

Example

This example updates the metadata of a file in a repository. After the file is updated, we show the file’s ID, name, description, external URL, download URL.

updateRepositoryFile(repositoryId, repositoryFileId, file, fileData)

Update the content of a repository file.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

repositoryId: Type: String; The ID of the repository.
repositoryFileId: Type: String; The ID of the repository file.
file: Type: ConnectApi.ContentHubItemInput; The item type ID and fields of the item type.
fileData: Type: ConnectApi.BinaryInput; The binary file.

Return Value

Example

This example updates the content and metadata of a file in a repository. After the file is updated, we show the file’s ID, name, description, external URL, and download URL.

updateRepositoryFile(communityId, repositoryId, repositoryFileId, file)

Update the metadata of a repository file in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.
repositoryFileId: Type: String; The ID of the repository file.
file: Type: ConnectApi.ContentHubItemInput; The item type ID and fields of the item type.

Return Value

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

Update the content of a repository file in a community.

API Version

39.0

Requires Chatter

No

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
repositoryId: Type: String; The ID of the repository.
repositoryFileId: Type: String; The ID of the repository file.
file: Type: ConnectApi.ContentHubItemInput; The item type ID and fields of the item type.
fileData: Type: ConnectApi.BinaryInput; The binary file.

Return Value