QtsHttp  0.9.4
Instance Methods | List of all members
<IQtsHttpFileStation > Protocol Reference

Interface for Qts Http file station API. More...

#import <QtsHttpFileStation.h>

Inheritance diagram for <IQtsHttpFileStation >:

Instance Methods

(void) - getShareFolderListWithCommunicationMode:cancel:success:fail:
 Get share folder list of QNAP Turbo NAS. More...
 
(void) - getFileListCountWithPath:communicationMode:cancel:success:fail:
 Get file list count below specify path. More...
 
(void) - getFileListWithPath:indexFrom:fileLimit:communicationMode:cancel:success:fail:
 Get file list below specify path. More...
 
(void) - uploadFileWithPath:toPath:communicationMode:cancel:success:fail:progress:
 Upload a file to QNAP Turbo NAS. More...
 
(void) - downloadFile:toPath:offset:communicationMode:cancel:success:fail:progress:
 Download a file to local. More...
 
(void) - downloadFileWithPath:toPath:offset:communicationMode:cancel:success:fail:progress:
 Download a file by path to local. More...
 
(void) - createShareLink:communicationMode:cancel:success:fail:
 Create share link. More...
 
(void) - getShareLinkListWithFileLimit:communicationMode:cancel:success:fail:
 Get share link list. More...
 
(void) - deleteShareLink:communicationMode:cancel:success:fail:
 Delete share link. More...
 
(void) - createFolderWithParentFolder:name:communicationMode:cancel:success:fail:
 Create a folder. More...
 
(void) - copyFile:toPath:mode:communicationMode:cancel:success:fail:progress:
 Copy a file/folder from source to destination. More...
 
(void) - moveFile:toPath:mode:communicationMode:cancel:success:fail:progress:
 Move a file/folder from source to destination. More...
 
(void) - deleteFile:communicationMode:cancel:success:fail:
 Delete a file/folder in QNAP Turbo NAS. More...
 
(void) - createFolderWithPath:name:communicationMode:cancel:success:fail:
 Create a folder by path. More...
 
(void) - copyFileWithPath:toPath:mode:communicationMode:cancel:success:fail:progress:
 Copy a file/folder by path from source to destination. More...
 
(void) - moveFileWithPath:toPath:mode:communicationMode:cancel:success:fail:progress:
 Move a file/folder by path from source to destination. More...
 
(void) - deleteFileWithPath:communicationMode:cancel:success:fail:
 Delete a file/folder by path in QNAP Turbo NAS. More...
 
(void) - searchFileWithKeyword:rootFolder:fileLimit:communicationMode:cancel:success:fail:
 File search. More...
 
(void) - getFileStatusWithPath:communicationMode:cancel:success:fail:
 Get file status. More...
 
(void) - createChunkedUploadIdWithPath:communicationMode:cancel:success:fail:
 Create chunked upload ID. More...
 
(void) - chunkedUploadFileWithPath:toPath:fileName:uploadID:uploadTempPath:communicationMode:cancel:success:fail:progress:
 Chunked upload a file to QNAP Turbo NAS. More...
 
(void) - deleteChunkedUploadFileWithId:uploadTempPath:communicationMode:cancel:success:fail:
 Delete chunked upload file by upload ID. More...
 
(void) - renameFileWithPath:fileName:communicationMode:cancel:success:fail:
 Rename a file/folder in QNAP Turbo NAS. More...
 
(void) - updateFileModifyDateWithFilePath:modifyTime:communicationMode:cancel:success:fail:
 Set folder/file modification time. More...
 
(void) - compressFilesName:path:numberOfFiles:fileList:compressType:password:compressLevel:compressEncryrtType:compressUpdateMode:communicationMode:cancel:success:fail:
 Compress files. More...
 
(void) - ListContentsOfExtractedFilePath:start:limit:communicationMode:cancel:success:fail:
 List the contents of an extracted file. More...
 
(void) - ExtractFiles:toPath:password:exractMode:partTotalFileCount:partFileList:overwrite:extractPathMode:communicationMode:cancel:success:fail:
 Extract files. More...
 
(void) - getDomainIPListWithCommunicationMode:cancel:success:fail:
 Get hostname and external IP address of the QNAP Turbo NAS. More...
 
(void) - addVideoTranscodeWithFilePath:communicationMode:cancel:success:fail:
 Add video to transcode queue. More...
 
(void) - deleteVideoTranscodeWithFilePath:communicationMode:cancel:success:fail:
 Delete video transcode file. More...
 
(void) - getFileURLWithFilePath:cancel:success:fail:
 Get file URL. More...
 
(void) - getImgThumbURLWithFilePath:cancel:success:fail:
 Get image thumbnail of file. More...
 
(void) - getImgThumbURLWithFilePath:thumbnailSize:cancel:success:fail:
 
(void) - getImgThumbURLWithFilePath:isSSL:thumbnailSize:cancel:success:fail:
 
(void) - getImgThumbURLWithFile:thumbnailSize:cancel:success:fail:
 
(void) - getImgThumbURLWithFile:isSSL:thumbnailSize:cancel:success:fail:
 
(void) - downloadImgThumbWithFile:toPath:thumbnailSize:communicationMode:cancel:success:fail:progress:
 

