QtsHttp  0.9.1
Public Member Functions | List of all members
QtsHttp.FileStaion.IRequestBase Interface Reference

Interface for file station request base. More...

Public Member Functions

bool Abort ()
 Developer can abort file station API by calling Abort() anytime. More...
 
int ResponseFileListCount ()
 Get file list count after GetFileListCountAsync API success. More...
 
List< FileEntryResponseFileList ()
 Get file list after GetShareFolderListAsync/GetFileListAsync/SearchFileAsync API success. More...
 
List< ExtractEntryResponseExtractFileList ()
 Get extract file list after ListContentsOfExtractedFileAsync API success. More...
 
ShareLink ResponseShareLink ()
 Get share link after CreateShareLinkAsync API success. More...
 
List< ShareLinkResponseShareLinkList ()
 Get share link list after GetShareLinkListAsync API success. More...
 
FileStatus ResponseFileStatus ()
 Get file/folder status after GetFileStatusAsync API success. More...
 
NASInfo ResponseNASInfo ()
 Get hostname and external IP address of the QNAP Turbo NAS after GetDomainIPListAsync API success. More...
 
string ResponseChunkUploadID ()
 Get chunked upload ID after CreateChunkedUploadIDAsync API success. More...
 
Stream ResponseDownloadStream ()
 Get download file stream after DownloadFileAsync API success. More...
 

Detailed Description

Interface for file station request base.

  1. One file station API maps to one file station request.
  2. Abort FS request.
  3. Get response from file station API.

Member Function Documentation

bool QtsHttp.FileStaion.IRequestBase.Abort ( )

Developer can abort file station API by calling Abort() anytime.

Returns
true : Abort success.
false : Abort fail.
string QtsHttp.FileStaion.IRequestBase.ResponseChunkUploadID ( )

Get chunked upload ID after CreateChunkedUploadIDAsync API success.

Returns
string : Output chunked upload ID.
Stream QtsHttp.FileStaion.IRequestBase.ResponseDownloadStream ( )

Get download file stream after DownloadFileAsync API success.

Returns
Stream : Download file stream.
List<ExtractEntry> QtsHttp.FileStaion.IRequestBase.ResponseExtractFileList ( )

Get extract file list after ListContentsOfExtractedFileAsync API success.

Returns
List<ExtractEntry> : Output extract file list.
List<FileEntry> QtsHttp.FileStaion.IRequestBase.ResponseFileList ( )

Get file list after GetShareFolderListAsync/GetFileListAsync/SearchFileAsync API success.

Returns
List<FileEntry> : Output file list.
int QtsHttp.FileStaion.IRequestBase.ResponseFileListCount ( )

Get file list count after GetFileListCountAsync API success.

Returns
int : Output file list count.
FileStatus QtsHttp.FileStaion.IRequestBase.ResponseFileStatus ( )

Get file/folder status after GetFileStatusAsync API success.

Returns
FileStatus : Output file/folder status.
NASInfo QtsHttp.FileStaion.IRequestBase.ResponseNASInfo ( )

Get hostname and external IP address of the QNAP Turbo NAS after GetDomainIPListAsync API success.

Returns
QtsHttpNASInfo : Output hostname and external IP address.
ShareLink QtsHttp.FileStaion.IRequestBase.ResponseShareLink ( )

Get share link after CreateShareLinkAsync API success.

Returns
ShareLink : Output share link.
List<ShareLink> QtsHttp.FileStaion.IRequestBase.ResponseShareLinkList ( )

Get share link list after GetShareLinkListAsync API success.

Returns
List<ShareLink> : Output share link list.

The documentation for this interface was generated from the following file: