IVaultConnectionManagerService Interface
Autodesk.DataManagement.Client.Framework.Vault›Autodesk.DataManagement.Client.Framework.Vault.Services
This service encapsulates all connections to a vault server.
Syntax
public interface IVaultConnectionManagerService Public Interface IVaultConnectionManagerService Methods
| Name | Description |
|---|---|
| ChangeVaultAccountPassword | API to change vault account password |
| CloseAllConnections | Logs out of all existing open connections to the server. |
| GetAvailableVaults | Retrieves a list of all of the vaults on a particular server. |
| GetExistingConnection | Attempts to get a connection object for an already existing connection |
| GetPasswordPolicySetting | API to get PasswordPolicySetting |
| GetSiteCompatibilityWithVault | Tests a site (a server location in a multi site environment) to make sure it is compatible with the master vault database. Compatibility problems could arise if the site is updated but the database wasn't, or vice versa) |
| IsProductSupported | Tests if a vault server has the capabilities to support a specific server product. |
| LogIn | Create a new connection to a vault. Username/PW are ignored for WinAuth and Anonymous connections |
| LogIn(String,String,String,String,AuthenticationFlags,Func<String,LoginStates,Boolean>) | Create a new connection to a vault. Username/PW are ignored for WinAuth and Anonymous connections |
| LogIn(String,String,IAutodeskAccount,AuthenticationFlags,Func<String,LoginStates,Boolean>) | Create a new connection to a vault using an Autodesk Account. |
| LogInWithUserLicense | Create a new connection to a vault. Username/PW are ignored for WinAuth and Anonymous connections |
| LogInWithUserLicense(String,String,String,String,String,AuthenticationFlags,Func<String,LoginStates,Boolean>) | Create a new connection to a vault. Username/PW are ignored for WinAuth and Anonymous connections |
| LogInWithUserLicense(String,String,IAutodeskAccount,AuthenticationFlags,Func<String,LoginStates,Boolean>) | Create a new connection to a vault using an Autodesk Account. |
| LogOut | Log out of a connection to the vault |
| SetProductRequirements | Configures the application requirements for the various known server products. For each product, the app can configure if the product is Required, Optional, or Restricted. |
Events
| Name | Description |
|---|---|
| ConnectionEstablished | This event fires every time a successful login occurs to a vault |
| ConnectionReleased | This event fires when the user logs out of an existing connection |
| ConnectionReused | This event fires if a connection is reused. A connection is reused when an attempt is made to login to a server/vault/user combination where a connection is already established. In that case, we will just return the existing connection |
Returned By
Where you get a IVaultConnectionManagerService — members that return one.