Skip to content

Core Library Class Reference

Microsoft.FactoryOrchestrator.Core Namespace

Classes
AppPackages Object representing a list of Application Packages
BatchFileTask An BatchFile is a .cmd or .bat script that is run by the FactoryOrchestratorServer. The exit code of the script determines if the task passed or failed.
0 == PASS, all others == FAIL.
CommandLineTask An CommandLineTask is a .cmd, .bat, or .sh script. This is known as a Batch file on Windows and a Shell script on Linux. The exit code of the script determines if the task passed or failed.
0 == PASS, all others == FAIL.
Constants Class for any cross-project constants.
ExecutableTask An ExecutableTask is an .exe binary that is run by the FactoryOrchestratorServer. The exit code of the process determines if the task passed or failed.
0 == PASS, all others == FAIL.
ExternalTask An ExternalTest is a task run outside of the FactoryOrchestratorServer.
task results must be returned to the server via SetTaskRunStatus().
FactoryOrchestratorContainerDisabledException An exception denoting that container support is disabled.
FactoryOrchestratorContainerException An exception denoting an issue with the container on the device.
FactoryOrchestratorException A generic Factory Orchestrator exception.
FactoryOrchestratorTaskListRunningException An exception denoting a running TaskList is preventing the operation from succeeding.
FactoryOrchestratorUnkownGuidException An exception denoting the given GUID is not recognized by Factory Orchestrator.
FactoryOrchestratorXML This class is used to save and load TaskLists from an XML file.
FactoryOrchestratorXmlException An exception denoting an issue with given FactoryOrchestratorXML file.
LockingList<T> A wrapper for the List class that locks the list on any modification operations.
NotifyPropertyChangedBase Abstract class to implement INotifyPropertyChanged
PackageInfo object representing the package information
PackageVersion Object representing a package version
PowerShellTask An PowerShellTask is a PowerShell Core .ps1 script that is run by the FactoryOrchestratorServer. The exit code of the script determines if the task passed or failed.
0 == PASS, all others == FAIL.
ServiceEvent A class containing information about a specific Factory Orchestrator Service event.
TAEFTest A TAEFTest is a type of ExecutableTask, which is always run by TE.exe. TAEF tests are comprised of one or more sub-tests (TAEFTestCase).
Pass/Fail is determined by TE.exe.
TaskBase TaskBase is an abstract class representing a generic task. It contains all the details needed to run the task.
It also surfaces information about the last TaskRun for this task, for easy consumption.
TaskList A TaskList is a grouping of Factory Orchestrator Tasks.
TaskRun A TaskRun represents one instance of executing any single Task.
UWPTask A UWPTest is a UWP task run by the FactoryOrchestrator.App client. These are used for UI.
task results must be returned to the server via SetTaskRunStatus().
Structs
TaskListSummary A helper class containing basic information about a TaskList. Use to quickly update clients about TaskLists and their statuses.
Interfaces
IFactoryOrchestratorService IFOCommunication defines the Factory Orchestrator Client-Server communication model.
Enums
ServiceEventType The type of Factory Orchestrator Service event.
TaskStatus The status of a Task, TaskRun, or TaskList.
TaskType The type of Task.