Skip to content

BH.oM.Adapters.File.FileContentRequest

Used to read contents of one or more files.

Class structure

Implemented interfaces and base types

The FileContentRequest 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
File FSFile The content from this File will be queried.
You can also specify the file with a string Path.		 -
Types List<Type> Only objects of a Type specified in this list will be returned. -
CustomDataKeys List<string> Only BHoMObjects whose CustomData contains these key/value pairs will be returned. -
FragmentTypes List<Type> Only BHoMObjects that own a Fragment of one of these Types will be returned. -

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 FileContentRequest : BH.oM.Adapters.File.IFilingRequest, BH.oM.Data.Requests.IRequest, BH.oM.Base.IObject

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/FileContentRequest.json"
}

The JSON Schema is available on github here: