com.brightech.mb.workflow.js

Class JSFileManager

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.JSFileManager

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class JSFileManager
extends JSBaseScriptableObject

Provides access to a file manager to javascript objects. Is available in workflow context pre-initialized as "fileManager"

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List	kBundleTypes Trigger Event types.

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
JSFileManager()

Method Summary

Modifier and Type	Method and Description
IFileObject	(JavaScript Function) compressFiles(org.mozilla.javascript.NativeArray theFiles, java.lang.String theDestinationFile, int theCompressionType) Compresses a list of files into a specified format of archive file.
Bundle	(JavaScript Function) createBundleFolder(java.lang.String theBundlePath, BundleType theBundleFlag) Creates a folder bundle.
org.mozilla.javascript.Scriptable	(JavaScript Function) decompressFiles(ManagedFile theFile, ManagedFolder theOutputDir) Decompress a file.
IFileObject	(JavaScript Function) fileCopy(IFileObject theSrc, IFolderObject theDest) Copy a File.
void	(JavaScript Function) fileDelete(IFileObject theFile) Delete a file.
ManagedFile	(JavaScript Function) fileDuplicate(ManagedFile theFile) Duplicate a file.
ManagedFile	(JavaScript Function) fileImport(IFileObject theFile, ImportParameters theParameters) Imports or re-imports a file.
IFileObject	(JavaScript Function) fileMove(IFileObject theSrc, IFolderObject theDest, java.lang.Boolean theOverwrite) Move a file.
IFileObject	(JavaScript Function) fileNew(IFolderObject theDestinationFolder, java.lang.String theNewName) Create a new file.
IFileObject	(JavaScript Function) fileNewByPath(java.lang.String theFilePath) Creates the new file by path.
IFileObject	(JavaScript Function) fileRename(IFileObject theFile, java.lang.String theNewName) Rename a file.
ManagedFile	(JavaScript Function) fileReplace(ManagedFile theSrc, ManagedFile theDest) Replace an asset with another asset, maintaining the replaced asset's metadata.
IFolderObject	(JavaScript Function) folderCopy(IFolderObject theSrc, IFolderObject theDest, java.lang.String theDestName) Copy a folder.
void	(JavaScript Function) folderDelete(IFolderObject theFolder) Delete a folder.
ManagedFolder	(JavaScript Function) folderImport(IFolderObject theFolder, java.lang.Boolean theDoNotDescend) Imports or re-imports a folder.
ManagedFolder	(JavaScript Function) folderImportWithParameters(IFolderObject theFolder, ImportParameters theParameters) Imports or re-imports a folder.
IFolderObject	(JavaScript Function) folderMove(IFolderObject theSrc, IFolderObject theDest, java.lang.String theFolderName) Move a folder.
IFolderObject	(JavaScript Function) folderNew(IFolderObject theDestinationFolder, java.lang.String theNewFolder) Create a folder.
IFolderObject	(JavaScript Function) folderNewByPath(java.lang.String theFolderPath) Creates the new folder by path.
IFolderObject	(JavaScript Function) folderRename(IFolderObject theFolder, java.lang.String theNewName) Rename a folder.
IFileObject	(JavaScript Function) getFile(IFolderObject theParentFolder, java.lang.String theFileName) Gets a reference the given file in the given path, if the file doesn't exist or isn't a regular file, return null.
ManagedFile	(JavaScript Function) getFileObjectById(int theNewAssetId) Creates a new IFileObject object for the given asset ID.
java.util.List	(JavaScript Function) getFilePaths(IFolderObject theDir, boolean theReturnAllFiles) Deprecated. use ManagedFolder.(JavaScript Function) getContents or UnmanagedFolder.(JavaScript Function) getContents instead. This function will fail for folders outside of the MediaBeacon asset root.
ManagedFolder	(JavaScript Function) getFolderObjectById(int theFolderId) Creates a new ManagedFolder object for the given folder ID.
ManagedFile	(JavaScript Function) getManaged(UnmanagedFile theFile) Get managed file reference to the given unmanaged file if it is managed by MediaBeacon.
PDF	(JavaScript Function) getPdfFromManagedFile(ManagedFile theFile) Get a PDF object from a ManagedFile object
java.lang.String	(JavaScript Function) getRelativePath(IFileObject theFile) Deprecated. use ManagedFile.(JavaScript Getter) path or UnmanagedFile.(JavaScript Function) getRelativePath instead.
boolean	(JavaScript Function) isFile(java.lang.String theRelativePath) Check if there is a file located at a given relative path.
boolean	(JavaScript Function) isFolder(java.lang.String theRelativePath) Check if there is a folder located at a given relative path.
boolean	(JavaScript Function) isManaged(org.mozilla.javascript.Scriptable theFile) Check if the file or folder is managed by MediaBeacon.
boolean	(JavaScript Function) isManagedFilePath(java.lang.String theRelativePath) Is the given path, relative to the MediaBeacon asset root, a path to a file currently managed by MediaBeacon.
boolean	(JavaScript Function) isManagedFolderPath(java.lang.String theRelativePath) Is the given path, relative to the MediaBeacon asset root, a path to a folder currently managed by MediaBeacon.
boolean	(JavaScript Function) postFileCopy(java.lang.String theOldPath, java.lang.String theNewPath) This method is available only in M4sterPlan-licensed MediaBeacon.
boolean	(JavaScript Function) postFileRename(java.lang.String theOldPath, java.lang.String theNewPath) This method is available only in M4sterPlan-licensed MediaBeacon.
IFileObject	(JavaScript Function) rawFileCopy(IFileObject theSrc, IFolderObject theDest, int theFork) Copy a File without calling import on the destination file, optionally only data or only resource fork.
void	(JavaScript Function) removeBundleMetadata(java.lang.String theBundlePath) Remove everything associated with a bundle, including the metadata asset.
ManagedFile	(JavaScript Function) replaceAsset(IFileObject theSrc, ManagedFile theDest, boolean theIsRename) Replaces asset data with uploaded file that resides on the portal server.
void	(JavaScript Function) setPendingUploadFilesAvailable(IFolderObject theFolder, java.lang.String thePendingUploadId, java.lang.String theProgressId, java.lang.String theTargetDir) Notify MB that pending uploads are available
JSMap	(JavaScript Getter) bundleTypes()

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Field Detail

