Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Twoorb.FileSystem.FileServiceFTP Class Reference

File service extension for uploading files to an ftp server. More...

Inheritance diagram for Twoorb.FileSystem.FileServiceFTP:
Twoorb.FileSystem.FileService

Public Member Functions

override void UploadFile (string filePath, string fileName, string savePath, string saveName, FileSystemUploadEventHandler resultHandler)
 Uploads a file to the service More...
 
override void UploadDirectory (string uploadDirectory, string uploadPath, bool recursive, string searchPattern, FileSystemUploadEventHandler resultHandler)
 Uploads a directory to the service More...
 
override void DownloadFile (string filePath, string fileName, string savePath, string saveName, FileSystemDownloadEventHandler resultHandler)
 Download a file from the service More...
 
override void DownloadDirectory (string directoryPath, string savePath, bool recursive, string searchPattern, FileSystemDownloadEventHandler resultHandler)
 Download a directory from the service More...
 
override void GetDownloadUrl (string filePath, FileSystemGetDownloadUrlEventHandler eventHandler)
 Gets a download url to a specific file on the service More...
 
override void GetDownloadUrl (string filePath, FileSystemGetDownloadUrlWithFormEventHandler eventHandler)
 Gets a download url to a specific file on the service More...
 
- Public Member Functions inherited from Twoorb.FileSystem.FileService
virtual void InitializeService (ServiceSettings settings, FileSystemProgressUpdateEventHandler onProgressUpdate)
 Initialize the service More...
 
virtual void RunFileService ()
 Updates the file service More...
 
virtual void ListObjects (string path, FileSystemListObjectsEventHandler resultHandler)
 Lists objects that's in the specified path More...
 

Protected Member Functions

override void LoadSettings (ServiceSettings settings)
 Load the settings into the file system More...
 
override void UploadEnter ()
 The state callback for entering upload More...
 
override void UploadUpdate ()
 The state callback for updating upload More...
 
override void UploadLeave ()
 The state callback for leaving upload More...
 
override void DownloadEnter ()
 The state callback for entering download More...
 
override void DownloadUpdate ()
 The state callback for updating download More...
 
override void DownloadLeave ()
 The state callback for leaving download More...
 
override void UploadDirectoryEnter ()
 The state callback for entering UploadDirectory More...
 
override void UploadDirectoryUpdate ()
 The state callback for updating UploadDirectory More...
 
override void UploadDirectoryLeave ()
 The state callback for leaving UploadDirectory More...
 
override void DownloadDirectoryEnter ()
 The state callback for entering DownloadDirectory More...
 
override void DownloadDirectoryUpdate ()
 The state callback for updating DownloadDirectory More...
 
override void DownloadDirectoryLeave ()
 The state callback for leaving DownloadDirectory More...
 
- Protected Member Functions inherited from Twoorb.FileSystem.FileService
virtual void IdleEnter ()
 The state callback for when entering idle More...
 
virtual void IdleUpdate ()
 The state callback for updating idle More...
 
virtual void IdleLeave ()
 The state callback for leaving idle More...
 
void ActionComplete ()
 Sets the action to be complete and return the service to Idle-state More...
 

Additional Inherited Members

- Public Types inherited from Twoorb.FileSystem.FileService
enum  EServiceState {
  EServiceState.Idle, EServiceState.Upload, EServiceState.Download, EServiceState.UploadDirectory,
  EServiceState.DownloadDirectory
}
 The different states of the service. More...
 
enum  EOperationStatus {
  EOperationStatus.OpeningConnection, EOperationStatus.Downloading, EOperationStatus.DownloadComplete, EOperationStatus.Uploading,
  EOperationStatus.UploadComplete, EOperationStatus.OperationFailed, EOperationStatus.ClosingConnection
}
 The status of the current operations More...
 
- Protected Attributes inherited from Twoorb.FileSystem.FileService
FileSystemProgressUpdateEventHandler m_progressUpdateEvent = null
 The progress update event handler More...
 