Detailed Description

Interface for Qts Http file station API.

  1. Support file station related API.

Method Documentation

◆ addVideoTranscodeWithFilePath:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ chunkedUploadFileWithPath:toPath:fileName:uploadID:uploadTempPath:communicationMode:cancel:success:fail:progress:()

- (void IQtsHttpFileStation) 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.

◆ compressFilesName:path:numberOfFiles:fileList:compressType:password:compressLevel:compressEncryrtType:compressUpdateMode:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) compressFilesName: (NSString *)  compressName
path: (NSString *)  compressFilePath
numberOfFiles: (int)  totalFileNum
fileList: (NSMutableArray *)  fileList
compressType: (QTS_HTTP_FILE_STATION_COMPRESS_FORMAT_TYPE)  compressFormat
password: (NSString *)  password
compressLevel: (QTS_HTTP_FILE_STATION_COMPRESS_LEVEL)  compressLevel
compressEncryrtType: (QTS_HTTP_FILE_STATION_COMPRESS_ENCRYPT_TYPE)  encryptType
compressUpdateMode: (QTS_HTTP_FILE_STATION_COMPRESS_UPDATE_MODE)  updateMode
communicationMode: (BOOL)  isAsync
cancel: (int *)  isCancel
success: (void(^)(QTS_RESPONSE_CTX *response))  success
fail: (void(^)(QTS_HTTP_API_RESULTS error))  fail 
optional

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.

◆ copyFile:toPath:mode:communicationMode:cancel:success:fail:progress:()

- (void IQtsHttpFileStation) 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.

◆ copyFileWithPath:toPath:mode:communicationMode:cancel:success:fail:progress:()

- (void IQtsHttpFileStation) 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.

◆ createChunkedUploadIdWithPath:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ createFolderWithParentFolder:name:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ createFolderWithPath:name:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ createShareLink:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) createShareLink: (QNQtsHttpShareLinkInfo *)  shareLinkInfo
communicationMode: (BOOL)  isAsync
cancel: (int *)  isCancel
success: (void(^)(QTS_RESPONSE_CTX *response))  success
fail: (void(^)(QTS_HTTP_API_RESULTS error))  fail 
optional

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.

◆ deleteChunkedUploadFileWithId:uploadTempPath:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ deleteFile:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) deleteFile: (QNQtsHttpFileEntry *)  fileEntry
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 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.

◆ deleteFileWithPath:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ deleteShareLink:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) deleteShareLink: (QNQtsHttpShareLink *)  shareLink
communicationMode: (BOOL)  isAsync
cancel: (int *)  isCancel
success: (void(^)(QTS_RESPONSE_CTX *response))  success
fail: (void(^)(QTS_HTTP_API_RESULTS error))  fail 
optional

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.

◆ deleteVideoTranscodeWithFilePath:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ downloadFile:toPath:offset:communicationMode:cancel:success:fail:progress:()

- (void IQtsHttpFileStation) 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.

◆ downloadFileWithPath:toPath:offset:communicationMode:cancel:success:fail:progress:()

- (void IQtsHttpFileStation) 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.

◆ ExtractFiles:toPath:password:exractMode:partTotalFileCount:partFileList:overwrite:extractPathMode:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) ExtractFiles: (QNQtsHttpFileEntry *)  extractedFile
toPath: (NSString *)  toPath
password: (NSString *)  password
exractMode: (QTS_HTTP_FILE_STATION_EXTRACT_MODE)  extractMode
partTotalFileCount: (int)  partTotalFileCount
partFileList: (NSMutableArray *)  partFileList
overwrite: (QTS_HTTP_FILE_STATION_OVERWRITE)  overWrite
extractPathMode: (QTS_HTTP_FILE_STATION_EXTRACT_PATH_MODE)  extractPathMode
communicationMode: (BOOL)  isAsync
cancel: (int *)  isCancel
success: (void(^)(QTS_RESPONSE_CTX *response))  success
fail: (void(^)(QTS_HTTP_API_RESULTS error))  fail 
optional

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.

◆ getDomainIPListWithCommunicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ getFileListCountWithPath:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.
Remarks
File list count include files and folders.

◆ getFileListWithPath:indexFrom:fileLimit:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.
Remarks
File list include files and folders.

◆ getFileStatusWithPath:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ getFileURLWithFilePath:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ getImgThumbURLWithFilePath:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ getShareFolderListWithCommunicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ getShareLinkListWithFileLimit:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ ListContentsOfExtractedFilePath:start:limit:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ moveFile:toPath:mode:communicationMode:cancel:success:fail:progress:()

- (void IQtsHttpFileStation) 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.

◆ moveFileWithPath:toPath:mode:communicationMode:cancel:success:fail:progress:()

- (void IQtsHttpFileStation) 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.

◆ renameFileWithPath:fileName:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ searchFileWithKeyword:rootFolder:fileLimit:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ updateFileModifyDateWithFilePath:modifyTime:communicationMode:cancel:success:fail:()

- (void IQtsHttpFileStation) 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.

◆ uploadFileWithPath:toPath:communicationMode:cancel:success:fail:progress:()

- (void IQtsHttpFileStation) 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: