Item 객체

객체

1.0.0.0 이상

항목(item)이란 DEXTUploadX5에서 다루어지는 자원을 의미한다. 항목은 로컬 파일, 로컬 폴더, 가상 파일로 구분되며, 컴포넌트는 스크립트 상에서 항목(또는 다수)을 얻기위해 여러 가지 메소드를 제공한다.

// 여섯 번째 항목을 얻는다.
var item = dx.getItemByIndex(5);
// 항목의 이름을 출력한다.
console.log(item.name);

컴포넌트에서 제공하는 메소드를 사용하여 얻어진 항목의 대부분은 복사본이다.

속성

controlId

1.0.0.0 이상
설명

항목이 생성된 컴포넌트의 아이디를 나타내는 문자열이다.

id

1.0.0.0 이상
설명

항목의 고유 아이디를 나타내는 문자열이다.

type

1.0.0.0 이상
설명

항목의 형식을 나타내는 문자열이다.
- "FILE": 로컬 파일
- "VIRTUAL": 가상 파일
- "DVIRTUAL": 삭제된 가상 파일

name

1.0.0.0 이상
설명

항목의 이름, 파일 또는 폴더명을 나타내는 문자열이다.

ext

1.0.0.0 이상
설명

항목의 확장자를 나타내는 문자열이다.

vindex

1.0.0.0 이상
설명

항목의 가상 인덱스를 나타내는 문자열이다.

가상 파일에서 사용되는 가상 인덱스는 수동으로 지정하는 일종의 키 값이다.

ex) vindex: "1234567890"

size

1.0.0.0 이상
설명

항목의 크기(바이트 단위) 숫자값이다.

파일을 다운로드할 때, 올바른 진행 정보를 보여주려면 파일의 크기를 알아야 한다.

가상 파일만 다운로드의 대상이 되므로, 가상 파일을 지정할 때에는 가능한 서버에 존재하는 대상 파일의 크기를 정확히 입력해야 한다.

mdate

1.0.0.0 이상
설명

로컬 항목의 수정 일자을 나타내는 Date 형식의 값이다.

lock

1.0.0.0 이상
설명

항목의 잠금 상태를 나타내는 Boolean 값이다.

항목을 잠그면 항목을 삭제할 수 없다.

status

1.0.0.0 이상
설명

항목의 상태를 나타내는 문자열이다.

"WAIT": 업로드 전, "DONE": 업로드 후

checked

1.0.0.0 이상
설명

항목의 체크 상태를 나타내는 Boolean 값이다.

openUrl

1.0.0.0 이상
설명

가상 파일의 열기 경로를 나타내는 문자열이다.

openUrl은 열기를 수행할 대상이 있는 웹 주소로써, 스키마(http, https)가 포함된 전체 URL이어야 한다.

열기란 브라우저가 직접 열 수 있는 파일만 대상이 되며, 그 외의 파일들은 다운로드가 된다. 브라우저가 열 수 있는 파일일지라도 서버로부터 attachement 형식으로 전달이 되면, 열리지 않고 다운로드가 된다. 그러므로 openUrl은 반드시 inline 형식으로 전달받도록 서비스를 구성해야 한다.

downUrl

1.0.0.0 이상
설명

가상 파일의 다운로드 경로를 나타내는 문자열이다.

downUrl은 다운로드를 수행할 대상이 있는 웹 주소로써, 스키마(http, https)가 포함된 전체 URL이어야 한다.

HTML5를 지원하는 모든 브라우저가 anchor HTML 요소의 download 속성을 모두 지원하지 못하기 때문에, 대상 리소스는 서버로부터 attachement 형식으로 응답 헤더를 설정해야 한다.

middlePath

3.7.0.0 이상
설명

항목의 폴더 경로를 나타내는 문자열이다. 대상이 로컬 자원(파일, 폴더)일 때, 자원의 부모 폴더를 가리킨다. 부모 폴더 경로는 드라이브부터 시작하는 것이 아니라, 폴더 선택 다이얼로그를 통해서 선택된 폴더의 하위 경로를 의미한다.
- aaa/bbb/ccc
항목이 로컬 자원이 아니라 가상 파일인 경우에는 폴더 구조 다운로드를 위한 폴더 경로 값이 들어 있다.

url

1.4.1.0 이상
설명

가상 파일의 웹 경로를 나타내는 문자열이다.

url은 다운로드 또는 열기를 수행할 대상이 있는 웹 주소로써, 스키마(http, https)가 포함된 전체 URL이어야 한다.

이 속성은 downUrl과 동일하다.

eventUriStart

2.0.0.0 이상
설명

HD 응용프로그램을 사용하여 파일 다운로드를 이용할 때 사용되는 이벤트 주소를 나타내는 문자열이다.

이벤트 주소는 웹 주소로써, 스키마(http, https)가 포함된 전체 URL이어야 한다.

HD 응용프로그램은 항목을 다운로드할 때, 이 속성이 설정되어 있으면 다운로드를 수행하기 전에 eventUriStart 속성이 가리키는 주소로 GET 요청을 보낸다.

eventUriStop

2.0.0.0 이상
설명

HD 응용프로그램을 사용하여 파일 다운로드를 이용할 때 사용되는 이벤트 주소를 나타내는 문자열이다.

이벤트 주소는 웹 주소로써, 스키마(http, https)가 포함된 전체 URL이어야 한다.

HD 응용프로그램은 항목을 다운로드할 때, 이 속성이 설정되어 상태에서 다운로드가 중지되면 eventUriStop 속성이 가리키는 주소로 GET 요청을 보낸다. (오류로 인한 중지가 아니라, 사용자 액션에 의한 중지를 의미한다.)

eventUriEnd

2.0.0.0 이상
설명

HD 응용프로그램을 사용하여 파일 다운로드를 이용할 때 사용되는 이벤트 주소를 나타내는 문자열이다.

이벤트 주소는 웹 주소로써, 스키마(http, https)가 포함된 전체 URL이어야 한다.

HD 응용프로그램은 항목을 다운로드할 때, 이 속성이 설정되어 있으면, 다운로드가 완료된 후 eventUriEnd 속성이 가리키는 주소로 GET 요청을 보낸다.

chunkSize

2.0.0.0 이상
설명

HD 응용프로그램을 사용하여 파일 다운로드를 이용할 때 파일이 분할 되는 크기를 나타내는 숫자값이다.

HD 응용프로그램을 파일을 다운로드할 때, 한 요청으로 파일을 한 번에 다운로드하지 않고, 주어진 크기만큼 나눠서 다운로드를 수행한다. 파일을 나눠서 다운로드를 하면 파일 다운로드 시간은 조금 더 오래 걸릴 수 있지만, 서버를 좀 더 안정적으로 운영할 수 있다. 다운로드할 파일의 크기가 크다면 해당 파일이 다운로드 완료될 때까지 대역폭을 붙잡고 있기 때문에, 성능상 문제가 발생할 수 있다. 이런 경우에 파일을 분할하면, 서버로의 다운로드 요청이 나눠지기 때문에, 일부 사용자가 서버 리소스를 장시간 점유하는 현상이 줄어들게 된다.

지정이 되어 있지 않으면 -1 값으로 설정이 되며, -1 또는 0인 경우에는 파일을 분할하지 않고 하나의 요청으로 다 받는다. 더불어 분할 크기는 MB 단위로만 지정해야 한다.

hdTitle

2.1.2.0 이상
설명

HD 응용프로그램을 사용하여 파일 다운로드를 이용할 때 윈도우 타이틀에 출력되는 텍스트를 나타내는 문자열이다.

파일이 다운로드 될 때, HD 응용프로그램의 윈도우 타이틀 영역에 텍스트와 파일 이름이 출력되는데, 지정된 값이 없다면 제품 이름과 버전이 출력된다.