Skip to content
This repository has been archived by the owner on Jul 27, 2019. It is now read-only.

Latest commit

 

History

History
130 lines (95 loc) · 4.7 KB

File metadata and controls

130 lines (95 loc) · 4.7 KB

Members

CSDKAssetBrowser

A global object that lets you interact with the Creative SDK Asset Browser.

Typedefs

successCallback : function

A callback to be used upon successful upload or download of an image.

errorCallback : function

A callback to handle errors when attempting to upload or download an image.

DownloadOptions : Object

An object for configuring Asset Browser download behavior.

UploadOptions : Object

An object for configuring Asset Browser upload behavior.

CSDKAssetBrowser

A global object that lets you interact with the Creative SDK Asset Browser.

Kind: global variable

CSDKAssetBrowser.DataSourceType : enum

Kind: static enum property of CSDKAssetBrowser
Read only: true
Properties

Name Type Default
COMPOSITIONS number 0
DRAW number 1
FILES number 2
LIBRARY number 3
PHOTOS number 4
PSMIX number 5
SKETCHES number 6
LINE number 7
BRUSH number 8

CSDKAssetBrowser.downloadFiles(successCallback, errorCallback, options)

Downloads a file from the Creative Cloud.

Kind: static method of CSDKAssetBrowser

Param Type Description
successCallback successCallback See type definition.
errorCallback errorCallback See type definition.
options DownloadOptions An object containing optional property/value pairs.

CSDKAssetBrowser.uploadFile(successCallback, errorCallback, url, options)

Uploads a file to the Creative Cloud.

Kind: static method of CSDKAssetBrowser

Param Type Description
successCallback successCallback See type definition.
errorCallback errorCallback See type definition.
url string path to the asset to be uploaded.
options UploadOptions An object containing optional property/value pairs.

successCallback : function

A callback to be used upon successful upload or download of an image.

Kind: global typedef

Param Type Description
newUrl string The URL of the new downloaded image.

errorCallback : function

A callback to handle errors when attempting to upload or download an image.

Kind: global typedef

Param Type Description
error Object Error object.

DownloadOptions : Object

An object for configuring Asset Browser download behavior.

Kind: global typedef
Properties

Name Type Default Description
outputFile string "''" Path to save the file. If not specified the system default is used.

UploadOptions : Object

An object for configuring Asset Browser upload behavior.

Kind: global typedef
Properties

Name Type Default Description
uploadName string "''" The name your want the file to have in the Creative Cloud. If not specified the current file name is used.
overwrite boolean false Sets whether or not to overwrite the existing file or create a copy.