A Sandcastle Documented Class Library

# FileController Class

The REST API for performing administration tasks on a file.
Inheritance Hierarchy
System
Object
Microsoft.AspNetCore.Mvc
ControllerBase
Dundas.BI.WebApi.Controllers
ApiControllerBase
Dundas.BI.WebApi.Controllers
FileSystemEntryControllerBase
Dundas.BI.WebApi.Controllers
FileController

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

    public class FileController : FileSystemEntryControllerBase

    Public Class FileController
    	Inherits FileSystemEntryControllerBase

    public ref class FileController : public FileSystemEntryControllerBase

    type FileController =
        class
            inherit FileSystemEntryControllerBase
        end

The FileController type exposes the following members.

Constructors

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

Top
Properties

| Name | Description
--- | --- | ---
| FileSystemService | Gets the file system service. (Inherited from FileSystemEntryControllerBase.)

Top
Methods

| Name | Description
--- | --- | ---
| AddRecentlyUsed | PUT /File/RecentlyUsed/{id} Adds the given file ID to the list of recently used items.
| AddToMostRecentlyUsed | Adds the given file ID to the list of recently used items. (Inherited from FileSystemEntryControllerBase.)
| BatchDelete | POST /File/Delete Deletes the files or folders with the specified IDs.
| CheckIn(CheckInIdsOptions, Nullable Guid ) | POST /File/CheckIn Checks in files with the specified IDs and comments.
| CheckIn(Guid, CheckInOptions, Nullable Guid ) | POST /File/CheckIn/{id}/ Checks in the file with the specified ID and comments.
| CheckOut(Guid, Nullable Guid ) | PUT /File/CheckOut/{id}/ Checks out the file with the specified ID to the caller.
| CheckOut( Guid , Nullable Guid ) | PUT /File/CheckOut/ Checks out files with the specified IDs to the caller.
| ClearMostRecentlyUsed | Gets the most recently used files for the current user. (Inherited from FileSystemEntryControllerBase.)
| ClearRecentlyUsed | DELETE /File/RecentlyUsed/ Clears the most recently used items.
| CopyEntry | Copies the file system entry with the specified ID to the new location. (Inherited from FileSystemEntryControllerBase.)
| CopyFile | POST /File/Copy/{id} Copies the file with the specified ID.
| CreateFolder | POST /File/Folder Creates a folder in the application's file system.
| Delete(BatchDeleteOptions, Nullable Guid ) | Obsolete. POST /File/ OBSOLETE - Use POST /File/Delete instead. Deletes the files or folders with the specified IDs.
| Delete(Guid, DeleteOptions, Nullable Guid ) | DELETE /File/{id} Deletes the file or folder with the specified ID.
| DeleteOldEntityData | POST /File/DeleteOldEntityData Deletes data from entities which are not the current revision and were created before the specified date.
| EmptyRecycleBin | POST /File/EmptyRecycleBin/ Empties all of the recycled files or folders from the recycle bin.
| EnsureCallerContext | If the current context is not already the specified context, creates a new caller context which is a clone of the specified context and sets it as the current one. (Inherited from ApiControllerBase.)
| EnsureFormFileMultipartContent | Ensures when form files are access the content is MIME multi-part which we want. (Inherited from ApiControllerBase.)
| EnsureVisible | POST /File/EnsureVisible/{id}/ Ensures that a particular entity is visible to the specified accounts and groups.
| EntryExists(Guid, Nullable Guid ) | Determines whether an entry with the specified name exists in the specified folder. (Inherited from FileSystemEntryControllerBase.)
| EntryExists(String, Guid, Nullable Guid ) | Determines whether an entry with the specified name exists in the specified folder. (Inherited from FileSystemEntryControllerBase.)
| FileExists(Guid, Nullable Guid ) | GET /File/Exists/{id} Determines whether a file with the specified ID exists.
| FileExists(Guid, String, Nullable Guid ) | POST /File/NameExists/{parentId} Determines whether a file with the specified name exists in the specified folder.
| FileSystemQueryHelper | Retrieves information about multiple files or folders. (Inherited from FileSystemEntryControllerBase.)
| GetCheckedOutReferences | GET /File/CheckedOutReferences/{id}/ Gets the specified file's checked out references.
| GetClientIdFromCookieOrProvided | Gets the client ID from cookie or from the provided value, which is usually from the query string. (Inherited from ApiControllerBase.)
| GetDownstreamReferenceExplosion | GET /File/ReferencesToRecursive/{id}/ Gets the references (downstream reference explosion) to the specified file. This is recursive.
| GetEntryTags | Gets a list of entry tags and their usage. (Inherited from FileSystemEntryControllerBase.)
| GetFileById | GET /File/{id} Gets the file or folder.
| GetFileByName | POST /File/Name/ Gets the file.
| GetLastModifiedTime | GET /File/LastModifiedTime/{id} Gets the file's last modified time for cache comparison.
| GetMostRecentlyUsed | Gets the most recently used files for the current user. (Inherited from FileSystemEntryControllerBase.)
| GetRecentlyUsed | GET /File/RecentlyUsed/ Gets the most recently used files for the current user.
| GetRecycleBinFolder | GET /File/RecycleBin/ Gets the recycle bin folder.
| GetReferencedBy | GET /File/ReferencedBy/{id}/ Gets the files referenced by the specified file.
| GetReferencesTo | GET /File/ReferencesTo/{id}/ Gets the references to the specified file.
| GetService T | Gets the requested service. (Inherited from ApiControllerBase.)
| GetSessionIdFromCookieHeaderOrProvided | Gets the session ID from cookie, the authorization header or from the provided value, which is usually from the query string. (Inherited from ApiControllerBase.)
| GetUnusedEntitiesForProject | GET /File/UnusedEntitiesForProject/{id} Gets the unused entities found in the specified project.
| GetUpstreamReferenceExplosion | GET /File/ReferencedByRecursive/{id}/ Gets the references (upstream reference explosion) to the specified file. This is recursive.
| LoadSession | Creates a new caller context associated with the specified session ID. The session is not validated. (Inherited from ApiControllerBase.)
| MoveEntry | Moves the file or folder with the specified ID. (Inherited from FileSystemEntryControllerBase.)
| MoveFile | POST /File/Move/{id} Moves the file with the specified ID.
| PromoteTransient | POST /File/PromoteTransient/{id} Promotes a transient file to a real one.
| QueryFiles | POST /File/Query/ Gets multiple files or folders.
| QueryFileSystemEntry | Retrieves information about multiple files or folders. (Inherited from FileSystemEntryControllerBase.)
| QueryFileSystemEntryCount | Retrieves the number of files and folders that match the query options. (Inherited from FileSystemEntryControllerBase.)
| QueryNumberOfFiles | POST /File/Count/ Gets the number of files and folders.
| QueryRevision | POST /File/RevisionQuery/ Retrieves information about multiple files or folders revision history.
| RenameEntry | Renames the file or folder with the specified ID. (Inherited from FileSystemEntryControllerBase.)
| RenameFile | PUT /File/Rename/{id} Renames the file with the specified ID.
| RequestFirstFormFile | Retrieves the first form file from the request. (Inherited from ApiControllerBase.)
| RequestFormFiles | Retrieves the form files from the request. (Inherited from ApiControllerBase.)
| RestoreRecycleBin | POST /File/RestoreRecycleBin/ Restores the recycled files or folders with the specified IDs.
| ReturnInvalidWindowsIdentityResponse | Returns the invalid windows identity response to challenge the browser. (Inherited from ApiControllerBase.)
| RevisionQuery | Retrieves information about multiple revisions on files or folders. (Inherited from FileSystemEntryControllerBase.)
| RollbackEntry | Rolls the file or folder back to the specified revision number. (Inherited from FileSystemEntryControllerBase.)
| RollbackFile | POST /File/Rollback/{id} Rolls the file with the specified ID back to the specified revision number.
| SearchTags | POST /File/Tags Gets the tags that match the text passed in.
| SetDescription | PUT /File/Description/{id} Updates a file's description.
| SetEntryDescription | Sets the entry description. (Inherited from FileSystemEntryControllerBase.)
| SetEntryPrivileges | Sets the entry privileges. (Inherited from FileSystemEntryControllerBase.)
| SetEntryTags | Sets an entry tags. (Inherited from FileSystemEntryControllerBase.)
| SetPrivileges | PUT /File/Privileges/{id} Updates a file's privileges.
| SetTags | PUT /File/Tags/{id} Updates a file's tags.
| TouchEntry(Guid, Nullable Guid ) | Updates the last modified time of the entry with the specified ID. (Inherited from FileSystemEntryControllerBase.)
| TouchEntry( Guid , Nullable Guid ) | Updates the last modified time of the entries with the specified IDs. (Inherited from FileSystemEntryControllerBase.)
| TouchFile(Guid, Nullable Guid ) | PUT /File/Touch/{id} Updates the last modified time of the file with the specified ID.
| TouchFile( Guid , Nullable Guid ) | PUT /File/Touch/ Updates the last modified time of files with the specified IDs.
| TransferCheckOut | POST /File/TransferCheckOut/{id}/ Transfers the checked out file with the specified ID to the specified account ID.
| UndoCheckOut(Guid, Nullable Guid ) | POST /File/UndoCheckOut/{id}/ Discards the changes to the checked out file with the specified ID, and cancels the check out.
| UndoCheckOut( Guid , Nullable Guid ) | POST /File/UndoCheckOut Discards the changes to the checked out files with the specified IDs, and cancels the check out.

Top
See Also

#### Reference

Dundas.BI.WebApi.Controllers Namespace