kBundleTypes

public static java.util.List kBundleTypes

Trigger Event types.

Constructor Detail

JSFileManager

public JSFileManager()

Method Detail

(JavaScript Function) isFile

public boolean (JavaScript Function) isFile(java.lang.String theRelativePath)
                          throws java.lang.Exception

Check if there is a file located at a given relative path.

Parameters:

theRelativePath - the path, relative to the MediaBeacon asset root, to a file. This path should contain unix-style file separators regardless of what file system hosts the assets.

Returns:

does a file exist at the given path (this file may or may not have been imported).

Throws:

java.lang.Exception

(JavaScript Function) isFolder

public boolean (JavaScript Function) isFolder(java.lang.String theRelativePath)
                            throws java.lang.Exception

Check if there is a folder located at a given relative path.

Parameters:

theRelativePath - the path, relative to the MediaBeacon asset root, to a folder. This path should contain unix-style file separators regardless of what file system hosts the assets.

Returns:

does a folder exist at the given path (this folder may or may not have been imported).

Throws:

java.lang.Exception

(JavaScript Function) isManagedFilePath

public boolean (JavaScript Function) isManagedFilePath(java.lang.String theRelativePath)

Is the given path, relative to the MediaBeacon asset root, a path to a file currently managed by MediaBeacon. A file is managed if it exists and has been imported successfully by MediaBeacon. Important note: some files that are within the MediaBeacon asset root are excluded from import.

Parameters:

theRelativePath - The relative path to a file potentially managed by MediaBeacon.

Returns:

Is the file at the path managed by MediaBeacon?

(JavaScript Function) isManagedFolderPath

public boolean (JavaScript Function) isManagedFolderPath(java.lang.String theRelativePath)

Is the given path, relative to the MediaBeacon asset root, a path to a folder currently managed by MediaBeacon. A folder is managed if it exists and has been imported successfully by MediaBeacon. Important note: some files that are within the MediaBeacon asset root are excluded from import.

Parameters:

theRelativePath - The relative path to a folder potentially managed by MediaBeacon.

Returns:

Is the file at the path managed by MediaBeacon?

(JavaScript Function) isManaged

public boolean (JavaScript Function) isManaged(org.mozilla.javascript.Scriptable theFile)

Check if the file or folder is managed by MediaBeacon. A file or folder is managed if it exists and has been imported successfully by MediaBeacon. Important note: some files and folders that are within the MediaBeacon asset root are excluded from import.

Parameters:

theFile - the file or folder to check.

Returns:

true if the given file or folder is managed by MediaBeacon, false otherwise.

(JavaScript Function) getFile

public IFileObject (JavaScript Function) getFile(IFolderObject theParentFolder,
                                      java.lang.String theFileName)
                               throws java.lang.Exception

Gets a reference the given file in the given path, if the file doesn't exist or isn't a regular file, return null.

Parameters:

theParentFolder - The folder that contains the file to get a reference to.

theFileName - The name of the potentially of extant file.

Returns:

A managed or unamanged file reference if the file exists, otherwise null.

Throws:

java.lang.Exception - exception thrown during check.

(JavaScript Function) getManaged

public ManagedFile (JavaScript Function) getManaged(UnmanagedFile theFile)

Get managed file reference to the given unmanaged file if it is managed by MediaBeacon. A file is managed if it exists and has been imported successfully by MediaBeacon.

Parameters:

theFile - the unmanaged file to potentially get a managed reference to.

Returns:

A managed file reference if argumenet references a file managed by MediaBeacon, otherwise null.

(JavaScript Function) fileNew

public IFileObject (JavaScript Function) fileNew(IFolderObject theDestinationFolder,
                                      java.lang.String theNewName)
                               throws java.lang.Exception

Create a new file. If the file already exists and is outside the Mediabeacon asset root folder or is excluded from import, this function takes no action, it just returns an unmanaged reference to the file. If the file already exists and has already been imported, this function takes no action, it just returns a managed reference to the file. If the file already exists and but hasn't already been imported, this function imports and then returns a managed reference to the file.

Parameters:

theDestinationFolder - the folder to put the new file in.

theNewName - the name of the new file.

Returns:

A managed or unmanaged reference to the file.

Throws:

java.lang.Exception - exception thrown if a problem occurs while creating the file.

(JavaScript Function) fileNewByPath

public IFileObject (JavaScript Function) fileNewByPath(java.lang.String theFilePath)
                                     throws java.lang.Exception

Creates the new file by path. The method automatically creates the parent folder if doesn't already exist. If the file already exists and is outside the Mediabeacon asset root folder or is excluded from import, this function takes no action, it just returns an unmanaged reference to the file. If the file already exists and has already been imported, this function takes no action, it just returns a managed reference to the file. If the file already exists and but hasn't already been imported, this function imports and then returns a managed reference to the file.

Parameters:

theFilePath - the path to the file to be created. This path can be absolute or relative to the MediaBeacon asset root folder. Absolute paths should use a file separator that is matches the file system while relative paths should always uses a unix-style file separator.

Returns:

A reference to the newly created file.

Throws:

java.lang.Exception

(JavaScript Function) folderNewByPath

public IFolderObject (JavaScript Function) folderNewByPath(java.lang.String theFolderPath)
                                         throws java.lang.Exception

Creates the new folder by path. The method automatically creates the parent folder path if doesn't already exist.

Parameters:

theFolderPath - the path to the folder to be created. This path can be absolute or relative to the MediaBeacon asset root folder. Absolute paths should use a file separator that is matches the file system while relative paths should always uses a unix-style file separator.

Returns:

A reference to the newly created folder.

Throws:

java.lang.Exception

(JavaScript Function) getFileObjectById

public ManagedFile (JavaScript Function) getFileObjectById(int theNewAssetId)

Creates a new IFileObject object for the given asset ID.

Parameters:

theNewAssetId - the asset id.

Returns:

a new IFileObject instance.

(JavaScript Function) postFileRename

public boolean (JavaScript Function) postFileRename(java.lang.String theOldPath,
                                         java.lang.String theNewPath)
                                  throws FileSystemException

This method is available only in M4sterPlan-licensed MediaBeacon. It allows a file moved on disk to be moved in MediaBeacon without metadata loss.

Parameters:

theOldPath - the file's previous path.

theNewPath - the file's current path.

Returns:

true if successful

Throws:

FileSystemException

(JavaScript Function) postFileCopy

public boolean (JavaScript Function) postFileCopy(java.lang.String theOldPath,
                                       java.lang.String theNewPath)
                                throws FileSystemException

This method is available only in M4sterPlan-licensed MediaBeacon. It allows a file copied on disk to be copied in MediaBeacon without metadata loss.

Parameters:

theOldPath - the file's previous path.

theNewPath - the file's current path.

Returns:

true if successful

Throws:

FileSystemException

(JavaScript Function) fileRename

public IFileObject (JavaScript Function) fileRename(IFileObject theFile,
                                         java.lang.String theNewName)
                                  throws FileSystemException

Rename a file.

Parameters:

theFile - the file to rename.

theNewName - the new name of the file.

Returns:

the renamed file.

Throws:

FileSystemException - exception thrown during file renaming.

(JavaScript Function) rawFileCopy

public IFileObject (JavaScript Function) rawFileCopy(IFileObject theSrc,
                                          IFolderObject theDest,
                                          int theFork)
                                   throws FileSystemException

Copy a File without calling import on the destination file, optionally only data or only resource fork. This is NOT the recommended way to copy, it is available for advanced users only.

Parameters:

theSrc - the file to copy.

theDest - the destination of the copy.

theFork - copy resource only (1), data and resource (2), or data only (3)

Returns:

the newly created copy of the given file.

Throws:

FileSystemException - exception thrown during copy.

(JavaScript Function) fileCopy

public IFileObject (JavaScript Function) fileCopy(IFileObject theSrc,
                                       IFolderObject theDest)
                                throws FileSystemException

Copy a File.

Parameters:

theSrc - the file to copy.

theDest - the destination of the copy.

Returns:

the newly created copy of the given file.

Throws:

FileSystemException - exception thrown during copy.

(JavaScript Function) fileDelete

public void (JavaScript Function) fileDelete(IFileObject theFile)
                           throws FileSystemException

Delete a file.

Parameters:

theFile - the file to delete.

Throws:

FileSystemException - exception thrown during delete.

(JavaScript Function) fileDuplicate

public ManagedFile (JavaScript Function) fileDuplicate(ManagedFile theFile)
                                     throws FileSystemException

Duplicate a file.

Parameters:

theFile - the file to duplicate.

Returns:

a reference to the new duplicate file.

Throws:

FileSystemException - exception thrown during duplicate.

(JavaScript Function) compressFiles

public IFileObject (JavaScript Function) compressFiles(org.mozilla.javascript.NativeArray theFiles,
                                            java.lang.String theDestinationFile,
                                            int theCompressionType)
                                     throws FileSystemException

Compresses a list of files into a specified format of archive file.

Parameters:

theFiles - list of files to include in archive

theDestinationFile - the name of the new archive

theCompressionType - the type of compression, kWinZip (1), kMacZip (2), kStuffitZip (3)

Returns:

the newly created archive file

Throws:

FileSystemException - if the operation cannot be completed

(JavaScript Function) decompressFiles

public org.mozilla.javascript.Scriptable (JavaScript Function) decompressFiles(ManagedFile theFile,
                                                                    ManagedFolder theOutputDir)
                                                             throws FileSystemException

Decompress a file.

Parameters:

theFile - the archive to decompress.

theOutputDir - the directory to decompress to.

