Autodesk Vault ProfessionalVault API

LogIn(String,String,IAutodeskAccount,AuthenticationFlags,Func<String,LoginStates,Boolean>) Method

Autodesk.DataManagement.Client.Framework.Vault.ServicesIVaultConnectionManagerService

Create a new connection to a vault using an Autodesk Account.

Syntax

LogInResult LogIn(
   System.string serverName,
   System.string vaultName,
   IAutodeskAccount autodeskAccount,
   AuthenticationFlags authFlags,
   System.Func<string,LoginStates,bool> progressCallback
)
Overloads Function LogIn( _
   ByVal serverName As System.String, _
   ByVal vaultName As System.String, _
   ByVal autodeskAccount As IAutodeskAccount, _
   ByVal authFlags As AuthenticationFlags, _
   ByVal progressCallback As System.Func(Of String,LoginStates,Boolean) _
) As LogInResult

Parameters

NameDescription
serverNameThe name of the server
vaultNameThe name of the vault
autodeskAccountThe Autodesk account to authenticate with. This is only used for Autodesk Auth connections.
authFlagsAdditional options that control the type of connections that is being requested (ie. Read Only)
progressCallbackAn optional callback method that can be used to monitor the progress of the Log In operation. The method has a syntax of bool callBack(string message, Framework.Vault.Services.LoginStates state_enum). The implementation of the method should return false of the LogIn workflow should be cancelled. The message variable is a string representation of the current state of the log in. This can be used to update a status bar. The state_enum communicates what the log in workflow is currently executing. This can be used to write conditional logic based on what is currently being executed.

Return Value

An object which contains the new vault Connection, or any error conditions.

See Also