AcquireFilesSettings Class

Autodesk.DataManagement.Client.Framework.Vault›Autodesk.DataManagement.Client.Framework.Vault.Settings

Configuration options for the AcquireFiles workflow that is used to download and/or checkout files from the vault

Syntax

public class AcquireFilesSettings

Public Class AcquireFilesSettings

Name	Description
AcquireFilesSettings	Constructs an instance of the AcquireFileSettings class

Name	Description
CheckoutComment	Gets or sets the comment that will be applied to any files that are Checked Out.
DefaultAcquisitionOption	Gets or sets how files will be acquired (whether they are downloaded, checked out, or both).
LocalPath	The path where files will be downloaded to. If null then files will be downloaded to their working folders
OptionsExtensibility	Gets an object which contains handlers that can be used to augment the functionality of the Acquire Files workflow
OptionsRelationshipGathering	Gets options which can be used to configure how the relationships for entities added via AddEntityToAcquire are evaluated to see what additional files should be acquired
OptionsResolution	Gets an object which handles scenarios that need resolution. For example, what to do if a file exists, how to handle files not on the remote server, how to update out of date file references, etc.
OptionsThreading	Gets an object which allows for the configuration of the background processing.
OrganizeFilesRelativeToCommonVaultRoot	Gets or sets how files should be organized when downloaded to a LocalPath.
VaultConnection	Gets a connection to a vault server from which the files will be acquired

Name	Description
AddEntityToAcquire	Adds to the list of entities to be acquired. This may be an actual file, or a container object (ie. a folder) that contains files
AddEntityToAcquire(IEntity)	Adds to the list of entities to be acquired. This may be an actual file, or a container object (ie. a folder) that contains files
AddEntityToAcquire(IEnumerable<IEntity>)	Adds to the list of entities to be acquired. This may be a list of actual files, container objects (ie. a folder) that contains files, or a combination of both
AddFileToAcquire	Adds a file to the list of entities to be acquired.
AddFileToAcquire(FileIteration,AcquisitionOption)	Adds a file to the list of entities to be acquired.
AddFileToAcquire(FileIteration,AcquisitionOption,FilePathAbsolute)	Adds a file to the list of entities to be acquired.
AddFileToAcquire(FileIteration,AcquisitionOption,FolderPathAbsolute)	Adds a file to the list of entities to be acquired.
IsValidConfiguration	Tests if the AcquireFilesSettings object has been properly configured and that we can proceed with the file acquisition

Name	Description
PropertyChanged	Event fired when one of the options in this object are changed

System.Object
Autodesk.DataManagement.Client.Framework.Vault.Settings.AcquireFilesSettings
Autodesk.DataManagement.Client.Framework.Vault.Forms.Settings.ProgressAcquireFilesSettings