Autodesk Vault ProfessionalVault API

FileIteration Class

Autodesk.DataManagement.Client.Framework.VaultAutodesk.DataManagement.Client.Framework.Vault.Currency.Entities

Represents a specific iteration of a file in the vault.

Syntax

public class FileIteration : IEntity  
Public Class FileIteration
   Implements IEntity 

Constructors

NameDescription
FileIteration

Properties

NameDescription
CategoryGets the category that is assigned to this file
CheckedOutMachineGets the network ID of the computer that checked out the file. This property is only valid if IsCheckedOut is true.
CheckedOutSpecGets the path on the client's computer that the file was checked out to. This property is only valid if IsCheckedOut is true.
CheckedOutUserIdGets the ID of the user that has the file checked out. This property is only valid if IsCheckedOut is true.
CheckInDateGets the date and time that the file was checked in. This property is only valid if IsCheckedOut is false.
ChecksumGets the physical file's checksum. This is only valid if IsCheckedOut is false.
CommentGets a comment string set by the user. If IsCheckedOut is true, then this property contains the comment set during checkout. Otherwise, it contains the comment set during check-in.
CreateDateGets the date and time that this version of the file was created in the Vault. For the first version of a file, this date will match CheckInDate. For later versions, this value will have the time when the previous version was checked out.
CreateUserNameGets the name of the user who checked-in or uploaded this file.
DesignVisualizationAttachmentStatusGets the design visualization attachment status of the file
EntityClassGets the entity class associated with this File.
EntityIterationIdGets the Iteration ID of this File.
EntityMasterIdGets the Master Id of this File.
EntityNameGets the descriptive name for this File. This value applies to all versions of the file.
FileClassificationGets the classification of the file.
FolderIdGets the ID of the folder that the file was checked-out from. This property is only valid if IsCheckedOut is true.
IsCheckedOutGets whether the latest version of this file is in the checked-out state. Whenever a file is checked-out, a new version is created as a placeholder.
IsCheckedOutToCurrentUserGets whether or not this file is checked out to the currently logged in vault user
IsCloakedGets if this file is cloaked. A cloaked object is one that the caller does not have permissions to view. The only valid data in a cloaked file is the EntityIterationId and the EntityMasterId. All other data will be null or 0.
IsControlledByChangeOrderGets whether or not the file is controlled by a change order.
IsHiddenGets whether this file should be hidden to the user.
IsLatestVersionGets whether or not this file is the latest version.
IsLockedGets whether or not the file can be modified by the logged in user.
IsOnSiteGets whether or not the file is on the local site (in a multi-site environment). This value will always be true on a single-site environment.
IsOutOfDateGets whether or not this file needs to be updated.
LastModifiedDateGets the last modified date of the physical file. This value is set by the client that uploaded the file.
LifecycleInfoGets lifecycle information about this file.
LinkInfoGets if this is a Link to a File. If the value is not null, then LinkInfo provides information about the Link to this File
MaxCheckedInVersionNumberGets the maximimum version of the file currently checked-in to the vault.
ParentGets or sets the parent folder for this FileIteration.
RevisionInfoGets revision information about this file.
SizeGets the size of this file (in bytes)
VaultConnectionGets the Vault Connection that this file is associated with.
VersionNumberGets the version of the file. A file that has just been added ot the Vault will have a VerNum of 1.

Methods

NameDescription
EqualsTests if obj is equal to this File object.

Operators

NameDescription
Implicit Type ConversionCasts this FileIteration object to a Web Services File.

Returned By

Where you get a FileIteration — members that return one.

Inheritance Hierarchy

  • System.Object
  • Autodesk.DataManagement.Client.Framework.Vault.Currency.Entities.FileIteration

See Also