Interface Library
-
- All Known Implementing Classes:
DocumentLibrary,IconLibrary,LogoLibrary,MediaLibrary
public interface Library`LibraryInterface` for `Library` returnable types.
-
-
Method Summary
Modifier and Type Method Description IntScalargetAssetCount()Deprecated.AssetItemsgetAssets()Search or list `Assets` in this `Library`.LibraryRootFoldergetBrowse()Browse the `Library`'s `SubFolderItems` and `AssetItems`.LibraryCollaboratorsgetCollaborators()`Library` collaborators.CollectionItemsgetCollections()List `Collection` type items within a `Library`.RgbaColorgetColor()`Library` color.LibraryUserPermissionsgetCurrentUserPermissions()Check current `User` permissions in a specific `Library`.List<CustomMetadataProperty>getCustomMetadataProperties()List of `CustomMetadataProperty` items belonging to a `Library`.IdScalargetId()`Library` Id.List<License>getLicenses()Retrieve list of all `Licenses` belonging to this `Library`.List<MetadataField>getMetadataFields()Deprecated.StringScalargetName()`Library` name.WorkflowgetWorkflow()**BETA** The `Workflow` belonging to the given `Library`.
-
-
-
Method Detail
-
getId
IdScalar getId()
`Library` Id.
-
getName
StringScalar getName()
`Library` name.
-
getColor
RgbaColor getColor()
`Library` color.
-
getAssetCount
@Deprecated IntScalar getAssetCount()
Deprecated.**DEPRECATED** Amount of `Assets` contained in this `Library`. This field will be removed. Use `assets`.`total` instead. | Date: 2024-01-01T00:00:00.000+00:00 This field will be removed. Use `assets`.`total` instead. | Date: 2024-01-01T00:00:00.000+00:00
-
getMetadataFields
@Deprecated List<MetadataField> getMetadataFields()
Deprecated.**DEPRECATED** Retrieve list of all `MetadataFields` belonging to this `Library`. This field will be removed. Use `customMetadataProperties` instead. | Date: 2025-01-01T00:00:00.000+00:00 This field will be removed. Use `customMetadataProperties` instead. | Date: 2025-01-01T00:00:00.000+00:00
-
getAssets
AssetItems getAssets()
Search or list `Assets` in this `Library`.
-
getLicenses
List<License> getLicenses()
Retrieve list of all `Licenses` belonging to this `Library`.
-
getCollections
CollectionItems getCollections()
List `Collection` type items within a `Library`.
-
getBrowse
LibraryRootFolder getBrowse()
Browse the `Library`'s `SubFolderItems` and `AssetItems`.
-
getCollaborators
LibraryCollaborators getCollaborators()
`Library` collaborators.
-
getCurrentUserPermissions
LibraryUserPermissions getCurrentUserPermissions()
Check current `User` permissions in a specific `Library`.
-
getWorkflow
Workflow getWorkflow()
**BETA** The `Workflow` belonging to the given `Library`.
-
getCustomMetadataProperties
List<CustomMetadataProperty> getCustomMetadataProperties()
List of `CustomMetadataProperty` items belonging to a `Library`.
-
-