C# Class CmisSync.SetupController

MVC controller for the two wizards: - CmisSync tutorial that appears at firt run, - wizard to add a new remote folder.

Mostra file Open project: aegif/CmisSync Class Usage Examples

Public Properties

Property	Type	Description
ignoredPaths	List
repositories	string>.Dictionary
saved_address	System.Uri
saved_password	string
saved_remote_path	string
saved_repository	string
saved_sync_interval	int
saved_syncatstartup	bool
saved_user	string

Public Methods

Method	Description
Add1PageCompleted ( Uri address, string user, string password ) : void	First step of remote folder addition wizard is complete, switch to second step
Add2PageCompleted ( string repository, string remote_path ) : void	Second step of remote folder addition wizard is complete, switch to customization step.
Add2PageCompleted ( string repository, string remote_path, string ignoredPaths, string selectedFolder ) : void	Second step of remote folder addition wizard is complete, switch to customization step.
BackToPage1 ( ) : void	Switch back from second to first step, presumably to change server or user.
BackToPage2 ( ) : void	Switch back from customization to step 2 of the remote folder addition wizard.
CheckAddPage ( string address ) : string	Check whether the address is syntaxically valid. If OK, enable button to next step.
CheckRepoPathAndName ( string localpath, string reponame ) : string	Check local repository path and repo name.
CheckRepoPathExists ( string localpath ) : void
CheckSetupPage ( ) : void	Check setup page.
CustomizePageCompleted ( String repoName, String localrepopath ) : void	Customization step of remote folder addition wizard is complete, start CmisSync.
FinishPageCompleted ( ) : void	Folder addition wizard is over, reset it for next use.
GetRepositoriesFuzzy ( ServerCredentials credentials ) : Exception>.Tuple	Load repositories information from a CMIS endpoint.
GetSubfolders ( string repositoryId, string path, string address, string user, string password ) : string[]	Get the list of subfolders contained in a CMIS folder.
OpenFolderClicked ( ) : void	User clicked on the button to open the newly-created synchronized folder in the local file explorer.
PageCancelled ( ) : void	User pressed the "Cancel" button, hide window.
SettingsPageCompleted ( string password, int pollInterval, bool syncAtStartup ) : void	Repository settings page.
SetupController ( ) : System	Constructor.
SetupPageCancelled ( ) : void	First-time wizard has been cancelled, so quit CmisSync.
SetupPageCompleted ( ) : void	Move to second page of the tutorial.
StartupItemChanged ( bool create_startup_item ) : void	Checkbox to add CmisSync to the list of programs to be started up when the user logs into Windows.
TutorialPageCompleted ( ) : void	Go to next step of the tutorial.
TutorialSkipped ( ) : void	Tutorial has been skipped, go to last step of wizard.

Method Details

Add1PageCompleted() public method

First step of remote folder addition wizard is complete, switch to second step

public Add1PageCompleted ( Uri address, string user, string password ) : void
address	System.Uri
user	string
password	string
return	void

Add2PageCompleted() public method

Second step of remote folder addition wizard is complete, switch to customization step.

public Add2PageCompleted ( string repository, string remote_path ) : void
repository	string
remote_path	string
return	void

Add2PageCompleted() public method

Second step of remote folder addition wizard is complete, switch to customization step.

public Add2PageCompleted ( string repository, string remote_path, string ignoredPaths, string selectedFolder ) : void
repository	string
remote_path	string
ignoredPaths	string
selectedFolder	string
return	void

BackToPage1() public method

Switch back from second to first step, presumably to change server or user.

public BackToPage1 ( ) : void
return	void

BackToPage2() public method

Switch back from customization to step 2 of the remote folder addition wizard.

public BackToPage2 ( ) : void
return	void

CheckAddPage() public method

Check whether the address is syntaxically valid. If OK, enable button to next step.

public CheckAddPage ( string address ) : string
address	string	URL to check
return	string

CheckRepoPathAndName() public method

Check local repository path and repo name.

public CheckRepoPathAndName ( string localpath, string reponame ) : string
localpath	string
reponame	string
return	string

CheckRepoPathExists() public method

public CheckRepoPathExists ( string localpath ) : void
localpath	string
return	void

CheckSetupPage() public method

Check setup page.

public CheckSetupPage ( ) : void
return	void

CustomizePageCompleted() public method

Customization step of remote folder addition wizard is complete, start CmisSync.

public CustomizePageCompleted ( String repoName, String localrepopath ) : void
repoName	String
localrepopath	String
return	void

FinishPageCompleted() public method

Folder addition wizard is over, reset it for next use.

public FinishPageCompleted ( ) : void
return	void

GetRepositoriesFuzzy() static public method

Load repositories information from a CMIS endpoint.

static public GetRepositoriesFuzzy ( ServerCredentials credentials ) : Exception>.Tuple
credentials	CmisSync.Lib.Config.ServerCredentials
return	Exception>.Tuple

GetSubfolders() static public method

Get the list of subfolders contained in a CMIS folder.

static public GetSubfolders ( string repositoryId, string path, string address, string user, string password ) : string[]
repositoryId	string
path	string
address	string
user	string
password	string
return	string[]

OpenFolderClicked() public method

User clicked on the button to open the newly-created synchronized folder in the local file explorer.

public OpenFolderClicked ( ) : void
return	void

PageCancelled() public method

User pressed the "Cancel" button, hide window.

public PageCancelled ( ) : void
return	void

SettingsPageCompleted() public method

Repository settings page.

public SettingsPageCompleted ( string password, int pollInterval, bool syncAtStartup ) : void
password	string
pollInterval	int
syncAtStartup	bool
return	void

SetupController() public method

Constructor.

public SetupController ( ) : System
return	System

SetupPageCancelled() public method

First-time wizard has been cancelled, so quit CmisSync.

public SetupPageCancelled ( ) : void
return	void

SetupPageCompleted() public method

Move to second page of the tutorial.

public SetupPageCompleted ( ) : void
return	void

StartupItemChanged() public method

Checkbox to add CmisSync to the list of programs to be started up when the user logs into Windows.

public StartupItemChanged ( bool create_startup_item ) : void
create_startup_item	bool
return	void

TutorialPageCompleted() public method

Go to next step of the tutorial.

public TutorialPageCompleted ( ) : void
return	void

TutorialSkipped() public method

Tutorial has been skipped, go to last step of wizard.

public TutorialSkipped ( ) : void
return	void

Property Details

ignoredPaths public_oe property

Ignored paths.

public List ignoredPaths
return	List

repositories public_oe property

List of the CMIS repositories at the chosen URL.

public Dictionary repositories
return	string>.Dictionary

saved_address public_oe property

Saved address.

public Uri,System saved_address
return	System.Uri

saved_password public_oe property

Saved password.

public string saved_password
return	string

saved_remote_path public_oe property

Saved remote path.

public string saved_remote_path
return	string

saved_repository public_oe property

Saved repository.

public string saved_repository
return	string

saved_sync_interval public_oe property

Saved sync interval.

public int saved_sync_interval
return	int

saved_syncatstartup public_oe property

Saved sync at startup

public bool saved_syncatstartup
return	bool

saved_user public_oe property

Saved user.

public string saved_user
return	string