Item object

Object

Version 1.0.0.0 or later

An item is a resource covered by DEXTUploadX5. Items are separated into local files, local folders, and virtual files, and the component provides several methods to get the item (or many) in the script.

// Get the sixth item.
var item = dx.getItemByIndex(5);

// Print the name of the item. 
console.log(item.name);

Most of the items obtained using the methods provided by the component are copies.

Properties

controlId

• Version 1.0.0.0 or later

• Explanation

  A string representing the ID of the component where the item was created.

id

• Version 1.0.0.0 or later

• Explanation

  A string representing the unique ID of the item.

type

• Version 1.0.0.0 or later

• Explanation

  A string representing the format of the item.

  • "FILE": Local file
  • "VIRTUAL": Virtual file
  • "DVIRTUAL": Deleted virtual file

name

• Version 1.0.0.0 or later

• Explanation

  It is a string indicating the name of the item, file or folder name.

ext

• Version 1.0.0.0 or later

• Explanation

  A string indicating the extension of the item.

vindex

• Version 1.0.0.0 or later

• Explanation

  A string representing the virtual index of the item.

  The virtual index used in a virtual file is a kind of key value that you specify manually.

  ex) vindex: "1234567890"

size

• Version 1.0.0.0 or later

• Explanation

  The size of the item in bytes.

  When you download a file, you need to know the size of the file to show the correct progress information.

  Since only the virtual file is targeted for downloading, when designating the virtual file, it is necessary to input the size of the target file existing on the server as accurately as possible.

mdate

• Version 1.0.0.0 or later

• Explanation

  A Date value indicating the modification date of the local item.

lock

• Version 1.0.0.0 or later

• Explanation

  A Boolean value indicating the lock status of the item.

  If you lock an item, you can not delete it.

status

• Version 1.0.0.0 or later

• Explanation

  A string representing the status of the item.

  "WAIT": Before upload, "DONE": After upload

checked

• Version 1.0.0.0 or later

• Explanation

  A Boolean value indicating the checked state of the item.

openUrl

• Version 1.0.0.0 or later

• Explanation

  A string representing the path to open the virtual file.

  openUrl is the web address where the opening is to be done, and it must be the full URL containing the schema (http, https).

  Opening refers only to files that can be opened directly by the browser, and other files are downloaded. Even if the file can be opened by the browser, if it is delivered in attachement format from the server, it will be downloaded without opening it. Therefore, openUrl must be configured to receive inline format.

downUrl

• Version 1.0.0.0 or later

• Explanation

  A string representing the download path of the virtual file.

  downUrl is the web address where the download is to be performed, and it must be the full URL containing the schema (http, https).

  Since all browsers supporting HTML5 do not support the download attribute of the anchor HTML element, the target resource must set the response header in the form of attachement from the server.

middlePath

• Version 3.7.0.0 or later

• Explanation

  A string representing the folder path of the item. When the target is a local resource (file, folder), it points to the parent folder of the resource. The parent folder path does not start with the drive, but is a subpath of the folder selected via the folder selection dialog.

  • aaa/bbb/ccc

  If the item is a virtual file rather than a local resource, it contains a folder path value for downloading the folder structure.

url

• Version 1.4.1.0 or later

• Explanation

  A string representing the web path of the virtual file.

  The url is the web address to which to download or open, and it must be the full URL containing the schema (http, https).

  This property is the same as downUrl.

eventUriStart

• Version 2.0.0.0 or later

• Explanation

  A string indicating the event address used when using file downloads with HD applications.

  The event address is a web address, which must be a full URL containing a schema (http, https).

  When the HD application downloads an item, if this property is set, it sends a GET request to the address pointed to by the eventUriStart property before performing the download.

eventUriStop

• Version 2.0.0.0 or later

• Explanation

  A string indicating the event address used when using file downloads with HD applications.

  The event address is a web address, which must be a full URL containing a schema (http, https).

  When the HD application downloads an item, if this property is set and the download stops in the state, it sends a GET request to the address pointed to by the eventUriStop property. (This is not a stop due to an error, but a stop by a user action.)

eventUriEnd

• Version 2.0.0.0 or later

• Explanation

  A string indicating the event address used when using file downloads with HD applications.

  The event address is a web address, which must be a full URL containing a schema (http, https).

  When the HD application downloads an item, if this property is set, it sends a GET request to the address pointed to by the eventUriEnd property after the download is complete.

chunkSize

• Version 2.0.0.0 or later

• Explanation

  It is a numeric value that indicates the size at which files are split when using file downloads with HD applications.

  The HD application does not download the file at one time with a single request, but do so by dividing it by a given size. If you download the file by dividing it, the file downloading time may take a little longer, but you can run the server more reliably. If the size of the file to be downloaded is large, the bandwidth is caught until the file is downloaded, which may cause performance problems. In this case, splitting the file will split the download request to the server, reducing the likelihood that some users will occupy the server resources for a long time.

  If it is not specified, it is set to -1 value. If it is -1 or 0, it is received as one request without splitting the file. In addition, the chunck size must be specified in MB only.

hdTitle

• Version 2.1.2.0 or later

• Explanation

  It is a string that represents the text that is output to the window title when using the HD application.

  When a file is being downloaded, the title and filename are displayed in the window title area of ​​the HD application. If there is no specified value, the product name and version are displayed.