Autodesk Vault ProfessionalVault API

UpdateFileReferencesModel Class

Autodesk.DataManagement.Client.Framework.VaultAutodesk.DataManagement.Client.Framework.Vault.Models.ExtensionHandlers

This model manages the workflow of updating file references via Autodesk.DataManagement.Client.Framework.Vault.Interfaces.ExtensionHandlers.IFileReferencesProvider.UpdateReferences for a specific type of file

Syntax

public class UpdateFileReferencesModel 
Public Class UpdateFileReferencesModel 

Constructors

NameDescription
UpdateFileReferencesModelConstructs a UpdateFileReferencesModel object

Properties

NameDescription
FileNewAndUnsavedGets whether or not the file is new and never saved in the parent application. If so, the extension handler looks it up in the parent application rather than on disk.
FileOpenedGets whether or not the file is already opened by the parent application. If so, extension handler does not need to open or close the file.
PropertiesGets an optional bag of properties which can be used by the handler to determine how it should interpret the references
SourceFileGets the file that is having it's references updated
VaultConnectionGets the Vault Connection that the Update File Reference work flow is associated with.

Methods

NameDescription
GetReferenceGets a specific reference from the model
GetStatusGets the update status of a file reference.
GetUnprocessedReferencesGets a list of all references that have not yet been processed
SetUpdateReferenceResultUpdates the model with the results of how a particular reference was updated

Fields

NameDescription
RefIdFailureA special value for a Reference ID which signifies that a reference is broken.
RefIdIgnoreA special value for a Reference ID which signifies that a reference should be ignored.

Inheritance Hierarchy

  • System.Object
  • Autodesk.DataManagement.Client.Framework.Vault.Models.ExtensionHandlers.UpdateFileReferencesModel

See Also