Image Uploader Extenders
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 | |
|---|---|---|---|
 |
InstallationProgressExtender | writer - An instance of ImageUploaderWriter object. | Creates and initializes an instance of the InstallationProgressExtender class. |
Properties
| Name | Description | |
|---|---|---|
 |
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). |
|
getAltInstallerHtml() setAltInstallerHtml(value) |
Gets or sets HTML-marked text appended to installation instructions in the case if alternative installer is enabled. |
|
getAltInstallerUrl() setAltInstallerUrl(value) |
Gets or sets a custom link to an alternative installer. |
|
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. |
|
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. |
|
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. |
|
getCommonHtml() setCommonHtml(value) |
Gets or sets HTML-marked description of the ActiveX control displayed on the both stages (downloading and installation). |
|
getCommonInstallJavaHtml() setCommonInstallJavaHtml(value) |
Gets or sets common instructions on the Java applet installation. |
|
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. |
|
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. |
|
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. |
|
getIE7InstallJavaHtml() setIE7InstallJavaHtml(value) |
Gets or sets Java applet installation instructions for Internet Explorer 7. |
|
getIE7InstructionsHtml() setIE7InstructionsHtml(value) |
Gets or sets ActiveX control installation instructions for Internet Explorer 7. |
|
getIE7ProgressHtml() setIE7ProgressHtml(value) |
Gets or sets ActiveX control downloading instructions for Internet Explorer 7. |
|
getIE8InstallJavaHtml() setIE8InstallJavaHtml(value) |
Gets or sets Java applet installation instructions for Internet Explorer 8. |
|
getIE8InstructionsHtml() setIE8InstructionsHtml(value) |
Gets or sets ActiveX control installation instructions for Internet Explorer 8. |
|
getIE8ProgressHtml() setIE8ProgressHtml(value) |
Gets or sets ActiveX control downloading instructions for Internet Explorer 8. |
|
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. |
|
getJavaProgressHtml() setJavaProgressHtml(value) |
Gets or sets text saying that the downloading of the Java applet is in progress. |
|
getMacInstallJavaHtml() setMacInstallJavaHtml(value) |
Gets or sets Java applet installation instructions for Mac browsers. |
|
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). |
|
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. |
|
getProgressHtml() setProgressHtml(value) |
Gets or sets text saying that the downloading is in progress. |
|
getProgressImageUrl() setProgressImageUrl(value) |
Gets or sets a custom image to replace a default wait indicator. |
|
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 | |
|---|---|---|---|
|
AmazonS3Extender | writer - An instance of ImageUploaderWriter object. | Creates and initializes an instance of the AmazonS3Extender class. |
Properties
| Name | Description | |
|---|---|---|
|
getAWSAccessKeyId() setAWSAccessKeyId(value) |
Gets or sets the AWS Access Key ID of the owner of the bucket. |
|
getBucket() setBucket(value) |
Gets or sets the bucket name. |
|
getBucketHostName() setBucketHostName(value) |
Gets or sets the custom bucket host name. |
|
getSourceFile() | Gets source file upload settings. |
|
getThumbnail1() | Gets the first thumbnail upload settings. |
|
getThumbnail2() | Gets the second thumbnail upload settings. |
|
getThumbnail3() | Gets the third thumbnail upload settings. |
FileSettings Class
Represents upload file settings.
Properties
| Name | Description | |
|---|---|---|
|
getAcl() setAcl(value) |
Gets or sets an Amazon S3 access control list. Options include private,
public-read, public-read-write, and
authenticated-read. |
|
getKey() setKey(value) |
Gets or sets an Amazon S3 file key. |
|
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. |
|
getSignature() setSignature(value) |
Gets or sets the HMAC signature constructed using the secret key of the provided AWSAccessKeyID. |
Methods
| Name | Arguments | Description | |
|---|---|---|---|
|
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. |
|
addProperty | name - a name of metadata property. value - a value of the custom metadata field. | Adds metadata property. |
|
getProperty | name - a name of metadata property. | Returns a value of metadata property. |
|
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 | |
|---|---|---|---|
|
NirvanixExtender | writer - An instance of ImageUploaderWriter object. | Creates and initializes an instance of the NirvanixExtender class. |
Properties
| Name | Description | |
|---|---|---|
|
getUploadToken() setUploadToken(value) |
Gets or sets an access token to pass into one of the upload methods when performing an upload. |
|
getUploadHost() setUploadHost(value) |
Gets or sets the server to upload to. |
|
getDestFolderPath() setDestFolderPath(value) |
Gets or sets the destination path of the files being uploaded. |
Events
| Name | Description | |
|---|---|---|
 |
addServiceError(clientFunction) removeServiceError(clientFunction) |
Adds or removes a handler of the event which fires if some error occurred during upload to Nirvanix service. |