Image Uploader embedding scripts library exposes the InstallationProgressExtender, AmazonS3Extender, and NirvanixExtender classes which extend Image Uploader additional functionality. This section contains the InstallationProgressExtender, AmazonS3Extender, and NirvanixExtender API reference.

InstallationProgressExtender Members

InstallationProgressExtender allows displaying special screens instead of the ActiveX control or Java applet during the downloading and installation phases. See details in the Using Image Uploader Installation Progress topic.

This extender is defined in the iuembed.InstallationProgress.js file of the library and includes the following members.

Constructor

Name Arguments Description
public method InstallationProgressExtender writer - An instance of ImageUploaderWriter object.

Creates and initializes an instance of the InstallationProgressExtender class.

Properties

Name Description
public property getAltInstallerEnabled()
setAltInstallerEnabled(value)
Gets or sets switch that specifies whether to display instructions on how to install Image Uploader in alternative way (e.g. use a standalone installer).
public property getAltInstallerHtml()
setAltInstallerHtml(value)
Gets or sets HTML-marked text appended to installation instructions in the case if alternative installer is enabled.
public property getAltInstallerUrl()
setAltInstallerUrl(value)
Gets or sets a custom link to an alternative installer.
public property getBeforeIE6XPSP2InstallJavaHtml()
setBeforeIE6XPSP2InstallJavaHtml(value)
Gets or sets Java applet installation instructions for Internet Explorer 6 running on version of Windows earlier than Windows XP Service Pack 2.
public property getBeforeIE6XPSP2InstructionsHtml()
setBeforeIE6XPSP2InstructionsHtml(value)
Gets or sets ActiveX control installation instructions for Internet Explorer 6 running on version of Windows earlier than Windows XP Service Pack 2.
public property getBeforeIE6XPSP2ProgressHtml()
setBeforeIE6XPSP2ProgressHtml(value)
Gets or sets ActiveX control downloading instructions for Internet Explorer 6 running on version of Windows earlier than Windows XP Service Pack 2.
public property getCommonHtml()
setCommonHtml(value)
Gets or sets HTML-marked description of the ActiveX control displayed on the both stages (downloading and installation).
public property getCommonInstallJavaHtml()
setCommonInstallJavaHtml(value)
Gets or sets common instructions on the Java applet installation.
public property getIE6XPSP2InstallJavaHtml()
setIE6XPSP2InstallJavaHtml(value)
Gets or sets Java applet installation instructions for Internet Explorer 6 running on version of Windows equal to Windows XP Service Pack 2 or higher.
public property getIE6XPSP2InstructionsHtml()
setIE6XPSP2InstructionsHtml(value)
Gets or sets ActiveX control installation instructions for Internet Explorer 6 running on version of Windows equal to Windows XP Service Pack 2 or higher.
public property getIE6XPSP2ProgressHtml()
setIE6XPSP2ProgressHtml(value)
Gets or sets ActiveX control downloading instructions for Internet Explorer 6 running on version of Windows equal to Windows XP Service Pack 2 or higher.
public property getIE7InstallJavaHtml()
setIE7InstallJavaHtml(value)
Gets or sets Java applet installation instructions for Internet Explorer 7.
public property getIE7InstructionsHtml()
setIE7InstructionsHtml(value)
Gets or sets ActiveX control installation instructions for Internet Explorer 7.
public property getIE7ProgressHtml()
setIE7ProgressHtml(value)
Gets or sets ActiveX control downloading instructions for Internet Explorer 7.
public property getIE8InstallJavaHtml()
setIE8InstallJavaHtml(value)
Gets or sets Java applet installation instructions for Internet Explorer 8.
public property getIE8InstructionsHtml()
setIE8InstructionsHtml(value)
Gets or sets ActiveX control installation instructions for Internet Explorer 8.
public property getIE8ProgressHtml()
setIE8ProgressHtml(value)
Gets or sets ActiveX control downloading instructions for Internet Explorer 8.
public property getInstructionsCssClass()
setInstructionsCssClass(value)
Gets or sets CSS class name to apply it to the installation screen. This class should be declared in a source code of the page Image Uploader is added to, or in the external CSS file linked to this page.
public property getJavaProgressHtml()
setJavaProgressHtml(value)
Gets or sets text saying that the downloading of the Java applet is in progress.
public property getMacInstallJavaHtml()
setMacInstallJavaHtml(value)
Gets or sets Java applet installation instructions for Mac browsers.
public property getMiscBrowsersInstallJavaHtml()
setMiscBrowsersInstallJavaHtml(value)
Gets or sets Java applet installation instructions for other browsers (FireFox on Windows, Opera on Windows, FireFox on Linux and so on).
public property getProgressCssClass()
setProgressCssClass(value)
Gets or sets CSS class name to apply it to the downloading screen. This class should be declared in a source code of the page Image Uploader is added to, or in the external CSS file linked to this page.
public property getProgressHtml()
setProgressHtml(value)
Gets or sets text saying that the downloading is in progress.
public property getProgressImageUrl()
setProgressImageUrl(value)
Gets or sets a custom image to replace a default wait indicator.
public property getUpdateInstructions()
setUpdateInstructions(value)
Gets or sets common instructions on how to update the ActiveX control.

