FileData Class

Base data contract object for returning a FileSystemEntry or File or Folder through the REST API.
Inheritance Hierarchy
SystemObject
  Dundas.BI.WebApi.ModelsBaseDataContract
    Dundas.BI.WebApi.ModelsFileData
      More

Namespace: Dundas.BI.WebApi.Models
Assembly: Dundas.BI.WebApiCore (in Dundas.BI.WebApiCore.dll) Version: 2.0.0.0 (26.2.0.1000)
Syntax
[DataContractAttribute]
public class FileData : BaseDataContract

The FileData type exposes the following members.

Constructors
 NameDescription
Public methodFileData Initializes a new instance of the FileData class.
Top
Properties
 NameDescription
Public propertyCheckedOutTo Gets information about the account to which the object is checked out.
Public propertyChildCountGets the number of direct children contained in the entry.
Public propertyCreatedBy Gets the account information for the user which created the entry.
Public propertyCreatedTime Gets the time, in coordinated universal time (UTC), at which the entry was created.
Public propertyCurrentRevisionGets the highest revision number associated with this file.
Public propertyDescription Gets an optional description associated with the entry.
Public propertyEffectiveCallerPrivileges Gets the effective caller privileges so the UI can do checks based on this.
Public propertyFiles Gets the files contained in the entry.
Public propertyFoldersGets the folders contained in the entry.
Public propertyFriendlyFullName Gets the full path of the entry (friendly).
Public propertyFriendlyLocation Gets the location of the entry (friendly representation).
Public propertyFriendlyLocationElements Gets a read-only list of distinct path elements which compose FriendlyLocation.
Public propertyFriendlyNameGets the name of the entry (friendly representation).
Public propertyFullName Gets the full path of the entry.
Public propertyId Gets the unique identifier of the entry.
Public propertyInheritedTags Gets the inherited tags, if there are any.
Public propertyIsCheckedOutGets a value indicating whether the file is checked out.
Public propertyIsCheckedOutToCaller Gets a value indicating whether the file is checked out to caller.
Public propertyIsInactive Gets a value indicating whether the file is inactive.
Public propertyIsProtectedGets a value indicating whether the entry is protected.
Public propertyIsRecycledGets a value indicating whether the entry is recycled.
Public propertyIsSubentry Gets a value indicating whether the entry is contained by a File.
Public propertyIsTemporary Gets a value indicating whether the entry resides under a temporary folder.
Public propertyIsTransientGets a value indicating whether the file is transient.
Public propertyLastCheckedInTimeGets the time when the file was last checked in.
Public propertyLastModifiedTime Gets the time, in coordinated universal time (UTC), at which the entry was last modified.
Public propertyLocationGets the location of the entry.
Public propertyMetadataGets arbitrary metadata associated with the entry.
Public propertyName Gets the name of the entry.
Public propertyObjectType Gets the type of the entry.
Public propertyOverwrite Gets or sets a value indicating whether the file should be overwritten if the file was already created.
Public propertyParentId Gets the ID of the item's parent.
Public propertyPrimaryEntryIdGets the ID of the primary object which contains the entry.
Public propertyPrivilegeInheritanceBehavior Gets the privilege inheritance behavior.
Public propertyPrivileges Gets the entry's privilege assignments.
Public propertyProjectId Gets the ID of the project containing the entry.
Public propertySubtypeGets or sets the type-specific sub-type of the entry.
Public propertyTags Gets a collection of explicit tags associated with the entry.
Public propertyTenantId Gets the ID of the tenant associated with the entry.
Public propertyUIClassName Gets or sets the name of the UI class (used for auto de-serialization).
(Inherited from BaseDataContract)
Public propertyWarnings Gets the warnings for the current instance, as well as for any dependency objects.
Top
Methods
 NameDescription
Public methodStatic memberToFileDataContractMappings Gets the mapping rules that go from a FileSystemEntry to a FileData.
Top
Extension Methods
 NameDescription
Public Extension MethodSetUIClassName Sets the name of the file data UI class.
(Defined by ModelDataExtensions)
Top
See Also
Inheritance Hierarchy