Returns:

The newly created wrapper folder if the archive contained more than one root file or folder, otherwise the single unpackaged file or root folder.

Throws:

FileSystemException - exception thrown during decompress.

(JavaScript Function) fileMove

public IFileObject (JavaScript Function) fileMove(IFileObject theSrc,
                                       IFolderObject theDest,
                                       java.lang.Boolean theOverwrite)
                                throws FileSystemException

Move a file.

Parameters:

theSrc - the file to move.

theDest - the destination of the file.

theOverwrite - overwrite (un-imported) destination if true. (optional)

Returns:

a reference to the file in it's new location.

Throws:

FileSystemException - exception thrown during file move.

(JavaScript Function) setPendingUploadFilesAvailable

public void (JavaScript Function) setPendingUploadFilesAvailable(IFolderObject theFolder,
                                                      java.lang.String thePendingUploadId,
                                                      java.lang.String theProgressId,
                                                      java.lang.String theTargetDir)
                                               throws FileSystemException

Notify MB that pending uploads are available

Parameters:

theFolder - the folder where the files are waiting

Throws:

FileSystemException

(JavaScript Function) fileImport

public ManagedFile (JavaScript Function) fileImport(IFileObject theFile,
                                         ImportParameters theParameters)
                                  throws FileSystemException

Imports or re-imports a file.

Parameters:

theFile - The file to import

theParameters - the import parameters (optional)

Returns:

the imported file, return null if the given file is excluded from import or is outside the MediaBeacon asset root

Throws:

FileSystemException

(JavaScript Function) folderImportWithParameters

public ManagedFolder (JavaScript Function) folderImportWithParameters(IFolderObject theFolder,
                                                           ImportParameters theParameters)
                                                    throws FileSystemException

Imports or re-imports a folder.

Parameters:

theFolder - The folder to import.

theParameters - the import parameters

Returns:

the imported folder, return null if the given folder is excluded from import or is outside the MediaBeacon asset root.

Throws:

FileSystemException

(JavaScript Function) folderImport

public ManagedFolder (JavaScript Function) folderImport(IFolderObject theFolder,
                                             java.lang.Boolean theDoNotDescend)
                                      throws FileSystemException

Imports or re-imports a folder.

Parameters:

theFolder - The folder to import.

theDoNotDescend - When importing an unmanaged folder, set this flag to block import of internal files and folders.

Returns:

the imported folder, return null if the given folder is excluded from import or is outside the MediaBeacon asset root.

Throws:

FileSystemException

(JavaScript Function) fileReplace

public ManagedFile (JavaScript Function) fileReplace(ManagedFile theSrc,
                                          ManagedFile theDest)
                                   throws FileSystemException

Replace an asset with another asset, maintaining the replaced asset's metadata.

Parameters:

theSrc - The asset to replace with.

theDest - The asset to replace.

Returns:

Reference to the new replaced file.

Throws:

FileSystemException - if the source or destination file doesn't exist, isn't imported or if an error occurs during the replace.

(JavaScript Function) replaceAsset

public ManagedFile (JavaScript Function) replaceAsset(IFileObject theSrc,
                                           ManagedFile theDest,
                                           boolean theIsRename)
                                    throws FileSystemException

Replaces asset data with uploaded file that resides on the portal server.

Parameters:

theSrc - the source file

theDest - the destination asset

theIsRename - should the file be renamed?

Returns:

reference to the new replaced file

Throws:

FileSystemException

(JavaScript Function) folderCopy

public IFolderObject (JavaScript Function) folderCopy(IFolderObject theSrc,
                                           IFolderObject theDest,
                                           java.lang.String theDestName)
                                    throws FileSystemException

Copy a folder.

Parameters:

theSrc - the folder to copy.

theDest - the folder to copy to.

theDestName - the name of the resulting folder

Throws:

FileSystemException - exception thrown during folder copy.

(JavaScript Function) folderDelete

public void (JavaScript Function) folderDelete(IFolderObject theFolder)
                             throws FileSystemException

Delete a folder.

Parameters:

