VaultConnection handles Vault login/logout operations and Vault folder mapping by setting user credentials, Vault Server parameters, and Vault folder to local folder mappings.
VaultConnectionMappingMixin
LightweightPart
AssemblyMixin
| Name | Type | Description |
|---|---|---|
| UserName | string | The username used to log into the vaule server; defaults to System.Environment.UserName |
| Password | string | The password for the specified UserName, default is "password" |
| AuthenticationFlags | name | Specifies the type of authentication; choices are :Standard (default), :Windows, :Anonymous, and :WindowsWithCredentials |
| ReadOnly? | boolean | Specifies whether the connection is read only, False by default. |
| Server | string | The Vault server name, default is "localhost" |
| Vault | string | The name of the Vault on the specified Server, "Vault" by default. |
| DiagnosticMessages? | boolean | When True , outputs diagnostic messages to the System Messages window; False by default. |
| Mapping | list | A list of lists to map Vault folder(s) to file system folder(s). By default, the root of the Vault ($) is mapped to C:\Users\<username>\Documents\Vault |
| Name | Type | Description |
|---|---|---|
| Test | list | Tests the Vault connection with the supplied parameters by returning a list of lists describing the Vault connection. |
GetAvailableVaults() As List
Returns a list of Vaults on the Server specified in the Server parameter
TestConnection() As Boolean
Opens and closes the Vault connection with the supplied connection parameters. If DiagnosticMessages? is True , pre- and post-connecting and closing events are written to the System Messages window. Always returns True .
EnumWorkingFolders() As List
Returns the list of working folders as defined by the supplied connection parameters.
SetMapping() As List
Sets the mapping based on the supplied connection parameters and returns the list of working folders.