Detailed Description

File service extension for uploading files to an ftp server.

Member Function Documentation

override void Twoorb.FileSystem.FileServiceFTP.DownloadDirectory ( string  directoryPath,
string  savePath,
bool  recursive,
string  searchPattern,
FileSystemDownloadEventHandler  resultHandler 
)
virtual

Download a directory from the service

Parameters
directoryPathThe path of the directory to download
savePathThe path of where the directory should be saved
recursive
searchPatternSearch prefix to filter the search for files to download
resultHandlerThe callback returning the success of the operation

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.DownloadDirectoryEnter ( )
protectedvirtual

The state callback for entering DownloadDirectory

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.DownloadDirectoryLeave ( )
protectedvirtual

The state callback for leaving DownloadDirectory

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.DownloadDirectoryUpdate ( )
protectedvirtual

The state callback for updating DownloadDirectory

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.DownloadEnter ( )
protectedvirtual

The state callback for entering download

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.DownloadFile ( string  filePath,
string  fileName,
string  savePath,
string  saveName,
FileSystemDownloadEventHandler  resultHandler 
)
virtual

Download a file from the service

Parameters
filePathThe path to the folder where the file to download resides
fileNameThe name of the file
savePathThe path to the folder where the file should be saved
saveNameTha name of the file to download
resultHandlerThe callback returning the success of the operation

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.DownloadLeave ( )
protectedvirtual

The state callback for leaving download

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.DownloadUpdate ( )
protectedvirtual

The state callback for updating download

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.GetDownloadUrl ( string  filePath,
FileSystemGetDownloadUrlEventHandler  eventHandler 
)
virtual

Gets a download url to a specific file on the service

Parameters
filePathThe path on the fileservice(key) to the file you want the url for
eventHandlerCallback returning the success of the operation along with the url

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.GetDownloadUrl ( string  filePath,
FileSystemGetDownloadUrlWithFormEventHandler  eventHandler 
)
virtual

Gets a download url to a specific file on the service

Parameters
filePathThe path on the fileservice(key) to the file you want the url for
eventHandlerCallback returning the success of the operation along with the url AND a hashtable with headers for authentication(if necessary)

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.LoadSettings ( ServiceSettings  settings)
protectedvirtual

Load the settings into the file system

Parameters
settings

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.UploadDirectory ( string  uploadDirectory,
string  uploadPath,
bool  recursive,
string  searchPattern,
FileSystemUploadEventHandler  resultHandler 
)
virtual

Uploads a directory to the service

Parameters
uploadDirectoryThe directory to upload
uploadPathThe path of where to save the file
recursiveIf subfolders and files should be included
searchPatternSearch prefix is the option to filter the search. If you only want to list objects in a specific folder, you set the folder name here to be added as a prefix to the search
resultHandlerThe callback returning the success of the operation

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.UploadDirectoryEnter ( )
protectedvirtual

The state callback for entering UploadDirectory

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.UploadDirectoryLeave ( )
protectedvirtual

The state callback for leaving UploadDirectory

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.UploadDirectoryUpdate ( )
protectedvirtual

The state callback for updating UploadDirectory

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.UploadEnter ( )
protectedvirtual

The state callback for entering upload

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.UploadFile ( string  filePath,
string  fileName,
string  savePath,
string  saveName,
FileSystemUploadEventHandler  resultHandler 
)
virtual

Uploads a file to the service

Parameters
filePathThe path to the folder where the file to upload resides
fileNameThe name of the file to upload
savePathThe path of where to save the file
saveNameThe name of the file once uploaded
resultHandlerThe callback returning the success of the operation

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.UploadLeave ( )
protectedvirtual

The state callback for leaving upload

Reimplemented from Twoorb.FileSystem.FileService.

override void Twoorb.FileSystem.FileServiceFTP.UploadUpdate ( )
protectedvirtual

The state callback for updating upload

Reimplemented from Twoorb.FileSystem.FileService.


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