theFolder - the folder to delete.

Throws:

FileSystemException - exception thrown during folder delete.

(JavaScript Function) folderNew

public IFolderObject (JavaScript Function) folderNew(IFolderObject theDestinationFolder,
                                          java.lang.String theNewFolder)
                                   throws FileSystemException

Create a folder.

Parameters:

theDestinationFolder - the folder to create in.

theNewFolder - the name of the folder to create.

Throws:

FileSystemException - exception thrown during folder creation.

(JavaScript Function) folderRename

public IFolderObject (JavaScript Function) folderRename(IFolderObject theFolder,
                                             java.lang.String theNewName)
                                      throws FileSystemException

Rename a folder.

Parameters:

theFolder - the folder to rename.

theNewName - the new name of the folder.

Throws:

FileSystemException - exception thrown during folder renaming.

(JavaScript Function) folderMove

public IFolderObject (JavaScript Function) folderMove(IFolderObject theSrc,
                                           IFolderObject theDest,
                                           java.lang.String theFolderName)
                                    throws FileSystemException

Move a folder.

Parameters:

theSrc - the folder to move.

theDest - the folder to move to.

theFolderName - the name of the resulting folder.

Throws:

FileSystemException - exception thrown during folder move.

(JavaScript Function) getFolderObjectById

public ManagedFolder (JavaScript Function) getFolderObjectById(int theFolderId)

Creates a new ManagedFolder object for the given folder ID.

Parameters:

theFolderId - the asset id.

Returns:

a new ManagedFolder instance.

(JavaScript Function) getFilePaths

@Deprecated
public java.util.List (JavaScript Function) getFilePaths(IFolderObject theDir,
                                                          boolean theReturnAllFiles)
                                                   throws java.lang.Exception

Deprecated. use ManagedFolder.(JavaScript Function) getContents or UnmanagedFolder.(JavaScript Function) getContents instead. This function will fail for folders outside of the MediaBeacon asset root.

Gets all files in a folder.

Parameters:

theDir - the folder to find files in.

theReturnAllFiles - if true, return all files, not just droplets and scripts.

Returns:

the list of files found.

Throws:

java.lang.Exception - exception thrown while finding files.

(JavaScript Function) getRelativePath

@Deprecated
public java.lang.String (JavaScript Function) getRelativePath(IFileObject theFile)
                                                        throws java.lang.Exception

Deprecated. use ManagedFile.(JavaScript Getter) path or UnmanagedFile.(JavaScript Function) getRelativePath instead.

Get the file's path relative to the MediaBeacon asset root. Returns null if the file is not within the current asset root folder. The path will contain unix-style file separators regardless of what file system hosts the assets.

Parameters:

theFile - the file to get a relative path to.

Returns:

the relative path to the given file.

Throws:

java.lang.Exception

(JavaScript Function) getPdfFromManagedFile

public PDF (JavaScript Function) getPdfFromManagedFile(ManagedFile theFile)

Get a PDF object from a ManagedFile object

Parameters:

theFile - the ManagedFile

Returns:

the PDF

(JavaScript Function) createBundleFolder

public Bundle (JavaScript Function) createBundleFolder(java.lang.String theBundlePath,
                                            BundleType theBundleFlag)

Creates a folder bundle. Creates the folder if it doesn't already exist, then creates the bundle control file if it doesn't already exist. Set the bundle's type flag to the given value whether or not the bundle control file already exists. Important note: this function cannot create search or selection bundles.

Parameters:

theBundlePath - The path to the new bundle.

theBundleFlag - The bundle type. One of 'transparent_bundle' or 'opaque_bundle'.

Returns:

The bundle control file.

See Also:

BundleType

(JavaScript Function) removeBundleMetadata

public void (JavaScript Function) removeBundleMetadata(java.lang.String theBundlePath)

Remove everything associated with a bundle, including the metadata asset.

Parameters:

theBundlePath - The relative path to the new bundle.

(JavaScript Getter) bundleTypes

public JSMap (JavaScript Getter) bundleTypes()