AmazonS3Extender Members

AmazonS3Extender extends Image Uploader functionality with direct upload to Amazon S3 storage. See the Uploading to Cloud Storages topic for the detailed instructions on how to use it.

This extender is defined in the iuembed.AmazonS3.js file of the library and includes two classes: AmazonS3Extender and FileSettings.

AmazonS3Extender Class

Extends Image Uploader with a direct upload to Amazon S3 storage.

Constructor

Name Arguments Description
public method AmazonS3Extender writer - An instance of ImageUploaderWriter object.

Creates and initializes an instance of the AmazonS3Extender class.

Properties

Name Description
public property getAWSAccessKeyId()
setAWSAccessKeyId(value)
Gets or sets the AWS Access Key ID of the owner of the bucket.
public property getBucket()
setBucket(value)
Gets or sets the bucket name.
public property getBucketHostName()
setBucketHostName(value)
Gets or sets the custom bucket host name.
public property getSourceFile() Gets source file upload settings.
public property getThumbnail1() Gets the first thumbnail upload settings.
public property getThumbnail2() Gets the second thumbnail upload settings.
public property getThumbnail3() Gets the third thumbnail upload settings.

FileSettings Class

Represents upload file settings.

Properties

Name Description
public property getAcl()
setAcl(value)
Gets or sets an Amazon S3 access control list. Options include private, public-read, public-read-write, and authenticated-read.
public property getKey()
setKey(value)
Gets or sets an Amazon S3 file key.
public property getPolicy()
setPolicy(value)
Gets or sets the security policy describing what is permitted in the request. Requests without security policy are considered anonymous and only work on publicly writable buckets.
public property getSignature()
setSignature(value)
Gets or sets the HMAC signature constructed using the secret key of the provided AWSAccessKeyID.

Methods

Name Arguments Description
public method addPredefinedProperty name - a name of metadata property. field - a HTTP POST field name (Description_1, Width_1, Height_1, and so on).

Adds metadata property with predefined value.

public method addProperty name - a name of metadata property. value - a value of the custom metadata field.

Adds metadata property.

public method getProperty name - a name of metadata property.

Returns a value of metadata property.

public method removeProperty name - a name of metadata property.

Removes metadata property.

NirvanixExtender Members

NirvanixExtender extends Image Uploader functionality with direct upload to Nirvanix storage. See the Uploading to Cloud Storages topic for the detailed instructions on how to use it.

This extender is defined in the iuembed.Nirvanix.js file of the library and includes the following members.

Constructor

Name Arguments Description
public method NirvanixExtender writer - An instance of ImageUploaderWriter object.

Creates and initializes an instance of the NirvanixExtender class.

Properties

Name Description
public property getUploadToken()
setUploadToken(value)
Gets or sets an access token to pass into one of the upload methods when performing an upload.
public property getUploadHost()
setUploadHost(value)
Gets or sets the server to upload to.
public property getDestFolderPath()
setDestFolderPath(value)
Gets or sets the destination path of the files being uploaded.

Events

Name Description
public event addServiceError(clientFunction)
removeServiceError(clientFunction)
Adds or removes a handler of the event which fires if some error occurred during upload to Nirvanix service.