Skip to content

BH.oM.Adapters.File.FileRequest

Used to query Files from a Parent directory.

Class structure

Implemented interfaces and base types

The FileRequest is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
Location string Files from this location will be queried. -
SearchSubdirectories bool If enabled, look also in subdirectories. -
MaxNesting int If SearchSubdirectories is true, this sets the maximum subdirectiory nesting level to look in.
Defaults to -1 which corresponds to no limit.		 -
SortOrder SortOrder Sorting order of the extracted Files. -
MaxFiles int Sets the maximum number of Files to retrieve, useful when using SearchSubdirectories.
Defaults to -1 which corresponds to no limit.		 -
IncludeFileContents bool Whether to include the contents of the Files. -
Exclusions List<object> These files will be excluded from the results.
You can also specify string Full Paths.		 -

Derived properties

The following properties are defined as extension methods in one of the BHoM_Engines

Name Type Description Quantity Engine
Discipline Nullable<Discipline> Gets discipline enforced by the Request. If the result is different than defaultDiscipline and neither of two is Undefined, null is returned (the result discipline is conflicting with defaultDiscipline). - Revit_Engine
IFilterDescription string Returns a description of the filter represented by the given IRequest. - Revit_Engine

Code and Schema

C# implementation

C#
public class FileRequest : BH.oM.Adapters.File.IFileRequest,
BH.oM.Adapters.File.ISortableRequest,
BH.oM.Data.Requests.IRequest,
BH.oM.Base.IObject,
BH.oM.Adapters.File.IResourceRequest

Assembly: File_oM.dll

The C# class definition is available on github:

All history and changes of the class can be found by inspection the history.

JSON Schema implementation

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema
{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/File_oM/FileRequest.json"
}

The JSON Schema is available on github here: