Interface for Qts Http file station API.
More...
#import <QtsHttpFileStation.h>
Interface for Qts Http file station API.
- Support file station related API.
Definition at line 295 of file QtsHttpFileStation.h.
- (void) addVideoTranscodeWithFilePath: |
|
(NSString *) |
filePath |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Add video to transcode queue.
- Parameters
-
[IN] | filePath : Add video file path in QNAP Turbo NAS. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) chunkedUploadFileWithPath: |
|
(NSString *) |
uploadFilePath |
toPath: |
|
(NSString *) |
toFilePath |
fileName: |
|
(NSString *) |
renameOriDestFileName |
uploadID: |
|
(NSString *) |
uploadID |
uploadTempPath: |
|
(NSString *) |
uploadTempPath |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
progress: |
|
(void(^)(int rateOfUploading, unsigned long long bytesOfUploading)) |
block |
|
|
| |
|
optional |
Chunked upload a file to QNAP Turbo NAS.
- Parameters
-
[IN] | uploadFilePath : Local path of chunked upload file. |
[IN] | toFilePath : Destination path in QNAP Turbo NAS. |
[IN] | renameOriDestFileName : Rename original destination file to strRenameOriDestFileName, if file already exist. |
[IN] | uploadID : Chunked upload ID. Get from CreateChunkedUploadID. |
[IN] | uploadTempPath : Where to put temp file in QTS Turbo NAS. The same as CreateChunkedUploadID. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
[BLOCK] | block : block to retrieve upload progress. |
- Returns
- QTS_HTTP_API_RESULTS : API success or fail error code.
Compress files.
- Parameters
-
[IN] | compressName :Compressed name. |
[IN] | compressFilePath : Compressd file path. |
[IN] | totalFileNum : The amount of compression files number. |
[IN] | fileList : The compressed file name list. |
[IN] | compressFormat : Compressed format. |
[IN] | password : Compressed password (can be null). |
[IN] | compressLevel : Compressed level. |
[IN] | encryptType : Compressed encrypt type. |
[IN] | updateMode : Compressed update mode. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- QTS_HTTP_API_RESULTS : API success or fail error code.
- (void) copyFile: |
|
(QNQtsHttpFileEntry *) |
fileEntry |
toPath: |
|
(NSString *) |
toPath |
mode: |
|
(int) |
mode |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
progress: |
|
(void(^)(int rateOfCopy)) |
block |
|
|
| |
|
optional |
Copy a file/folder from source to destination.
- Parameters
-
[IN] | fileEntry : Source entry in QNAP Turbo NAS. |
[IN] | toPath : Destination path in QNAP Turbo NAS. |
[IN] | mode : Skip / Overwrite. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
[BLOCK] | block : block to retrieve copy progress. |
- Returns
- n/a.
- (void) copyFileWithPath: |
|
(NSString *) |
fromPath |
toPath: |
|
(NSString *) |
toPath |
mode: |
|
(int) |
mode |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
progress: |
|
(void(^)(int rateOfCopy)) |
block |
|
|
| |
|
optional |
Copy a file/folder by path from source to destination.
- Parameters
-
[IN] | fromPath : Source full path in QNAP Turbo NAS. |
[IN] | toPath : Destination path in QNAP Turbo NAS. |
[IN] | mode : Skip / Overwrite. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
[BLOCK] | block : block to retrieve copy progress. |
- Returns
- n/a.
- (void) createChunkedUploadIdWithPath: |
|
(NSString *) |
uploadTempPath |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Create chunked upload ID.
- Parameters
-
[IN] | uploadTempPath : Where to put temp file in QTS Turbo NAS. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. QTS_RESPONSE_CTX's response will store upload_id with upload_id tag. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) createFolderWithParentFolder: |
|
(QNQtsHttpFileEntry *) |
parentFolderEntry |
name: |
|
(NSString *) |
folderName |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Create a folder.
- Parameters
-
[IN] | parentFolderEntry : Create a folder below parentFolderEntry. |
[IN] | folderName : Create folder name. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) createFolderWithPath: |
|
(NSString *) |
folderPath |
name: |
|
(NSString *) |
folderName |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Create a folder by path.
- Parameters
-
[IN] | folderPath : Create a folder at this path. |
[IN] | folderName : Create folder name. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
Create share link.
- Parameters
-
[IN] | shareLinkInfo : Setting of create share link. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. QTS_RESPONSE_CTX's response will store QNQtsHttpShareLink class |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) deleteChunkedUploadFileWithId: |
|
(NSString *) |
uploadID |
uploadTempPath: |
|
(NSString *) |
uploadTempPath |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Delete chunked upload file by upload ID.
- Parameters
-
[IN] | uploadID : Chunked upload ID. Get from CreateChunkedUploadID. |
[IN] | uploadTempPath : Where to put temp file in QTS Turbo NAS. The same as CreateChunkedUploadID. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
Delete a file/folder in QNAP Turbo NAS.
- Parameters
-
[IN] | fileEntry : Delete entry in QNAP Turbo NAS. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) deleteFileWithPath: |
|
(NSString *) |
filePath |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Delete a file/folder by path in QNAP Turbo NAS.
- Parameters
-
[IN] | filePath : Delete full path in QNAP Turbo NAS. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
Delete share link.
- Parameters
-
[IN] | shareLink : Share link on QNAP Turbo NAS. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) deleteVideoTranscodeWithFilePath: |
|
(NSString *) |
filePath |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Delete video transcode file.
- Parameters
-
[IN] | filePath : Delete video file path in QNAP Turbo NAS. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- QTS_HTTP_API_RESULTS : API success or fail error code.
- (void) downloadFile: |
|
(QNQtsHttpFileEntry *) |
fileEntry |
toPath: |
|
(NSString *) |
toFilePath |
offset: |
|
(long) |
offset |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
progress: |
|
(void(^)(int rateOfDownloading, unsigned long long bytesOfDownloading)) |
block |
|
|
| |
|
optional |
Download a file to local.
- Parameters
-
[IN] | fileEntry : Download file entry in QNAP Turbo NAS. |
[IN] | toFilePath : Destination path in local. |
[IN] | offset : Resume download from offset. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
[BLOCK] | block : block to retrieve download progress rate and received bytes. |
- Returns
- n/a.
- (void) downloadFileWithPath: |
|
(NSString *) |
path |
toPath: |
|
(NSString *) |
toFilePath |
offset: |
|
(long) |
offset |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
progress: |
|
(void(^)(int rateOfDownloading, unsigned long long bytesOfDownloadloading)) |
block |
|
|
| |
|
optional |
Download a file by path to local.
- Parameters
-
[IN] | path : Download file full path in QNAP Turbo NAS. |
[IN] | toFilePath : Destination path in local. |
[IN] | offset : Resume download from offset. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
[BLOCK] | block : block to retrieve download progress rate and received bytes. |
- Returns
- QTS_HTTP_API_RESULTS : API success or fail error code.
Extract files.
- Parameters
-
[IN] | extractedFile : Extracted file object in QTS Turbo NAS. |
[IN] | toPath : Path of the extracted files. |
[IN] | password : Extraction password (can be null). |
[IN] | extractMode : Extraction mode. |
[IN] | partTotalFileCount : The total number of extracted files, if extractMode = QTS_EXTRACT_MODE_PART. |
[IN] | partFileList : Name of the file to be extracted (can be more than one), if extractMode = QTS_EXTRACT_MODE_PART. |
[IN] | overWrite : Skip / Overwrite. |
[IN] | extractPathMode : Extracted path mode. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) getDomainIPListWithCommunicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Get hostname and external IP address of the QNAP Turbo NAS.
- Parameters
-
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. QTS_RESPONSE_CTX's response will store list of QNQtsHttpNASInfo objects |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- QTS_HTTP_API_RESULTS : API success or fail error code.
- (void) getFileListCountWithPath: |
|
(NSString *) |
path |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Get file list count below specify path.
- Parameters
-
[IN] | path : Specify folder path. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. QTS_RESPONSE_CTX's response will store count with total tag. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) getFileListWithPath: |
|
(NSString *) |
path |
indexFrom: |
|
(int) |
startIdx |
fileLimit: |
|
(int) |
fileLimit |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Get file list below specify path.
- Parameters
-
[IN] | path : Specify folder path. |
[IN] | startIdx : Start index of get files. |
[IN] | fileLimit : Number of get files. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. QTS_RESPONSE_CTX's response will store list of QNQtsHttpFileStatus class. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) getFileStatusWithPath: |
|
(NSString *) |
filePath |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Get file status.
- Parameters
-
[IN] | filePath :File full path in QNAP Turbo NAS. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. QTS_RESPONSE_CTX's response will store QNQtsHttpFileStatus objects. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) getFileURLWithFilePath: |
|
(NSString *) |
fileFullPath |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Get file URL.
- Parameters
-
[IN] | fileFullPath : File full path. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. QTS_RESPONSE_CTX's response will store file URL. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) getImgThumbURLWithFilePath: |
|
(NSString *) |
fileFullPath |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Get image thumbnail of file.
- Parameters
-
[IN] | fileFullPath : File full path. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. QTS_RESPONSE_CTX's response will store image thumv URL. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) getShareFolderListWithCommunicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Get share folder list of QNAP Turbo NAS.
[IN] isAsync : Execute API by Synchronized or Asynchronized Mode.
- Parameters
-
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. QTS_RESPONSE_CTX's response will store list of QNQtsHttpFileEntry class. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) getShareLinkListWithFileLimit: |
|
(int) |
fileLimit |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Get share link list.
- Parameters
-
[IN] | fileLimit : Number of share link list. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. QTS_RESPONSE_CTX's response will store list of QNQtsHttpShareLink class |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) ListContentsOfExtractedFilePath: |
|
(NSString *) |
filePath |
start: |
|
(int) |
startIdx |
limit: |
|
(int) |
fileLimit |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
List the contents of an extracted file.
- Parameters
-
[IN] | filePath :Extracted file full path in QTS Turbo NAS. |
[IN] | startIdx : Response files start index. |
[IN] | fileLimit : Number of response files. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. QTS_RESPONSE_CTX's response will store list of QNQtsHttpExtractEntry objects. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) moveFile: |
|
(QNQtsHttpFileEntry *) |
fileEntry |
toPath: |
|
(NSString *) |
toPath |
mode: |
|
(int) |
mode |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
progress: |
|
(void(^)(int rateOfMove)) |
block |
|
|
| |
|
optional |
Move a file/folder from source to destination.
- Parameters
-
[IN] | fileEntry : Source entry in QNAP Turbo NAS. |
[IN] | toPath : Destination path in QNAP Turbo NAS. |
[IN] | mode : Skip / Overwrite. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
[BLOCK] | block : block to retrieve move progress. |
- Returns
- n/a.
- (void) moveFileWithPath: |
|
(NSString *) |
fromPath |
toPath: |
|
(NSString *) |
toPath |
mode: |
|
(int) |
mode |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
progress: |
|
(void(^)(int rateOfMove)) |
block |
|
|
| |
|
optional |
Move a file/folder by path from source to destination.
- Parameters
-
[IN] | fromPath : Source full path in QNAP Turbo NAS. |
[IN] | toPath : Destination path in QNAP Turbo NAS. |
[IN] | mode : Skip / Overwrite. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
[BLOCK] | block : block to retrieve move progress. |
- Returns
- n/a.
- (void) renameFileWithPath: |
|
(NSString *) |
filePath |
fileName: |
|
(NSString *) |
newName |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Rename a file/folder in QNAP Turbo NAS.
- Parameters
-
[IN] | filePath : Rename file path. |
[IN] | newName : New folder/file name. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) searchFileWithKeyword: |
|
(NSString *) |
keyword |
rootFolder: |
|
(NSString *) |
folderPath |
fileLimit: |
|
(int) |
fileLimit |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
File search.
- Parameters
-
[IN] | folderPath :Search file path in QNAP Turbo NAS. |
[IN] | keyword : Query keyword. |
[IN] | fileLimit : Number of response file list. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. QTS_RESPONSE_CTX's response will store list of QNQtsHttpFileEntry objects. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) updateFileModifyDateWithFilePath: |
|
(NSString *) |
filePath |
modifyTime: |
|
(long) |
modifyTime |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
|
|
| |
|
optional |
Set folder/file modification time.
- Parameters
-
[IN] | filePath : Update file path. |
[IN] | modifyTime : Epoch time (seconds since 1970-01-01 00:00:00 UTC). |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
- Returns
- n/a.
- (void) uploadFileWithPath: |
|
(NSString *) |
fromFilePath |
toPath: |
|
(NSString *) |
toFilePath |
communicationMode: |
|
(BOOL) |
isAsync |
cancel: |
|
(int *) |
isCancel |
success: |
|
(void(^)(QTS_RESPONSE_CTX *response)) |
success |
fail: |
|
(void(^)(QTS_HTTP_API_RESULTS error)) |
fail |
progress: |
|
(void(^)(int rateOfUploading, unsigned long long bytesOfUploading)) |
block |
|
|
| |
|
optional |
Upload a file to QNAP Turbo NAS.
- Parameters
-
[IN] | fromFilePath : Local path of upload file. |
[IN] | toFilePath : Destination path in QNAP Turbo NAS. |
[IN] | isAsync : Execute API by Synchronized or Asynchronized Mode. |
[IN] | isCancel : Cancel API. |
[BLOCK] | success : block to retrieve QTS_RESPONSE_CTX class when API was executed successfully. |
[BLOCK] | fail : block to retrieve error code when API was executed failurely. |
[BLOCK] | block : block to retrieve upload progress rate and sending bytes. |
- Returns
- n/a.
The documentation for this protocol was generated from the following file: