Built-In Namespace _global_
Field Attributes | Field Name and Description |
---|---|
ext to mime type mapping
|
|
Workflow to create folders given paths using a REST call
|
|
Workflow to return the Path of the (asset/assets) given a list of asset Id's using a REST call
|
Method Attributes | Method Name and Description |
---|---|
aCallback(theManagedFile)
CallBack for the search.
|
|
addFile(theFile)
adds aFiles name to the array of files in the return object in myData
|
|
addFolder(theFolder)
adds a Folder name to the array of folders in the return object in myData
|
|
assembleReturnFields(theFields)
Assembles the return fields.
|
|
assetIdToPath(theAssetId)
Creates a JSON object with the path of the given asset and adds it to myData
|
|
buildCriterion(theJSONSearch)
Builds a Boolean criterion
|
|
compressFiles(theSource)
Compresses the assets and places the zip in Renditions/Workflows/_internal/restapi/tmp/
|
|
compressFilesInternal(theSource)
Compresses a list of assets given their ID's and adds an object to myData containing the path to the compressed file
|
|
configureSchemaOrSummary(theType)
Adds Uri's to the contact sheet url(and specific fields if Summary contact sheet
|
|
createFolder(theSource)
Creates a new folder with the given path and adds an object to myData with the path
|
|
decompressFiles(theSource, theDestination)
decompresses the given asset and adds an object to myData with the path of the decompressed asset
|
|
fileOrFolderDelete(theSource)
Deletes the file or folder and adds an object with the ID/path to myData
|
|
fileOrFolderImport(theSource)
Imports the source file or folder and adds an object containing the assetId/folderPath to myData
|
|
folderContents(theSource)
Adds an object to myData containing an array of files and an array of folders
|
|
formatResults(theManagedFile)
Adds a result to the result array in myData
|
|
generateSearch(theJSONSearch)
returns a Search wrapper created from the JSON search object
|
|
getAssets(theAssetOrResolver)
uses assets ids from 'src' array from context or the resolver string given
|
|
getDictionary(theDictionaryName)
Gets a dictionary and a list of words and put them into myData.
|
|
getDiscussionInternal(theAssetId)
Adds an object to myData containing the value of the given schema/field
|
|
getField(theAssetId)
Adds an object to myData containing the value of the given schema/field
|
|
getInfo(theAssetId)
Creates a JSON object with the path of the given asset and adds it to myData
|
|
getMimeType(theFile)
Given an asset id we return a mime type
|
|
Gets the selection for the given User.
|
|
getXmp(theAssetID)
Adds an object to myData containing the xmp of the given asset
|
|
includeDirectory(aSearch, theSearchDirectory)
Adds the directory to the quickSearch
|
|
incrementName(theParentPath, theOldName)
Used to increment files with the same name test.txt becomes test 1.txt
|
|
initReturnObject(theSrcPath)
Inits JSON for the current src folder
|
|
Gets a list of dictionaries.
|
|
main()
Removes old files in the restapi temp folder.
|
|
makeWord(name)
Creates a Dictionary word
|
|
move(theSource, aDest-)
Moves the files or folders and adds an object with the ID/path to myData
|
|
pathToAssetId(theSource)
Adds an object containing the assetID of the src asset fo myData
|
|
removeFiles(theParent, theRemoveAll)
Removes files > 24 hours old in theParentFolder and deletes theParentFolder if it is empty
|
|
rename(theSource, aName)
Renames the source file or folder and adds an object to myData containing its assetID/folderPath
|
|
setDiscussionInternal(theId, theContent, theUser)
writes aVal to the field adds a object to myData containing the written metadata
|
|
setFields(theSource, theSchema, theField, theValue)
writes aVal to the field adds a object to myData containing the written metadata
|
|
setXmp(theAsset, theXmpAsset)
Copies the xmp from the xmpAsset to theAsset and keeps both assets unmanaged.
|
|
submit(theAssetId)
Submits the asset to the preview system and adds a JSON object containing the id of the asset to myData
context transformation variables include
format
scale
res
destcolor
path - output path(loading dock if not given)
|
Field Detail
kMimeMap
ext to mime type mapping
Defined in: mimeType.js.
Defined in: mimeType.js.
myData
Workflow to create folders given paths using a REST call
Defined in: create.js.
Defined in: create.js.
REST
Workflow to return the Path of the (asset/assets) given a list of asset Id's using a REST call
Defined in: assetIdToPath.js.
Defined in: assetIdToPath.js.
Method Detail
aCallback(theManagedFile)
CallBack for the search. Adds the results to myData.
Defined in: quickSearch.js.
Defined in: quickSearch.js.
- Parameters:
- theManagedFile
addFile(theFile)
adds aFiles name to the array of files in the return object in myData
Defined in: folderContents.js.
Defined in: folderContents.js.
- Parameters:
- theFile
- file to add to the list of files
addFolder(theFolder)
adds a Folder name to the array of folders in the return object in myData
Defined in: folderContents.js.
Defined in: folderContents.js.
- Parameters:
- theFolder
- folder to add to the list of files
assembleReturnFields(theFields)
Assembles the return fields. This should either be in the 'fields' parameter or in the search criterion if the fields
parameter is undefined.
Defined in: search.js.
Defined in: search.js.
- Parameters:
- theFields
- the fields to return;
assetIdToPath(theAssetId)
Creates a JSON object with the path of the given asset and adds it to myData
Defined in: assetIdToPath.js.
Defined in: assetIdToPath.js.
- Parameters:
- theAssetId
buildCriterion(theJSONSearch)
Builds a Boolean criterion
Defined in: search.js.
Defined in: search.js.
- Parameters:
- theJSONSearch
- Returns:
- BooleanCriterion
{*}
compressFiles(theSource)
Compresses the assets and places the zip in Renditions/Workflows/_internal/restapi/tmp/
Defined in: download.js.
Defined in: download.js.
- Parameters:
- theSource
- array of asset ids
- Returns:
- {*}
{*}
compressFilesInternal(theSource)
Compresses a list of assets given their ID's and adds an object to myData containing the path to the compressed file
Defined in: compressFiles.js.
Defined in: compressFiles.js.
- Parameters:
- theSource
- - list of asset Ids
- Returns:
- {*}
{*}
configureSchemaOrSummary(theType)
Adds Uri's to the contact sheet url(and specific fields if Summary contact sheet
Defined in: generateContactSheet.js.
Defined in: generateContactSheet.js.
- Parameters:
- theType
- Returns:
- {*}
{*}
createFolder(theSource)
Creates a new folder with the given path and adds an object to myData with the path
Defined in: create.js.
Defined in: create.js.
- Parameters:
- theSource
- the path to the new folder
- Returns:
- {*}
decompressFiles(theSource, theDestination)
decompresses the given asset and adds an object to myData with the path of the decompressed asset
Defined in: decompressFiles.js.
Defined in: decompressFiles.js.
- Parameters:
- theSource
- theDestination
fileOrFolderDelete(theSource)
Deletes the file or folder and adds an object with the ID/path to myData
Defined in: delete.js.
Defined in: delete.js.
- Parameters:
- theSource
- - the Id of the asset to delete or the path of the folder to delete
fileOrFolderImport(theSource)
Imports the source file or folder and adds an object containing the assetId/folderPath to myData
Defined in: import.js.
Defined in: import.js.
- Parameters:
- theSource
- the file or folder to import
folderContents(theSource)
Adds an object to myData containing an array of files and an array of folders
Defined in: folderContents.js.
Defined in: folderContents.js.
- Parameters:
- theSource
- the path of the folder to get the contents of
formatResults(theManagedFile)
Adds a result to the result array in myData
Defined in: search.js.
Defined in: search.js.
- Parameters:
- theManagedFile
generateSearch(theJSONSearch)
returns a Search wrapper created from the JSON search object
Defined in: search.js.
Defined in: search.js.
- Parameters:
- theJSONSearch
- Returns:
- SearchWrapper
{*}
getAssets(theAssetOrResolver)
uses assets ids from 'src' array from context or the resolver string given
Defined in: generateContactSheet.js.
Defined in: generateContactSheet.js.
- Parameters:
- theAssetOrResolver
- Returns:
- {*}
getDictionary(theDictionaryName)
Gets a dictionary and a list of words and put them into myData.
Defined in: dictionary.js.
Defined in: dictionary.js.
- Parameters:
- theDictionaryName
getDiscussionInternal(theAssetId)
Adds an object to myData containing the value of the given schema/field
Defined in: getDiscussion.js.
Defined in: getDiscussion.js.
- Parameters:
- theAssetId
- - the id of the asset to get the value of
getField(theAssetId)
Adds an object to myData containing the value of the given schema/field
Defined in: getField.js.
Defined in: getField.js.
- Parameters:
- theAssetId
- - the id of the asset to get the value of
getInfo(theAssetId)
Creates a JSON object with the path of the given asset and adds it to myData
Defined in: info.js.
Defined in: info.js.
- Parameters:
- theAssetId
{*}
getMimeType(theFile)
Given an asset id we return a mime type
Defined in: mimeType.js.
Defined in: mimeType.js.
- Parameters:
- theFile
- Returns:
- {*}
getSelections()
Gets the selection for the given User. Default user is the current user
Defined in: getSavedSelections.js.
Defined in: getSavedSelections.js.
getXmp(theAssetID)
Adds an object to myData containing the xmp of the given asset
Defined in: getXmp.js.
Defined in: getXmp.js.
- Parameters:
- theAssetID
- - an asset ID
includeDirectory(aSearch, theSearchDirectory)
Adds the directory to the quickSearch
Defined in: quickSearch.js.
Defined in: quickSearch.js.
- Parameters:
- aSearch
- theSearchDirectory
{string}
incrementName(theParentPath, theOldName)
Used to increment files with the same name test.txt becomes test 1.txt
Defined in: upload.js.
Defined in: upload.js.
- Parameters:
- theParentPath
- theOldName
- Returns:
- {string}
initReturnObject(theSrcPath)
Inits JSON for the current src folder
Defined in: folderContents.js.
Defined in: folderContents.js.
- Parameters:
- theSrcPath
listDictionaries()
Gets a list of dictionaries.
Defined in: dictionary.js.
Defined in: dictionary.js.
{string}
main()
Removes old files in the restapi temp folder. Renditions/Workflows/_internal/restapi/tmp/
Called every 24 hours on a schedule
Clears all tmp files if triggered manually or by REST request
Defined in: clean.js.
Defined in: clean.js.
- Returns:
- {string}
{{}}
makeWord(name)
Creates a Dictionary word
Defined in: directoryDictionary.js.
Defined in: directoryDictionary.js.
- Parameters:
- name
- Returns:
- {{}}
move(theSource, aDest-)
Moves the files or folders and adds an object with the ID/path to myData
Defined in: move.js.
Defined in: move.js.
- Parameters:
- theSource
- -assetId or folderPath to move
- aDest-
- the path to the destination folder
pathToAssetId(theSource)
Adds an object containing the assetID of the src asset fo myData
Defined in: pathToAssetId.js.
Defined in: pathToAssetId.js.
- Parameters:
- theSource
- assetID
removeFiles(theParent, theRemoveAll)
Removes files > 24 hours old in theParentFolder and deletes theParentFolder if it is empty
Defined in: clean.js.
Defined in: clean.js.
- Parameters:
- theParent
- Managed Folder
- theRemoveAll
rename(theSource, aName)
Renames the source file or folder and adds an object to myData containing its assetID/folderPath
Defined in: rename.js.
Defined in: rename.js.
- Parameters:
- theSource
- assetID/folderPath
- aName
- the new name of the asset/folder
setDiscussionInternal(theId, theContent, theUser)
writes aVal to the field adds a object to myData containing the written metadata
Defined in: setDiscussion.js.
Defined in: setDiscussion.js.
- Parameters:
- theId
- the asset to add the discussion to.
- theContent
- the content of the discussion item to be added.
- theUser
setFields(theSource, theSchema, theField, theValue)
writes aVal to the field adds a object to myData containing the written metadata
Defined in: setField.js.
Defined in: setField.js.
- Parameters:
- theSource
- -asset ID
- theSchema
- theField
- theValue
- - value to write to the field
setXmp(theAsset, theXmpAsset)
Copies the xmp from the xmpAsset to theAsset and keeps both assets unmanaged.
Defined in: upload.js.
Defined in: upload.js.
- Parameters:
- theAsset
- the destination asset.
- theXmpAsset
- the asset with the source XMP.
submit(theAssetId)
Submits the asset to the preview system and adds a JSON object containing the id of the asset to myData
context transformation variables include
format
scale
res
destcolor
path - output path(loading dock if not given)
Defined in: submitAssets.js.
Defined in: submitAssets.js.
- Parameters:
- theAssetId
- the asset ID