Package | Description |
---|---|
com.canto.cumulus |
The base package of the Cumulus Java Classes.
|
com.canto.cumulus.db.mail | |
com.canto.cumulus.fieldvalue |
Wrapper clsses for field values of the Cumulus Java Classes.
|
com.canto.cumulus.mediadeliverycloud | |
com.canto.cumulus.modules |
The package for accessing the plug-in modules of Cumulus.
|
com.canto.cumulus.utils |
The Cumulus utilities package.
|
Modifier and Type | Method and Description |
---|---|
Asset |
Item.checkout(Asset checkoutLocation)
Check out the asset referenced by this item (Specific Permissions Required).
|
Asset |
Asset.convert(Asset destinationContainer,
java.lang.String parameters,
GUID guid)
Converts the asset content and creates a new asset in a container asset.
|
Asset |
Item.convertAsset(Asset destinationContainer,
GUID converterModuleUID,
java.lang.String converterParams)
Convert the asset of this item using a given asset processor module and parameter string.
|
Asset |
Asset.createSubAsset(Asset srcAsset)
Creates a sub-asset (for example a file in a folder) from the given asset.
|
Asset |
Asset.createSubAsset(java.lang.String sName,
java.lang.String sFileNameExtension,
java.lang.String sMacFileType,
java.lang.String sMacFileCreator,
java.util.Date creationDate,
java.util.Date modificationDate,
java.io.InputStream dataFork,
java.io.InputStream rsrcFork)
Create an asset (e.g.
|
Asset |
Asset.createSubContainerAsset(java.lang.String name,
java.util.Date creationDate,
java.util.Date modificationDate)
Create a container asset (e.g.
|
Asset |
Asset.getContainer()
Returns the asset's container asset.
|
Asset |
Asset.getHostAsset()
Returns the host asset for this contained asset.
|
Asset |
Asset.getSubAsset(java.lang.String name)
Returns a sub-asset by name.
|
Asset |
Asset.redirect(java.lang.String parameters,
GUID guid)
Redirects the asset content to another existing asset.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<Asset> |
Item.copyAsset(Asset destinationContainer)
Copy the asset of this item to a different location.
|
java.util.Iterator<Asset> |
AssetCollection.iterator() |
java.util.List<Asset> |
Item.moveAsset(Asset destinationContainer)
Move the asset of this item to a different location.
|
Modifier and Type | Method and Description |
---|---|
void |
ItemCollection.catalogAsset(Asset asset,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
java.util.EnumSet<CatalogingFlag> catalogingFlags,
CatalogingListener<ItemCollection> catalogingListener)
Catalog a single asset to this collection.
|
void |
ItemCollection.catalogAsset(Asset asset,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
java.util.EnumSet<CatalogingFlag> catalogingFlags,
Item additionalFieldValuesItem,
java.util.Map<GUID,MetadataTemplateEntry.ValueFillMode> additionalFieldValuesFillMode,
CatalogingListener<ItemCollection> catalogingListener)
Catalog a single asset to this collection.
|
void |
ItemCollection.catalogAsset(Asset asset,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
java.util.EnumSet<CatalogingFlag> catalogingFlags,
java.util.Set<java.lang.Integer> assignCategoryIDs,
CatalogingListener<ItemCollection> catalogingListener)
Catalog a single asset to this collection.
|
java.util.Set<java.lang.Integer> |
Item.checkin(java.lang.String assetHandlingSet,
Asset assetLocal,
java.lang.String comment,
boolean keepCheckedOut,
boolean keepLocalAsset,
boolean removeDeletedSubAssetItems)
Check in a new version of the asset of this item from the given local asset.
|
Asset |
Item.checkout(Asset checkoutLocation)
Check out the asset referenced by this item (Specific Permissions Required).
|
Asset |
Asset.convert(Asset destinationContainer,
java.lang.String parameters,
GUID guid)
Converts the asset content and creates a new asset in a container asset.
|
Asset |
Item.convertAsset(Asset destinationContainer,
GUID converterModuleUID,
java.lang.String converterParams)
Convert the asset of this item using a given asset processor module and parameter string.
|
java.util.List<Asset> |
Item.copyAsset(Asset destinationContainer)
Copy the asset of this item to a different location.
|
void |
Asset.copyFrom(Asset srcAsset)
Overwrites this asset with the given asset.
|
static AssetCollection |
AssetCollection.create(Asset... assets)
Create a new collection from the given assets.
|
static Pixmap |
Pixmap.createFromAsset(Asset asset,
java.lang.String assetHandlingSet)
Creates a pixel preview for the given asset.
|
static Pixmap |
Pixmap.createFromAsset(Asset asset,
java.lang.String assetHandlingSet,
int maxSize,
int rotation)
Creates a pixel preview for the given asset.
|
static Pixmap |
Pixmap.createFromAsset(Asset asset,
java.lang.String assetHandlingSet,
int maxSizeWidth,
int maxSizeHeight,
int rotation)
Creates a pixel preview for the given asset.
|
Asset |
Asset.createSubAsset(Asset srcAsset)
Creates a sub-asset (for example a file in a folder) from the given asset.
|
AssetCollection |
Item.doAssetAction(Asset destinationAssetContainer,
java.lang.String assetAction)
Perform an asset action on the asset of this item.
|
AssetCollection |
Item.doAssetAction(Asset destinationAssetContainer,
java.lang.String assetAction,
boolean returnCreatedAssets)
Perform an asset action on the asset of this item.
|
AssetCollection |
Item.doAssetAction(Asset destinationAssetContainer,
java.lang.String assetAction,
boolean returnCreatedAssets,
java.util.Map<GUID,JPack> customParameters)
Perform an asset action on the asset of this item.
|
AssetCollection |
MultiItemCollection.doAssetAction(java.lang.String assetAction,
Asset destinationAssetContainer)
Perform an asset action on the assets of the items of this collection.
|
AssetCollection |
MultiItemCollection.doAssetAction(java.lang.String assetAction,
Asset destinationAssetContainer,
boolean returnCreatedAssets)
Perform an asset action on the assets of the items of this collection.
|
AssetCollection |
MultiItemCollection.doAssetAction(java.lang.String assetAction,
Asset destinationAssetContainer,
boolean returnCreatedAssets,
java.util.Map<ItemIdentifier,java.util.Map<GUID,JPack>> customParameters)
Perform an asset action on the assets of the items of this collection.
|
void |
ItemCollection.find(Asset asset)
Find all items referencing the given asset.
|
void |
ItemCollection.find(Asset asset,
boolean logSearchStatistic)
Find all items referencing the given asset.
|
static Pixmap.AssetInfo |
Pixmap.getAssetInfo(Asset asset)
Reads the image size and bitdepth if the given asset uses a supported format.
|
boolean |
Asset.isSameAsset(Asset anotherAsset)
Return whether this asset is the same as another asset object.
|
java.util.List<Asset> |
Item.moveAsset(Asset destinationContainer)
Move the asset of this item to a different location.
|
static Pixmap.JPEGInfo |
Pixmap.readJPEGInfoFromAsset(Asset asset)
Reads the image size and bitdepth if the given asset references an accessible JPEG asset.
|
Modifier and Type | Method and Description |
---|---|
static AssetCollection |
AssetCollection.create(java.util.List<Asset> assets)
Create a new collection from the given list of assets.
|
Modifier and Type | Method and Description |
---|---|
void |
MailManager.sendMessage(int languageID,
GUID mailClassID,
java.lang.String templateName,
MailManager.PlaceholderProvider placeholderProvider,
java.lang.String from,
java.lang.String recipients,
java.lang.String ccRecipients,
java.lang.String bccRecipients,
java.util.Collection<Asset> assetsToAttach)
Sends a message dynamically constructed from an email template.
|
void |
MailManager.sendMessage(java.lang.String from,
java.lang.String recipients,
java.lang.String ccRecipients,
java.lang.String bccRecipients,
java.lang.String subject,
java.lang.String bodyText,
java.util.Collection<Asset> assetsToAttach)
Sends a message.
|
void |
MailManager.sendTestMessage(int languageID,
GUID mailClassID,
java.lang.String templateName,
MailManager.PlaceholderProvider placeholderProvider,
java.lang.String from,
java.lang.String recipients,
java.lang.String ccRecipients,
java.lang.String bccRecipients,
java.util.Collection<Asset> assetsToAttach)
Sends a test message dynamically constructed from an email template.
|
Modifier and Type | Method and Description |
---|---|
Asset |
AssetReference.getAsset(boolean allowProxyAsset)
Resolves the asset reference data and returns the asset object, using the default asset handling set.
|
Modifier and Type | Method and Description |
---|---|
void |
MediaDeliveryCloudManager.addMasterImageSize(Asset convertedAsset,
JSONObject targetObject,
java.lang.String propertyName) |
void |
MediaDeliveryCloudManager.uploadWatermarkImage(Asset asset,
java.lang.String watermarkName)
Upload a watermark image to media delivery cloud.
|
void |
MediaDeliveryCloudManager.uploadWatermarkImage(Asset asset,
java.lang.String watermarkName,
java.lang.String imageID)
Upload a watermark image to media delivery cloud.
|
Modifier and Type | Method and Description |
---|---|
Asset |
AssetStorageModule.browseForAsset(CumulusSession cumulusSession,
boolean allowContainer,
boolean allowAsset,
java.lang.String title)
Bring up a dialog to allow the user to select a single asset.
|
Asset |
AssetStorageModule.browseForAsset(CumulusSession cumulusSession,
boolean allowContainer,
boolean allowAsset,
java.lang.String title,
java.lang.String defaultNameForContainer)
Bring up a dialog to allow the user to select a single asset.
|
Asset |
AssetMetadataModule.getMetadataAsset(Asset asset)
Returns the corresponding metadata asset (if exists) for this module.
|
Asset |
AssetStorageModule.resolveAssetReferenceData(CumulusSession cumulusSession,
byte[] data,
boolean showUI,
Asset container)
Returns the asset found for the given asset reference data.
|
Modifier and Type | Method and Description |
---|---|
byte[] |
AssetStorageModule.createAssetReferenceData(CumulusSession cumulusSession,
Asset asset)
Create AssetReference part data for the given asset if possible.
|
Asset |
AssetMetadataModule.getMetadataAsset(Asset asset)
Returns the corresponding metadata asset (if exists) for this module.
|
boolean |
AssetMetadataModule.isMetadataAsset(Asset asset)
Indicates whether the asset is an external metadata asset for this module.
|
Asset |
AssetStorageModule.resolveAssetReferenceData(CumulusSession cumulusSession,
byte[] data,
boolean showUI,
Asset container)
Returns the asset found for the given asset reference data.
|
Modifier and Type | Method and Description |
---|---|
static ImagingPixmap |
ImagingPixmap.getPixmap(Item item,
Asset asset,
java.lang.String assetHandlingSet,
int page)
Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the given
asset.
|
www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.