A Sandcastle Documented Class Library

# FileData Class

Base data contract object for returning a FileSystemEntry or File or Folder through the REST API.
Inheritance Hierarchy
System
Object
Dundas.BI.WebApi.Models
BaseDataContract
Dundas.BI.WebApi.Models
FileData
Dundas.BI.WebApi.Models
AnnotationData
Dundas.BI.WebApi.Models
CorrectionValueData
Dundas.BI.WebApi.Models
DataCubeInfoData
Dundas.BI.WebApi.Models
EntityBaseData
Dundas.BI.WebApi.Models
ProjectData

Namespace: Dundas.BI.WebApi.Models
Assembly: Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    [DataContractAttribute]
    public class FileData : BaseDataContract

    <DataContractAttribute>
    Public Class FileData
    	Inherits BaseDataContract

    [DataContractAttribute]
    public ref class FileData : public BaseDataContract

    [<DataContractAttribute>]
    type FileData =
        class
            inherit BaseDataContract
        end

The FileData type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| FileData | Initializes a new instance of the FileData class.

Top
Properties

| Name | Description
--- | --- | ---
| CheckedOutTo | Gets information about the account to which the object is checked out.
| ChildCount | Gets the number of direct children contained in the entry.
| CreatedBy | Gets the account information for the user which created the entry.
| CreatedTime | Gets the time, in coordinated universal time (UTC), at which the entry was created.
| CurrentRevision | Gets the highest revision number associated with this file.
| Description | Gets an optional description associated with the entry.
| EffectiveCallerPrivileges | Gets the effective caller privileges so the UI can do checks based on this.
| Files | Gets the files contained in the entry.
| Folders | Gets the folders contained in the entry.
| FriendlyFullName | Gets the full path of the entry (friendly).
| FriendlyLocation | Gets the location of the entry (friendly representation).
| FriendlyLocationElements | Gets a read-only list of distinct path elements which compose FriendlyLocation.
| FriendlyName | Gets the name of the entry (friendly representation).
| FullName | Gets the full path of the entry.
| Id | Gets the unique identifier of the entry.
| InheritedTags | Gets the inherited tags, if there are any.
| IsCheckedOut | Gets a value indicating whether the file is checked out.
| IsCheckedOutToCaller | Gets a value indicating whether the file is checked out to caller.
| IsInactive | Gets a value indicating whether the file is inactive.
| IsProtected | Gets a value indicating whether the entry is protected.
| IsRecycled | Gets a value indicating whether the entry is recycled.
| IsSubentry | Gets a value indicating whether the entry is contained by a File.
| IsTransient | Gets a value indicating whether the file is transient.
| LastCheckedInTime | Gets the time when the file was last checked in.
| LastModifiedTime | Gets the time, in coordinated universal time (UTC), at which the entry was last modified.
| Location | Gets the location of the entry.
| Metadata | Gets arbitrary metadata associated with the entry.
| Name | Gets the name of the entry.
| ObjectType | Gets the type of the entry.
| Overwrite | Gets or sets a value indicating whether the file should be overwritten if the file was already created.
| ParentId | Gets the ID of the item's parent.
| PrimaryEntryId | Gets the ID of the primary object which contains the entry.
| PrivilegeInheritanceBehavior | Gets the privilege inheritance behavior.
| Privileges | Gets the entry's privilege assignments.
| ProjectId | Gets the ID of the project containing the entry.
| Subtype | Gets or sets the type-specific sub-type of the entry.
| Tags | Gets a collection of explicit tags associated with the entry.
| TenantId | Gets the ID of the tenant associated with the entry.
| UIClassName | Gets or sets the name of the UI class (used for auto de-serialization). (Inherited from BaseDataContract.)
| Warnings | Gets the warnings for the current instance, as well as for any dependency objects.

Top
Methods

| Name | Description
--- | --- | ---
| ToFileDataContractMappings | Gets the mapping rules that go from a FileSystemEntry to a FileData.

Top
Extension Methods

| Name | Description
--- | --- | ---
| SetUIClassName | Sets the name of the file data UI class. (Defined by ModelDataExtensions.)

Top
See Also

#### Reference

Dundas.BI.WebApi.Models Namespace