Microsoft.FactoryOrchestrator.Core.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.FactoryOrchestrator.Core</name> </assembly> <members> <member name="T:Microsoft.FactoryOrchestrator.Core.Constants"> <summary> Class for any cross-project constants. </summary> <exclude/> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.Constants.FileTransferChunkSize"> <summary> Chunk size in bytes for file transfers. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.ServiceEventType"> <summary> The type of Factory Orchestrator Service event. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.DoneWaitingForExternalTaskRun"> <summary> External TaskRun is completed. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.WaitingForExternalTaskRun"> <summary> External TaskRun is waiting on an external action. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.WaitingForContainerTaskRun"> <summary> TaskRun is waiting to be run by the container. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.ServiceError"> <summary> The Factory Orchestrator Service threw an exception. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.ServiceStart"> <summary> The Factory Orchestrator Service is starting. It can now communicate with clients, but boot tasks may not be complete. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.BootTasksComplete"> <summary> The Factory Orchestrator Service is fully started. Boot tasks are completed. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.ContainerConnected"> <summary> The Factory Orchestrator Service is connected to a container also running a compatible version of Factory Orchestrator Service. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.ContainerDisconnected"> <summary> The Factory Orchestrator Service is disconnected from a container also running a compatible version of Factory Orchestrator Service. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.ContainerDisabled"> <summary> The Factory Orchestrator Service container support is disabled by policy. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.NetworkAccessDisabled"> <summary> The Factory Orchestrator Service network access is disabled by policy. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.TaskRunRedirectedToRunAsRDUser"> <summary> The TaskRun has GUI and was redirected to RunAsRDUser.exe. It will not run until a remote user is logged in. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.ContainerServiceError"> <summary> The Factory Orchestrator Service inside a connected container threw an exception. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.ContainerTaskRunRedirectedToRunAsRDUser"> <summary> The Factory Orchestrator Service inside a connected container has a TaskRun with GUI and it was redirected to RunAsRDUser.exe. It will not run until a remote user is logged in. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ServiceEventType.Unknown"> <summary> An unknown Factory Orchestrator Service event occurred. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.ServiceEvent"> <summary> A class containing information about a specific Factory Orchestrator Service event. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.ServiceEvent.#ctor"> <summary> JSON Constructor. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.ServiceEvent.#ctor(Microsoft.FactoryOrchestrator.Core.ServiceEventType,System.Nullable{System.Guid},System.String)"> <summary> Create a new ServiceEvent. </summary> <param name="type"></param> <param name="guid"></param> <param name="message"></param> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.ServiceEvent.EventIndex"> <summary> The unique index of the event. Strictly increasing in order. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.ServiceEvent.EventTime"> <summary> The time of the event. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.ServiceEvent.ServiceEventType"> <summary> The type of the event. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.ServiceEvent.Guid"> <summary> If not NULL, the object GUID associated with the event. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.ServiceEvent.Message"> <summary> The message in the event. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService"> <summary> IFOCommunication defines the Factory Orchestrator Client-Server communication model. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.Connect(System.String,System.String)"> <summary> Connects the specified client to the service. </summary> <param name="clientIdentifer">Friendly identifier for the client.</param> <param name="message">An optional message.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.ResetService(System.Boolean,System.Boolean)"> <summary> Stops all running Tasks and deletes all TaskLists. </summary> <param name="preserveLogs">If true, are logs not deleted.</param> <param name="factoryReset">If true, the service is restarted as if it is first boot. NOTE: Network communication is not disabled, connected clients may encounter issues and the 'EnableNetworkAccess' setting will be ignored! </param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetServiceEvents"> <summary> Gets all Service events. </summary> <returns>List of all Service events.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetServiceEvents(System.DateTime)"> <summary> Get all Service events since given time. </summary> <param name="timeLastChecked"></param> <returns>List of Service events.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetServiceEvents(System.UInt64)"> <summary> Get all Service events since given index. </summary> <param name="lastEventIndex"></param> <returns>List of Service events.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetLastServiceError"> <summary> Get last Service error. </summary> <returns></returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetServiceVersionString"> <summary> Returns the version of Factory Orchestrator Service. </summary> <returns>string representing the Service version.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetOSVersionString"> <summary> Returns the version of the OS. </summary> <returns>string representing the OS version.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetOSPlatform"> <summary> Returns the platform of the OS. </summary> <returns>System.PlatformID enum value representing the OS platform (Unix or Windows).</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetOEMVersionString"> <summary> Returns the version set by the OEM duing WSK Image Customization. </summary> <returns>string representing the OEM version.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.SetTeExePath(System.String)"> <summary> Sets the path to TE.exe, used to run TAEF tests. </summary> <param name="teExePath">Path to TE.exe</param> <returns></returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.SetLogFolder(System.String,System.Boolean)"> <summary> Sets the log folder path used by Factory Orchestrator. </summary> <param name="path">Path to the desired folder.</param> <param name="moveExistingLogs">If true, existing logs are moved to the new location.</param> <returns></returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetLogFolder"> <summary> Gets the log folder path used by Factory Orchestrator. </summary> <returns>Path to the log folder.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetIpAddressesAndNicNames"> <summary> Gets a list of IP addresses and the Network Adapter each IP address belongs to. </summary> <returns>A list of IP addresses and the Network Adapter each IP address belongs to.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetContainerIpAddresses"> <summary> Gets a list of IP addresses for the container. These IPs are internal, they cannot be accessed outside of the host. </summary> <returns>A list of IP addresses for the container.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.IsExecutingBootTasks"> <summary> Checks if the service is executing boot tasks. While executing boot tasks, many commands cannot be run. </summary> <returns><c>true</c> is the service is executing boot tasks.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.IsContainerRunning"> <summary> Determines whether the connected device has a container present and running. </summary> <returns> <c>true</c> if container is present and running; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetDisabledPages"> <summary> Gets a list of Factory Orchestrator App pages that were disabled by OEM Customization. </summary> <returns>A list of page tags that should be disabled.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.IsNetworkAccessEnabled"> <summary> Checks if the service supports network access. </summary> <returns><c>true</c> if the service allows connections over the local network.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetWdpHttpPort"> <summary> Gets the Windows Device Portal HTTP port. Does not ensure WDP is running or supports HTTP. </summary> <returns>The HTTP port.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetDnsHostName"> <summary> Gets the DNS host name of the connected device. </summary> <returns>The DNS host name.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.CreateTaskListFromDirectory(System.String,System.Boolean)"> <summary> Creates a new TaskList by finding all .exe, .cmd, .bat, .ps1, and TAEF files in a given folder. </summary> <param name="path">Path of the directory to search.</param> <param name="recursive">If true, search recursively.</param> <returns>The created TaskList</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.LoadTaskListsFromXmlFile(System.String)"> <summary> Creates new TaskLists by loading them from a FactoryOrchestratorXML file. </summary> <param name="filename">The path to the FactoryOrchestratorXML file.</param> <returns>The GUID(s) of the created TaskList(s)</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.SaveTaskListToXmlFile(System.Guid,System.String)"> <summary> Saves a TaskList to a FactoryOrchestratorXML file. </summary> <param name="guid">The GUID of the TaskList you wish to save.</param> <param name="filename">The path to the FactoryOrchestratorXML file that will be created.</param> <returns>true on success</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.SaveAllTaskListsToXmlFile(System.String)"> <summary> Saves all TaskLists in the Service to a FactoryOrchestratorXML file. </summary> <param name="filename">The path to the FactoryOrchestratorXML file that will be created.</param> <returns>true on success</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.CreateTaskListFromTaskList(Microsoft.FactoryOrchestrator.Core.TaskList)"> <summary> Creates a TaskList on the Service by copying a TaskList object provided by the Client. </summary> <param name="list">The TaskList to add to the Service.</param> <returns>The created Service TaskList.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetTaskListGuids"> <summary> Gets the GUID of every "active" TaskList on the Service. If "IsExecutingBootTasks()" returns true, this returns the "boot" TaskLists. Otherwise, it returns the "normal" TaskLists. </summary> <returns>The list of TaskList GUIDs.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetTaskListSummaries"> <summary> Gets TaskList summaries for every "active" TaskList on the Service. If "IsExecutingBootTasks()" returns true, this returns the "boot" TaskLists. Otherwise, it returns the "normal" TaskLists. The summary contains basic info about the TaskList. </summary> <returns>A list of TaskListSummary objects.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetBootTaskListGuids"> <summary> Gets the GUID of every "boot" TaskList on the Service. </summary> <returns>The list of TaskList GUIDs.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetBootTaskListSummaries"> <summary> Gets "boot" TaskList summaries for every "boot" TaskList on the Service. The summary contains basic info about the TaskList. </summary> <returns>A list of TaskListSummary objects.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.QueryTaskList(System.Guid)"> <summary> Gets the TaskList object for a given TaskList GUID. </summary> <param name="taskListGuid">The TaskList GUID.</param> <returns>The TaskList object with that GUID.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.DeleteTaskList(System.Guid)"> <summary> Deletes a TaskList on the Service. </summary> <param name="listToDelete">The GUID of the TaskList to delete.</param> <returns>true if it was deleted successfully.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.UpdateTaskList(Microsoft.FactoryOrchestrator.Core.TaskList)"> <summary> Updates an existing TaskList on the Service. </summary> <param name="taskList">The updated TaskList.</param> <returns>true if it was updated successfully.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.ReorderTaskLists(System.Collections.Generic.List{System.Guid})"> <summary> Reorders the TaskLists known to the Service. </summary> <param name="newOrder">An ordered list of GUIDs corresponding to the TaskList GUIDs known to the Service.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.QueryTask(System.Guid)"> <summary> Returns the Task object for a given Task GUID. </summary> <param name="guid">The Task GUID.</param> <returns></returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetInstalledApps"> <summary> Gets the AUMIDs of all installed apps on the OS. Requires Windows Device Portal. </summary> <returns>The list of app AUMIDs.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetInstalledAppsDetailed"> <summary> Gets all installed apps on the OS. Requires Windows Device Portal. </summary> <returns>The list of apps and their information, in PackageInfo objects.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.InstallApp(System.String,System.Collections.Generic.List{System.String},System.String)"> <summary> Installs an app package on the Service's computer. The app package must already be on the Service's computer. Requires Windows Device Portal. If the app package is not on the Service's computer already, use SendAndInstallApp() to copy and install it instead. </summary> <param name="appPackagePath">Path on the Service's computer to the app package (.appx, .appxbundle, .msix, .msixbundle).</param> <param name="dependentPackages">List of paths on the Service's computer to the app's dependent packages.</param> <param name="certificateFile">Path on the Service's computer to the app's certificate file, if needed. Microsoft Store signed apps do not need a certificate.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.EnableLocalLoopbackForApp(System.String)"> <summary> Enables local loopback on the given UWP app. Local loopback is enabled permanently for this app, persisting through reboots. </summary> <param name="aumid">The Application User Model ID (AUMID) of the app to enable local loopback on.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.RunAllTaskLists"> <summary> Executes all TaskLists in order. </summary> <returns><c>true</c> if the TaskLists are successfully queued to run.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.RunTaskList(System.Guid,System.Int32)"> <summary> Executes a TaskList. </summary> <param name="taskListGuid">GUID of the TaskList to run.</param> <param name="initialTask">Index of the Task to start the run from.</param> <returns></returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.AbortAll"> <summary> Stops all executing Tasks and/or TaskLists. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.AbortTaskList(System.Guid)"> <summary> Stops executing a TaskList. </summary> <param name="taskListGuid">The GUID of the TaskList to stop.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.AbortTaskRun(System.Guid)"> <summary> Stops executing a TaskRun. </summary> <param name="taskRunGuid">The GUID of the TaskRun to stop.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.RunExecutable(System.String,System.String,System.String,System.Boolean)"> <summary> Runs an executable (.exe) outside of a Task/TaskList. </summary> <param name="exeFilePath">Full path to the .exe file</param> <param name="arguments">Arguments to pass to the .exe</param> <param name="logFilePath">Optional log file to save the console output to.</param> <param name="runInContainer">If true, run the executable in the container of the connected device.</param> <returns>The TaskRun associated with the .exe</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.RunApp(System.String)"> <summary> Runs a UWP app outside of a Task/TaskList. Requires Windows Device Portal. </summary> <param name="aumid">The Application User Model ID (AUMID) of the app to run.</param> <returns></returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.TerminateApp(System.String)"> <summary> Exits a UWP app. Requires Windows Device Portal. </summary> <param name="aumid">The Application User Model ID (AUMID) of the app to exit.</param> <returns></returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.RunTask(System.Guid)"> <summary> Runs a Task outside of a TaskList. </summary> <param name="taskGuid">The GUID of the Task to run.</param> <returns>The TaskRun associated with the run.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.RunTask(Microsoft.FactoryOrchestrator.Core.TaskBase,System.Nullable{System.Guid})"> <summary> Runs a Task outside of a TaskList. </summary> <param name="task">The Task to run.</param> <param name="desiredTaskRunGuid">The desired GUID for the returned TaskRun. It is not used if a TaskRun already exists with the same GUID.</param> <returns>The TaskRun associated with the run.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.UpdateTaskRun(Microsoft.FactoryOrchestrator.Core.TaskRun)"> <summary> Updates the status of a TaskRun. </summary> <param name="taskRun">The TaskRun to update.</param> <returns>true if it was updated.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.QueryTaskRun(System.Guid)"> <summary> Gets a TaskRun object. </summary> <param name="taskRunGuid">The GUID of the desired TaskRun</param> <returns>The TaskRun object.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.GetFile(System.String,System.Int64,System.Int32,System.Boolean)"> <summary> Gets all the data in a file on the Service's computer. It is recommended you use FactoryOrchestratorClient::GetFileFromDevice instead. </summary> <param name="sourceFilename">The path to the file to retrieve.</param> <param name="offset">If -1, read the whole file. Otherwise the starting byte to read the file from.</param> <param name="count">If offset is -1 this is ignored. Otherwise, the number of bytes to read from the file.</param> <param name="getFromContainer">If true, get the file from the container running on the connected device.</param> <returns>The bytes in the file.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.SendFile(System.String,System.Byte[],System.Boolean,System.Boolean)"> <summary> Saves data to a file to the Service's computer. It is recommended you use FactoryOrchestratorClient::SendFileToDevice instead. </summary> <param name="targetFilename">The name of the file you want created on the Service's computer.</param> <param name="fileData">The bytes you want saved to that file.</param> <param name="appendFile">If true, the file is appended to instead of overwritten.</param> <param name="sendToContainer">If true, send the file to the container running on the connected device.</param> <returns>true if the file was sucessfully created.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.DeleteFileOrFolder(System.String,System.Boolean)"> <summary> Permanently deletes a file or folder. If a folder, all contents are deleted. </summary> <param name="path">File or folder to delete</param> <param name="deleteInContainer">If true, delete the file from the container running on the connected device.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.MoveFileOrFolder(System.String,System.String,System.Boolean)"> <summary> Moves a file or folder to a new location. </summary> <param name="sourcePath">File or folder to move</param> <param name="destinationPath">Destination path</param> <param name="moveInContainer">If true, move the file from the container running on the connected device.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.EnumerateDirectories(System.String,System.Boolean,System.Boolean)"> <summary> Returns a list of all directories in a given folder. </summary> <param name="path">The folder to search.</param> <param name="recursive">If true, search recursively.</param> <param name="inContainer">If true, look for directories in the container running on the connected device.</param> <returns></returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.IFactoryOrchestratorService.EnumerateFiles(System.String,System.Boolean,System.Boolean)"> <summary> Returns a list of all files in a given folder. </summary> <param name="path">The folder to search.</param> <param name="recursive">If true, search recursively.</param> <param name="inContainer">If true, look for files in the container running on the connected device.</param> <returns></returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.JSONConverters.TaskBaseConverter"> <summary> TaskBaseConverter serializes "instances" of the abstract class TaskBase. </summary> <exclude/> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.JSONConverters.TaskBaseConverter.CanConvert(System.Type)"> <summary>Determines whether this instance can convert the specified object type.</summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.JSONConverters.TaskBaseConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary>Reads the JSON representation of the object.</summary> <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> <exception cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorException">Trying to deserialize an unknown task type!</exception> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.JSONConverters.TaskBaseConverter.CanWrite"> <summary>Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON.</summary> <value> <c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>.</value> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.JSONConverters.TaskBaseConverter.CanRead"> <summary>Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can read JSON.</summary> <value> <c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can read JSON; otherwise, <c>false</c>.</value> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.JSONConverters.TaskBaseConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter" /> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> <exception cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorException">Trying to serialize an unknown task type</exception> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.JSONConverters.NoConverter"> <summary> NoConverter class is used children of abstract classes (ex: ExecutableTask), to prevent infinite loop. All serialization is done by the Abstract class converter (TaskBaseConverter) </summary> <exclude/> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.JSONConverters.NoConverter.CanConvert(System.Type)"> <summary> Determines whether this instance can convert the specified object type. </summary> <param name="objectType">Type of the object.</param> <returns> <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. </returns> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.JSONConverters.NoConverter.CanRead"> <summary> Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter" /> can read JSON. </summary> <value> <c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter" /> can read JSON; otherwise, <c>false</c>. </value> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.JSONConverters.NoConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary> Reads the JSON representation of the object. </summary> <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader" /> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns> The object value. </returns> <exception cref="T:System.NotImplementedException"></exception> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.JSONConverters.NoConverter.CanWrite"> <summary> Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter" /> can write JSON. </summary> <value> <c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter" /> can write JSON; otherwise, <c>false</c>. </value> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.JSONConverters.NoConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary> Writes the JSON representation of the object. </summary> <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter" /> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> <exception cref="T:System.NotImplementedException"></exception> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.Resources"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> <exclude/> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.AppTerminated"> <summary> Looks up a localized string similar to Terminated app: {0}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.AttemptingContainerTaskRun"> <summary> Looks up a localized string similar to Attempting to run the Task in the container.... </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.AttemptingFileLoad"> <summary> Looks up a localized string similar to {0} found, attempting to load.... </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.AUMIDNotValidError"> <summary> Looks up a localized string similar to AUMID is not valid!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.BackgroundRetryException"> <summary> Looks up a localized string similar to BackgroundTasks cannot have a retry value!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.BackgroundTaskTypeException"> <summary> Looks up a localized string similar to BackgroundTasks must be ExecutableTask, PowerShellTask, or BatchFileTask!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.BackgroundTimeoutException"> <summary> Looks up a localized string similar to BackgroundTasks cannot have a timeout value!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.BootTasksExecutingError"> <summary> Looks up a localized string similar to Service boot tasks are still executing! Wait for them to finish or call AbortAll().. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.BootTasksFinished"> <summary> Looks up a localized string similar to Factory Orchestrator Service is done executing boot tasks.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.BootTasksStarted"> <summary> Looks up a localized string similar to Factory Orchestrator Service is executing boot tasks.... </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.CheckingForFile"> <summary> Looks up a localized string similar to Checking for {0}.... </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ClientConnected"> <summary> Looks up a localized string similar to A client named {0} connected. {1}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ClientNotConnected"> <summary> Looks up a localized string similar to Start connection first!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ContainerConnected"> <summary> Looks up a localized string similar to Factory Orchestrator Service is connected to a container running a compatible version of Factory Orchestrator Service.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ContainerConnectionFailed"> <summary> Looks up a localized string similar to Failed to connect to Factory Orchestrator Service inside the container!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ContainerDisabledException"> <summary> Looks up a localized string similar to Container support is disabled or not supported by the OS!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ContainerDisconnected"> <summary> Looks up a localized string similar to Factory Orchestrator Service is disconnected from a container running a compatible version of Factory Orchestrator Service.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ContainerFileGetFailed"> <summary> Looks up a localized string similar to Unable to get file from container!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ContainerFileSendFailed"> <summary> Looks up a localized string similar to Unable to send file to container!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ContainerSupportNotPresent"> <summary> Looks up a localized string similar to Operating System does not support containers. Disabling container support.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ContainerTaskRunFailed"> <summary> Looks up a localized string similar to Unable to complete TaskRun in container. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ContainerTaskTypeException"> <summary> Looks up a localized string similar to Tasks run in the container must be of type ExecutableTask, BatchFileTask, or PowerShellTask!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.CreateDirectoryFailed"> <summary> Looks up a localized string similar to Could not create {0} directory!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.DeleteContainerPathFailed"> <summary> Looks up a localized string similar to Unable to delete file or folder {0} in container!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.DnsSdUpdated"> <summary> Looks up a localized string similar to Device IP addresses changed. DNS-SD updated. Advertising on IP Addresses: {0}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.DoneWaitingForExternalTaskRun"> <summary> Looks up a localized string similar to External TaskRun {0} received a {1} result and is finished.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.DuplicateGuidInXml"> <summary> Looks up a localized string similar to Duplicate Guid(s) {0}in FactoryOrchestratorXML!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.DuplicateTaskRunGuid"> <summary> Looks up a localized string similar to TaskRun {0} could not be loaded from file as it already exists!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.EnablingLoopback"> <summary> Looks up a localized string similar to Enabling UWP local loopback for {0}.... </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.EnablingLoopbackFailed"> <summary> Looks up a localized string similar to Unable to enable UWP local loopback for {0}! You may not be able to communicate with the Factory Orchestrator Service from {0}.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.EndContainerOutput"> <summary> Looks up a localized string similar to End Container Process Output. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.EndWaitingForExternalResult"> <summary> Looks up a localized string similar to A FactoryOrchestratorClient completed the TaskRun with Status: {0}, Exit code: {1}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.EveryBootAlreadyComplete"> <summary> Looks up a localized string similar to Every boot TaskLists already complete.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.EveryBootComplete"> <summary> Looks up a localized string similar to Every boot TaskLists complete.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.EveryBootFailed"> <summary> Looks up a localized string similar to Unable to complete every boot TaskLists!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.EveryBootRunningTaskList"> <summary> Looks up a localized string similar to Running every boot TaskList {0}.... </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.EveryBootWaiting"> <summary> Looks up a localized string similar to Waiting for every boot TaskLists to complete... (Mark tests as BackgroundTasks if you do not expect them to ever exit.). </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FactoryOrchestratorConnectionException"> <summary> Looks up a localized string similar to Failed to communicate with Factory Orchestrator Service on {0}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FactoryOrchestratorTaskListRunningException"> <summary> Looks up a localized string similar to Cannot perform operation because one or more TaskLists are actively running!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FactoryOrchestratorTaskListRunningExceptionWithGuid"> <summary> Looks up a localized string similar to Cannot perform operation because TaskList {0} is actively running!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FactoryOrchestratorUnkownGuidException"> <summary> Looks up a localized string similar to Guid is not valid!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FactoryOrchestratorUnkownGuidExceptionWithGuid"> <summary> Looks up a localized string similar to {0} is not valid!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FactoryOrchestratorUnkownGuidExceptionWithGuidAndType"> <summary> Looks up a localized string similar to {0} is not a valid {1}!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FactoryOrchestratorVersionMismatchException"> <summary> Looks up a localized string similar to Factory Orchestrator Service on {0} has version {1} which is incompatable with FactoryOrchestratorClient version {2}! Use Connect(true) or TryConnect(true) to ignore this error when connecting.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FileLoadSucceeded"> <summary> Looks up a localized string similar to Successfully loaded {0}.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FileNotFound"> <summary> Looks up a localized string similar to {0} not found.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FileNotFoundException"> <summary> Looks up a localized string similar to {0} does not exist!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FileSaveError"> <summary> Looks up a localized string similar to Target file {0} could not be saved!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.Finish"> <summary> Looks up a localized string similar to Finish. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FirstBootAlreadyComplete"> <summary> Looks up a localized string similar to First boot TaskList already complete!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FirstBootComplete"> <summary> Looks up a localized string similar to First boot TaskLists complete.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FirstBootFailed"> <summary> Looks up a localized string similar to Unable to complete first boot TaskLists!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FirstBootRunningTaskList"> <summary> Looks up a localized string similar to Running first boot TaskList {0}.... </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FirstBootWaiting"> <summary> Looks up a localized string similar to Waiting for first boot TaskLists to complete... (Mark tests as BackgroundTasks if you do not expect them to ever exit.). </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.FOXMLFileLoadException"> <summary> Looks up a localized string similar to Could not load {0} as FactoryOrchestratorXML!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.InvalidPathError"> <summary> Looks up a localized string similar to {0} is not a valid file or folder!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.InvalidTaskRunTypeException"> <summary> Looks up a localized string similar to TaskRun has an invalid TaskType!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.IpcAuthenticationError"> <summary> Looks up a localized string similar to FactoryOrchestratorClient could not validate remote certificate! This is most likely due to a distinguished server name mismatch or remote certificate hash value mismatch.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.IpcInvalidOperationError"> <summary> Looks up a localized string similar to Factory Orchestrator Service did not recognize the command! This is most likely due to a version mismatch between the Client and Service.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.LogFileCreationFailed"> <summary> Looks up a localized string similar to WARNING: Log File {0} could not be created. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.LogFolderMoveFailed"> <summary> Looks up a localized string similar to Could not move log folder!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.MoveContainerPathFailed"> <summary> Looks up a localized string similar to Unable to move file or folder {0} to {1} in container!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.NetworkAccessDisabled"> <summary> Looks up a localized string similar to Factory Orchestrator Service network access is disabled.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.NetworkAccessEnabled"> <summary> Looks up a localized string similar to Factory Orchestrator Service network access is enabled.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.NoContainerIdFound"> <summary> Looks up a localized string similar to No valid container Id found!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.NoContainerIpFound"> <summary> Looks up a localized string similar to No valid container IP address found!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.NoMethodFound"> <summary> Looks up a localized string similar to Could not find method with name {0}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.NoTaskListsException"> <summary> Looks up a localized string similar to No TaskLists to save!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.OpenNonMutableKeyFailed"> <summary> Looks up a localized string similar to Could not open NonMutable registry key!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.OpenVolatileKeyFailed"> <summary> Looks up a localized string similar to Could not open Volatile registry key!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ProcessExited"> <summary> Looks up a localized string similar to Process exited.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ProcessStartError"> <summary> Looks up a localized string similar to Process failed to start!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ReadyToCommunicate"> <summary> Looks up a localized string similar to Factory Orchestrator Service is ready to communicate with client(s).. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.RedirectingToRunAsRDUser"> <summary> Looks up a localized string similar to {0} is a Win32 GUI program. Redirecting to run as the remote user.... </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.RedirectingUWPToRunAs"> <summary> Looks up a localized string similar to {0} is a UWP app targeted to run in the container. Redirecting to run in the container as the remote user.... </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.RunningGuiAsSystemWarning"> <summary> Looks up a localized string similar to WARNING: {0} is a Win32 GUI program. It may not run properly as SYSTEM.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ServiceAlreadyCreatedError"> <summary> Looks up a localized string similar to FactoryOrchestratorService already created! Only one instance allowed.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ServiceErrored"> <summary> Looks up a localized string similar to Service {0} errored with exception. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ServiceProcessExitedWithError"> <summary> Looks up a localized string similar to {0} exited with {1}!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ServiceProcessStartFailed"> <summary> Looks up a localized string similar to {0} never started!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ServiceProcessTimedOut"> <summary> Looks up a localized string similar to {0} did not exit before {1}ms!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ServiceStarted"> <summary> Looks up a localized string similar to Service {0} started. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ServiceStarting"> <summary> Looks up a localized string similar to Service {0} starting. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ServiceStatusTypeException"> <summary> Looks up a localized string similar to Argument must be FOServiceStatus or FOVolatileServiceStatus object!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ServiceStopped"> <summary> Looks up a localized string similar to Service {0} stopped. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ServiceStoppedWithName"> <summary> Looks up a localized string similar to Factory Orchestrator Service stopped.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ServiceStopping"> <summary> Looks up a localized string similar to Service {0} stopping. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.ServiceStopSaveError"> <summary> Looks up a localized string similar to Unable to save TaskLists on service stop!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.SourceDirectoryNotFound"> <summary> Looks up a localized string similar to Source directory does not exist or could not be found:. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.Start"> <summary> Looks up a localized string similar to Start. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.StartContainerOutput"> <summary> Looks up a localized string similar to Start Container Process Output. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.TaefCheckFailed"> <summary> Looks up a localized string similar to Unable to invoke TE.exe to validate possible TAEF test: {0}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.TaefCheckReturnedError"> <summary> Looks up a localized string similar to TE.exe returned error {0} when trying to validate possible TAEF test: {1}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.TaefCheckTimeout"> <summary> Looks up a localized string similar to TE.exe timed out trying to validate possible TAEF test: {0}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.TaefValidationFailed"> <summary> Looks up a localized string similar to Unable to validate possible TAEF test: {0}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.TaskBaseDeserializationException"> <summary> Looks up a localized string similar to Trying to deserialize an unknown task type!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.TaskBaseSerializationException"> <summary> Looks up a localized string similar to Trying to serialize an unknown task type!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.TaskListCountMismatch"> <summary> Looks up a localized string similar to Server has {0} TaskLists but new order has only {1} GUIDs!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.TaskListExistsAlready"> <summary> Looks up a localized string similar to TaskList with guid {0} already exists!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.TaskListSaveFailed"> <summary> Looks up a localized string similar to Could not save TaskLists to {0}!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.TaskListToString"> <summary> Looks up a localized string similar to TaskList {0} ({1}) with status {2}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.TaskRunUnhandledExceptionError"> <summary> Looks up a localized string similar to Error: TaskRun threw an unhandled exception during execution!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.TooManyMethodsFound"> <summary> Looks up a localized string similar to More than one method with name {0}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.UnableToParseError"> <summary> Looks up a localized string similar to Unable to parse {0}!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.Unknown"> <summary> Looks up a localized string similar to Unknown. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.UnsupportedGuidType"> <summary> Looks up a localized string similar to Unsupported guid type to poll!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.WaitingForContainerStart"> <summary> Looks up a localized string similar to Waiting for the container to be ready.... </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.WaitingForContainerTaskRun"> <summary> Looks up a localized string similar to TaskRun {0} is waiting on a result run by the container.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.WaitingForExternalTaskRun"> <summary> Looks up a localized string similar to TaskRun {0} is waiting on an external result.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.WDPAppLaunchFailed"> <summary> Looks up a localized string similar to Error: Failed to launch AUMID: {0}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.WDPAppLaunchFailed2"> <summary> Looks up a localized string similar to Error: Device Portal is required for app launch and may not be running on the system or may not support HTTP with no authentication.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.WDPAppLaunchFailed3"> <summary> Looks up a localized string similar to Error: If it is running, the AUMID may be incorrect.. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.WDPAppLaunchSucceeded"> <summary> Looks up a localized string similar to Sucessfully launched app with AUMID: {0}. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.WDPError"> <summary> Looks up a localized string similar to Windows Device Portal failed with error. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.WDPHttpError"> <summary> Looks up a localized string similar to Windows Device Portal failed with HTTP error. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.WDPNotRunningError"> <summary> Looks up a localized string similar to Windows Device Portal may not be running or may not support HTTP with no authentication!. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.Resources.WindowsOnlyError"> <summary> Looks up a localized string similar to {0} is only supported on Windows!. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorException"> <summary> A generic Factory Orchestrator exception. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorException"/> class. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorException"/> class. </summary> <param name="message">The message that describes the error.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorException"/> class. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorException.#ctor(System.String,System.Nullable{System.Guid},System.Exception)"> <summary> Constructor. </summary> <param name="message">Error message.</param> <param name="guid">The GUID this Exception relates to.</param> <param name="innerException">Inner Exception(s)</param> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorException.Guid"> <summary> The GUID this Exception relates to. NULL if it is not related to a specific object. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorTaskListRunningException"> <summary> An exception denoting a running TaskList is preventing the operation from succeeding. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorTaskListRunningException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorTaskListRunningException"/> class. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorTaskListRunningException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorTaskListRunningException"/> class. </summary> <param name="message">The message that describes the error.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorTaskListRunningException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorTaskListRunningException"/> class. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorTaskListRunningException.#ctor(System.Guid)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorTaskListRunningException"/> class. </summary> <param name="guid">The TaskList GUID.</param> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorUnkownGuidException"> <summary> An exception denoting the given GUID is not recognized by Factory Orchestrator. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorUnkownGuidException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorUnkownGuidException"/> class. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorUnkownGuidException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorUnkownGuidException"/> class. </summary> <param name="message">The message that describes the error.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorUnkownGuidException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorUnkownGuidException"/> class. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorUnkownGuidException.#ctor(System.Guid)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorUnkownGuidException"/> class. </summary> <param name="guid">The unkonwn GUID.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorUnkownGuidException.#ctor(System.Guid,System.Type)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorUnkownGuidException"/> class. </summary> <param name="guid">The unkonwn GUID.</param> <param name="type">The type of the GUID.</param> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerException"> <summary> An exception denoting an issue with the container on the device. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerException"/> class. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerException"/> class. </summary> <param name="message">The message that describes the error.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerException"/> class. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerException.#ctor(System.String,System.Nullable{System.Guid},System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerException"/> class. </summary> <param name="message">Error message.</param> <param name="guid">The GUID this Exception relates to.</param> <param name="innerException">Inner Exception(s)</param> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerDisabledException"> <summary> An exception denoting that container support is disabled. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerDisabledException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerDisabledException"/> class. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerDisabledException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerDisabledException"/> class. </summary> <param name="message">The message that describes the error.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerDisabledException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerDisabledException"/> class. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerDisabledException.#ctor(System.String,System.Nullable{System.Guid},System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorContainerDisabledException"/> class. </summary> <param name="message">Error message.</param> <param name="guid">The GUID this Exception relates to.</param> <param name="innerException">Inner Exception(s)</param> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXmlException"> <summary> An exception denoting an issue with given FactoryOrchestratorXML file. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXmlException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXmlException"/> class. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXmlException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXmlException"/> class. </summary> <param name="message">The message that describes the error.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXmlException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXmlException"/> class. </summary> <param name="message">The error message that explains the reason for the exception.</param> <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.ExceptionExtensions"> <summary> Extends the Exception class. </summary> <exclude/> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.ExceptionExtensions.AllExceptionsToString(System.Exception)"> <summary> Returns a string describing the given Exception including all inner exceptions. </summary> <param name="ex">The Exception.</param> <returns>A string describing the given Exception including all inner exceptions.</returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.TaskStatus"> <summary> The status of a Task, TaskRun, or TaskList. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskStatus.Passed"> <summary> The Task passed with no errors. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskStatus.Failed"> <summary> The Task failed. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskStatus.Aborted"> <summary> The Task was cancelled. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskStatus.Timeout"> <summary> The Task hit its timeout and was cancelled. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskStatus.Running"> <summary> The Task is actively running. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskStatus.NotRun"> <summary> The Task has never been run. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskStatus.RunPending"> <summary> The Task is queued to run. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskStatus.WaitingForExternalResult"> <summary> The Task is waiting for its result from a client. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskStatus.Unknown"> <summary> The Task state is unknown, likely due to a Service error. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.TaskType"> <summary> The type of Task. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskType.Executable"> <summary> The Task is a executable (exe) task. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskType.ConsoleExe"> <summary> The Task is a executable (exe) task. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskType.TAEFDll"> <summary> The Task is a TAEF test. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskType.External"> <summary> The Task is an external task. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskType.UWP"> <summary> The Task is a UWP app. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskType.PowerShell"> <summary> The Task is a PowerShell Core script. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskType.CommandLine"> <summary> The Task is a batch file or shell script. </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.TaskType.BatchFile"> <summary> The Task is a Command Prompt script. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.TaskBaseEqualityComparer"> <summary> Comparer for Task objects </summary> <exclude/> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.TaskBase"> <summary> 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. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.#ctor(Microsoft.FactoryOrchestrator.Core.TaskType)"> <summary> Constructor. </summary> <param name="type">The Task type.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.#ctor(System.String,Microsoft.FactoryOrchestrator.Core.TaskType)"> <summary> Constructor. </summary> <param name="type">The Task type.</param> <param name="taskPath">The Task path.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.DeepCopy"> <summary> Create a "deep" copy of the Task. </summary> <returns></returns> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.Name"> <summary> The friendly name of the Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.Type"> <summary> The type of the Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.Path"> <summary> The path to the file used for the Task such an Exe. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.Arguments"> <summary> The arguments passed to the Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.Guid"> <summary> The GUID identifying the Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.LatestTaskRunTimeStarted"> <summary> The time the latest run of this Task started. NULL if it has never started. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.LatestTaskRunTimeFinished"> <summary> The time the latest run of this Task finished. NULL if it has never finished. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.LatestTaskRunStatus"> <summary> The status of the latest run of this Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.LatestTaskRunPassed"> <summary> True if the latest run of this Task passed. NULL if it has never been run. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.LatestTaskRunExitCode"> <summary> The exit code of the latest run of this Task. NULL if it has never completed. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.LatestTaskRunRunTime"> <summary> The amount of time elapsed while running the latest run of this Task. NULL if it has never started. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.LatestTaskRunGuid"> <summary> GUID of the latest run of this Task. NULL if it has never started. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.IsRunningOrPending"> <summary> True if the Task is running or queued to run. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.TimeoutSeconds"> <summary> The timeout for this Task, in seconds. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.TaskRunGuids"> <summary> The GUIDs for all runs of this Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.RunByServer"> <summary> True if this Task is run by the server, such as an ExecutableTask. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.RunByClient"> <summary> True if this Task is run by the client, such as an ExternalTask. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.AbortTaskListOnFailed"> <summary> If true, the TaskList running this Task is aborted if this Task fails. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.MaxNumberOfRetries"> <summary> The number of re-runs the Task automatically attempts if the run fails. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.TimesRetried"> <summary> The number of reties so far for this latest run. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.RunInContainer"> <summary> If true, the task is executed inside the Win32 container. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.ShouldSerializeLatestTaskRunTimeStarted"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.ShouldSerializeLatestTaskRunStatus"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.ShouldSerializeLatestTaskRunTimeFinished"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.ShouldSerializeLatestTaskRunExitCode"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.ShouldSerializeTaskRunGuids"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.ShouldSerializeTimeoutSeconds"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.ShouldSerializeTimesRetried"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.ShouldSerializeMaxNumberOfRetries"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.ShouldSerializeAbortTaskListOnFailed"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.ShouldSerializeRunInContainer"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. </summary> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.GetHashCode"> <summary> Returns a hash code for this instance. </summary> <returns> A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. </returns> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskBase.TaskLock"> <summary> Lock used by the server when updating values in the Task object. Clients should not use. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskBase.CreateTaskFromTaskRun(Microsoft.FactoryOrchestrator.Core.TaskRun)"> <summary> Creates a Task object from a TaskRun object. </summary> <param name="run">The TaskRun.</param> <returns>a TaskBase object representing the Task defined by the Run.</returns> <exception cref="T:System.ComponentModel.InvalidEnumArgumentException">Given TaskRun has an invalid TaskType</exception> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.ExecutableTask"> <summary> 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. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.ExecutableTask.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.ExecutableTask"/> class. </summary> <param name="taskPath">The task path.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.ExecutableTask.#ctor(System.String,Microsoft.FactoryOrchestrator.Core.TaskType)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.ExecutableTask"/> class. </summary> <param name="taskPath">The Task path.</param> <param name="type">The Task type.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.ExecutableTask.ToString"> <summary> Converts to string. </summary> <returns> A <see cref="T:System.String" /> that represents this instance. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.ExecutableTask.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. </summary> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.ExecutableTask.Name"> <summary> The friendly name of the Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.ExecutableTask.BackgroundTask"> <summary> Denotes if this Task is run as a background task. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.PowerShellTask"> <summary> 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. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.PowerShellTask.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.PowerShellTask"/> class. </summary> <param name="scriptPath">The script path.</param> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PowerShellTask.Name"> <summary> The friendly name of the Task. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.PowerShellTask.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. </summary> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.BatchFileTask"> <summary> 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. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.BatchFileTask.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.BatchFileTask"/> class. </summary> <param name="scriptPath">The script path.</param> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.BatchFileTask.Name"> <summary> The friendly name of the Task. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.BatchFileTask.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. </summary> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.CommandLineTask"> <summary> 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. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.CommandLineTask.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.CommandLineTask"/> class. </summary> <param name="scriptPath">The script path.</param> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.TAEFTest"> <summary> 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. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TAEFTest.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.TAEFTest"/> class. </summary> <param name="testPath">The test path.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TAEFTest.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. </summary> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.ExternalTask"> <summary> An ExternalTest is a task run outside of the FactoryOrchestratorServer. task results must be returned to the server via SetTaskRunStatus(). </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.ExternalTask.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.ExternalTask"/> class. </summary> <param name="testName">Name of the Task.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.ExternalTask.#ctor(System.String,System.String,Microsoft.FactoryOrchestrator.Core.TaskType)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.ExternalTask"/> class. </summary> <param name="taskPath">The task path.</param> <param name="testName">Name of the Task.</param> <param name="type">The external Task type.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.ExternalTask.ToString"> <summary> Converts to string. </summary> <returns> A <see cref="T:System.String" /> that represents this instance. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.ExternalTask.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. </summary> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.ExternalTask.Name"> <summary> The friendly name of the Task. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.UWPTask"> <summary> 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(). </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.UWPTask.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.UWPTask"/> class. </summary> <param name="packageFamilyName">The package family name (PFN).</param> <param name="testFriendlyName">A friendly name for the app.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.UWPTask.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.UWPTask"/> class. </summary> <param name="packageFamilyName">The package family name (PFN).</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.UWPTask.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. </summary> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.UWPTask.Name"> <summary> The friendly name of the Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.UWPTask.AutoPassedIfLaunched"> <summary> Gets or sets a value indicating whether this Task is automatically marked as Passed if the app is launched. </summary> <value> If <c>true</c>, if this UWP app is successfully invoked, the TaskRun is marked as passed; otherwise, if <c>false</c>, the TaskRun must be manually passed via UpdateTaskRun(). </value> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.UWPTask.TerminateOnCompleted"> <summary> Gets or sets a value indicating whether this UWP app is terminated when the Task is completed (Passed or Failed). If AutoPassedIfLaunched is <c>true</c>, this value is ignored. </summary> <value> If <c>true</c>, the app is automatically terminated when the TaskRun is completed. </value> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.TaskList"> <summary> A TaskList is a grouping of Factory Orchestrator Tasks. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskList.#ctor(System.String,System.Guid)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.TaskList"/> class. Used for editing an existing TaskList. </summary> <param name="name">The TaskList name.</param> <param name="guid">The GUID for the TaskList.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskList.ValidateTaskList"> <summary> Validates the TaskList is compliant with the XSD schema and other requirements. Will assign a random Guid to any Task missing one. </summary> <exception cref="T:System.Xml.Schema.XmlSchemaValidationException">If the TaskList has an issue</exception> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskList.TaskListStatus"> <summary> The status of the TaskList. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskList.IsRunningOrPending"> <summary> True if the TaskList is running or queued to run. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskList.ToString"> <summary> Converts to string. </summary> <returns> A <see cref="T:System.String" /> that represents this instance. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskList.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. </summary> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskList.GetHashCode"> <summary> Returns a hash code for this instance. </summary> <returns> A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskList.ShouldSerializeTerminateBackgroundTasksOnCompletion"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskList.ShouldSerializeBackgroundTasks"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskList.ShouldSerializeTasks"> <summary> XmlSerializer calls to check if this should be serialized. </summary> <returns>true if it should be serialized.</returns> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskList.Tasks"> <summary> The Tasks in the TaskList. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskList.BackgroundTasks"> <summary> Background Tasks in the TaskList. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskList.Guid"> <summary> The GUID identifying this TaskList. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskList.Name"> <summary> The name of this TaskList. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskList.RunInParallel"> <summary> If true, Tasks in this TaskList are run in parallel. Order is non-deterministic. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskList.AllowOtherTaskListsToRun"> <summary> If false, while this TaskList is running no other TaskList may run. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskList.TerminateBackgroundTasksOnCompletion"> <summary> If true, Background Tasks defined in this TaskList are forcibly terminated when the TaskList stops running. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.TaskRun"> <summary> A TaskRun represents one instance of executing any single Task. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskRun.#ctor(Microsoft.FactoryOrchestrator.Core.TaskBase)"> <summary> task Run shared constructor. </summary> <param name="owningTask"></param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskRun.DeepCopy"> <summary> Create a "deep" copy of the TaskRun. WARNING: If the object is a ServerTaskRun information is lost! </summary> <returns></returns> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.TaskOutput"> <summary> The output of the Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.OwningTaskGuid"> <summary> The GUID of the Task which created this run. NULL if this run is not associated with a Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.TaskName"> <summary> The name of the Task (at the time the run started). </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.TaskPath"> <summary> The path of the Task (at the time the run started). </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.Arguments"> <summary> The arguments of the Task (at the time the run started). </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.BackgroundTask"> <summary> Denotes if this TaskRun is for a background task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.TaskType"> <summary> The type of the Task which created this run. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.Guid"> <summary> The GUID identifying this TaskRun. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.TimeStarted"> <summary> The time this run started. NULL if it has never started. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.TimeFinished"> <summary> The time this run finished. NULL if it has never finished. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.TaskStatus"> <summary> The status of this run. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.LogFilePath"> <summary> The path to the log file for this run. NULL if it is not logged to a file. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.ExitCode"> <summary> The exit code of this run. NULL if it has not finished. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.TimeoutSeconds"> <summary> The timeout for this run. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.RunInContainer"> <summary> If true, the TaskRun is executed inside the Win32 container. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.RunByServer"> <summary> True if this TaskRun is run by the server, such as an ExecutableTask. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.RunByClient"> <summary> True if this TaskRun is run by the client, such as an ExternalTask. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.TaskRunComplete"> <summary> True if this run is finished executing. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskRun.RunTime"> <summary> The amount of time this run executed for. NULL if it has never started. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskRun.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. </summary> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskRun.GetHashCode"> <summary> Returns a hash code for this instance. </summary> <returns> A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. </returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXML"> <summary> This class is used to save and load TaskLists from an XML file. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXML.#ctor"> <summary> Constructor. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXML.TaskLists"> <summary> The TaskLists in the XML file. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXML.PostDeserialize"> <summary> Create Guids for any imported task or tasklist that is missing one. Create Tests dictionary. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXML.Load(System.String)"> <summary> Loads the TaskLists in a FactoryOrchestratorXML file. </summary> <param name="filename">The FactoryOrchestratorXML file to load.</param> <returns>a FactoryOrchestratorXML object that can then be parsed by the Server.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.FactoryOrchestratorXML.Save(System.String)"> <summary> Saves a FactoryOrchestratorXML object to the given file. The file is overwritten if it exists. </summary> <param name="filename">The path of the FactoryOrchestratorXML file you want to create.</param> <returns></returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.TaskListSummary"> <summary> A helper class containing basic information about a TaskList. Use to quickly update clients about TaskLists and their statuses. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskListSummary.#ctor(System.Guid,System.String,Microsoft.FactoryOrchestrator.Core.TaskStatus,System.Boolean,System.Boolean,System.Boolean)"> <summary> Creates a new TaskListSummary. </summary> <param name="guid"></param> <param name="name"></param> <param name="status"></param> <param name="runInParallel"></param> <param name="allowOtherTaskListsToRun"></param> <param name="terminateBackgroundTasksOnCompletion"></param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskListSummary.#ctor(Microsoft.FactoryOrchestrator.Core.TaskListSummary)"> <summary> Creates a new TaskListSummary. </summary> <param name="summary">The summary to copy from.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskListSummary.ToString"> <summary> Converts to string. </summary> <returns> A <see cref="T:System.String" /> that represents this instance. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskListSummary.GetHashCode"> <summary> Returns a hash code for this instance. </summary> <returns> A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskListSummary.Equals(System.Object)"> <summary> Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. </summary> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskListSummary.Equals(Microsoft.FactoryOrchestrator.Core.TaskListSummary)"> <summary> Determines whether the specified <see cref="T:Microsoft.FactoryOrchestrator.Core.TaskListSummary" />, is equal to this instance. </summary> <param name="rhs">The <see cref="T:Microsoft.FactoryOrchestrator.Core.TaskListSummary" /> to compare with this instance.</param> <returns></returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskListSummary.op_Equality(Microsoft.FactoryOrchestrator.Core.TaskListSummary,Microsoft.FactoryOrchestrator.Core.TaskListSummary)"> <summary> Implements the operator ==. </summary> <param name="first">The first.</param> <param name="second">The second.</param> <returns> The result of the operator. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.TaskListSummary.op_Inequality(Microsoft.FactoryOrchestrator.Core.TaskListSummary,Microsoft.FactoryOrchestrator.Core.TaskListSummary)"> <summary> Implements the operator !=. </summary> <param name="first">The first.</param> <param name="second">The second.</param> <returns> The result of the operator. </returns> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskListSummary.Guid"> <summary> The GUID identifying the TaskList. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskListSummary.Status"> <summary> The status of the TaskList. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskListSummary.Name"> <summary> The name of the TaskList. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskListSummary.RunInParallel"> <summary> If true, Tasks in this TaskList are run in parallel. Order is non-deterministic. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskListSummary.AllowOtherTaskListsToRun"> <summary> If false, while this TaskList is running no other TaskList may run. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskListSummary.TerminateBackgroundTasksOnCompletion"> <summary> If true, Background Tasks defined in this TaskList are forcibly terminated when the TaskList stops running. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.TaskListSummary.IsRunningOrPending"> <summary> True if the TaskList is running or queued to run. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.LockingList`1"> <summary> A wrapper for the List class that locks the list on any modification operations. </summary> <typeparam name="T"></typeparam> <seealso cref="T:System.Collections.Generic.ICollection`1" /> <seealso cref="T:System.Collections.Generic.IEnumerable`1" /> <seealso cref="T:System.Collections.IEnumerable" /> <seealso cref="T:System.Collections.Generic.IList`1" /> <seealso cref="T:System.Collections.Generic.IReadOnlyCollection`1" /> <seealso cref="T:System.Collections.Generic.IReadOnlyList`1" /> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.LockingList`1.Item(System.Int32)"> <summary> Gets or sets the item T at the specified index. </summary> <value> The item T. </value> <param name="index">The index.</param> <returns></returns> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.LockingList`1.Count"> <summary> Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"></see>. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.LockingList`1.IsReadOnly"> <summary> Gets a value indicating whether the <see cref="T:System.Collections.ICollection"></see> is read-only. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.LockingList`1.IsFixedSize"> <summary> Gets a value indicating whether this instance is fixed size. </summary> <value> <c>true</c> if this instance is fixed size; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.LockingList`1.IsSynchronized"> <summary> Gets a value indicating whether this instance is synchronized. </summary> <value> <c>true</c> if this instance is synchronized; otherwise, <c>false</c>. </value> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.LockingList`1.SyncRoot"> <summary> Gets the synchronize root. </summary> <value> The synchronize root. </value> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.LockingList`1.Add(`0)"> <summary> Adds an item to the <see cref="T:System.Collections.ICollection"></see>. </summary> <param name="item">The object to add to the <see cref="T:System.Collections.ICollection"></see>.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.LockingList`1.Clear"> <summary> Removes all items from the <see cref="T:System.Collections.ICollection"></see>. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.LockingList`1.Contains(`0)"> <summary> Determines whether this instance contains the object. </summary> <param name="item">The object to locate in the <see cref="T:System.Collections.ICollection"></see>.</param> <returns> true if <paramref name="item">item</paramref> is found in the <see cref="T:System.Collections.ICollection"></see>; otherwise, false. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.LockingList`1.CopyTo(`0[],System.Int32)"> <summary> Copies the elements of the <see cref="T:System.Collections.ICollection"></see> to an <see cref="T:System.Array"></see>, starting at a particular <see cref="T:System.Array"></see> index. </summary> <param name="array">The one-dimensional <see cref="T:System.Array"></see> that is the destination of the elements copied from <see cref="T:System.Collections.ICollection"></see>. The <see cref="T:System.Array"></see> must have zero-based indexing.</param> <param name="arrayIndex">The zero-based index in array at which copying begins.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.LockingList`1.GetEnumerator"> <summary> Returns an enumerator that iterates through the collection. </summary> <returns> An enumerator that can be used to iterate through the collection. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.LockingList`1.IndexOf(`0)"> <summary> Determines the index of a specific item in the <see cref="T:System.Collections.IList"></see>. </summary> <param name="item">The object to locate in the <see cref="T:System.Collections.IList"></see>.</param> <returns> The index of <paramref name="item">item</paramref> if found in the list; otherwise, -1. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.LockingList`1.Insert(System.Int32,`0)"> <summary> Inserts an item to the <see cref="T:System.Collections.IList"></see> at the specified index. </summary> <param name="index">The zero-based index at which item should be inserted.</param> <param name="item">The object to insert into the <see cref="T:System.Collections.IList"></see>.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.LockingList`1.Remove(`0)"> <summary> Removes the first occurrence of a specific object from the <see cref="T:System.Collections.ICollection"></see>. </summary> <param name="item">The object to remove from the <see cref="T:System.Collections.ICollection"></see>.</param> <returns> true if <paramref name="item">item</paramref> was successfully removed from the <see cref="T:System.Collections.ICollection"></see>; otherwise, false. This method also returns false if <paramref name="item">item</paramref> is not found in the original <see cref="T:System.Collections.ICollection"></see>. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.LockingList`1.RemoveAt(System.Int32)"> <summary> Removes the <see cref="T:System.Collections.IList"></see> item at the specified index. </summary> <param name="index">The zero-based index of the item to remove.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.LockingList`1.GetRange(System.Int32,System.Int32)"> <summary> Creates a shallow copy of a range of elements in the source System.Collections.Generic.List`1. </summary> <param name="index">The zero-based System.Collections.Generic.List`1 index at which the range starts.</param> <param name="count">The number of elements in the range.</param> <returns></returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.LockingList`1.AddRange(System.Collections.Generic.IEnumerable{`0})"> <summary> Adds the elements of the specified collection to the end of the System.Collections.Generic.List`1. </summary> <param name="collection">The collection whose elements should be added to the end of the System.Collections.Generic.List`1. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.</param> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.NotifyPropertyChangedBase"> <summary> Abstract class to implement INotifyPropertyChanged </summary> <exclude/> </member> <member name="E:Microsoft.FactoryOrchestrator.Core.NotifyPropertyChangedBase.PropertyChanged"> <summary> Event when a Property changes. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.NotifyPropertyChangedBase.NotifyPropertyChanged(System.String)"> <summary> Call when a Property changes. </summary> <param name="propertyName">Name of the Property that changed.</param> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.ApplicationInstallStatus"> <summary> Application install status </summary> <exclude/> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ApplicationInstallStatus.None"> <summary> No install status </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ApplicationInstallStatus.InProgress"> <summary> Installation is in progress </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ApplicationInstallStatus.Completed"> <summary> Installation is completed </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ApplicationInstallStatus.Failed"> <summary> Installation failed </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.ApplicationInstallPhase"> <summary> Install phase </summary> <exclude/> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ApplicationInstallPhase.Idle"> <summary> Idle phase </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ApplicationInstallPhase.UninstallingPreviousVersion"> <summary> Uninstalling the previous version </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ApplicationInstallPhase.CopyingFile"> <summary> Copying the package file </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.ApplicationInstallPhase.Installing"> <summary> Installing the package </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.WDPHelpers"> <summary> Helper APIs for Windows Device Portal. </summary> <exclude/> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.WDPHelpers.WdpHttpClient"> <summary> The Windows Device Portal HTTP client. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.WDPHelpers.CreateAppInstallEndpointAndBoundaryString(System.String,System.String,System.Int32,System.Uri@,System.String@)"> <summary> Builds the application installation Uri and generates a unique boundary string for the multipart form data. </summary> <param name="packageName">The name of the application package.</param> <param name="ipAddress">The ip address of the device to install the app on</param> <param name="port">The port for WDP on the target device.</param> <param name="uri">The endpoint for the install request.</param> <param name="boundaryString">Unique string used to separate the parts of the multipart form data.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.WDPHelpers.BuildEndpoint(System.Uri,System.String,System.String)"> <summary> Constructs a fully formed REST API endpoint uri. </summary> <param name="baseUri">The base uri (typically, just scheme and authority).</param> <param name="path">The path to the REST API method (ex: api/control/restart).</param> <param name="payload">Parameterized data required by the REST API.</param> <returns>Uri object containing the complete path and query string required to issue the REST API call.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.WDPHelpers.InstallAppWithWDP(System.String,System.Collections.Generic.List{System.String},System.String,System.String,System.Int32)"> <summary> Installs an app package application with Windows Device Portal. </summary> <param name="appFilePath">The app package file path.</param> <param name="dependentAppsFilePaths">The dependent app packages file paths.</param> <param name="certFilePath">The certificate file path.</param> <param name="ipAddress">The ip address of the device to install the app on.</param> <param name="port">The port for WDP on the target device.</param> <exception cref="T:System.IO.FileNotFoundException"> </exception> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.WDPHelpers.CloseAppWithWDP(System.String,System.String,System.Int32)"> <summary> Closes a running app package application with Windows Device Portal. </summary> <param name="app">The app package to exit .</param> <param name="ipAddress">The ip address of the device to exit the app on.</param> <param name="port">The port for WDP on the target device.</param> <exception cref="T:System.ArgumentException"> </exception> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.WDPHelpers.GetInstalledAppPackagesAsync(System.String,System.Int32)"> <summary> Gets the collection of applications installed on the device. </summary> <param name="ipAddress">The ip address of the device to query.</param> <param name="port">The port for WDP on the target device.</param> <returns>AppPackages object containing the list of installed application packages.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.WDPHelpers.GetRunningProcessesAsync(System.String,System.Int32)"> <summary> Gets the collection of running processes on the device. </summary> <param name="ipAddress">The ip address of the device to query.</param> <param name="port">The port for WDP on the target device.</param> <returns>RunningProcesses object containing the list of running processses.</returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.HttpMultipartFileContent"> <exclude/> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.HttpMultipartFileContent.items"> <summary> List of items to transfer </summary> </member> <member name="F:Microsoft.FactoryOrchestrator.Core.HttpMultipartFileContent.boundaryString"> <summary> Boundary string </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.HttpMultipartFileContent.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.HttpMultipartFileContent" /> class. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.HttpMultipartFileContent.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Core.HttpMultipartFileContent" /> class. </summary> <param name="boundary">The boundary string for file content.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.HttpMultipartFileContent.Add(System.String)"> <summary> Adds a file to the list of items to transfer </summary> <param name="filename">The name of the file to add</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.HttpMultipartFileContent.AddRange(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds a range of files to the list of items to transfer </summary> <param name="filenames">List of files to add</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.HttpMultipartFileContent.SerializeToStreamAsync(System.IO.Stream,System.Net.TransportContext)"> <summary> Serializes the stream. </summary> <param name="outStream">Serialized Stream</param> <param name="context">The Transport Context</param> <returns>Task tracking progress</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.HttpMultipartFileContent.TryComputeLength(System.Int64@)"> <summary> Computes required length for the transfer. </summary> <param name="length">The computed length value</param> <returns>Whether or not the length was successfully computed</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.HttpMultipartFileContent.GetFileHeader(System.IO.FileInfo)"> <summary> Gets the file header for the transfer </summary> <param name="info">Information about the file</param> <returns>A byte array with the file header information</returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.HttpErrorResponse"> <summary> Object containing additional error information from an HTTP response. </summary> <exclude/> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.HttpErrorResponse.ErrorCode"> <summary> Gets the ErrorCode </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.HttpErrorResponse.Code"> <summary> Gets the Code (used by some endpoints instead of ErrorCode). </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.HttpErrorResponse.ErrorMessage"> <summary> Gets the ErrorMessage </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.HttpErrorResponse.Reason"> <summary> Gets the Reason (used by some endpoints instead of ErrorMessage). </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.HttpErrorResponse.Success"> <summary> Gets a value indicating whether the operation succeeded. For an error this should generally be false if present. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.AppPackages"> <summary> Object representing a list of Application Packages </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.AppPackages.Packages"> <summary> Gets a list of the packages </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.AppPackages.ToString"> <summary> Presents a user readable representation of a list of AppPackages </summary> <returns>User readable list of AppPackages.</returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.PackageInfo"> <summary> object representing the package information </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PackageInfo.Name"> <summary> Gets package name </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PackageInfo.FamilyName"> <summary> Gets package family name </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PackageInfo.FullName"> <summary> Gets package full name </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PackageInfo.AppId"> <summary> Gets package relative Id </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PackageInfo.Publisher"> <summary> Gets package publisher </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PackageInfo.Version"> <summary> Gets package version </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PackageInfo.PackageOrigin"> <summary> Gets package origin, a measure of how the app was installed. PackageOrigin_Unknown = 0, PackageOrigin_Unsigned = 1, PackageOrigin_Inbox = 2, PackageOrigin_Store = 3, PackageOrigin_DeveloperUnsigned = 4, PackageOrigin_DeveloperSigned = 5, PackageOrigin_LineOfBusiness = 6 </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.PackageInfo.IsSideloaded"> <summary> Helper method to determine if the app was sideloaded and therefore can be used with e.g. GetFolderContentsAsync </summary> <returns> True if the package is sideloaded. </returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.PackageInfo.ToString"> <summary> Get a string representation of the package </summary> <returns>String representation</returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.PackageVersion"> <summary> Object representing a package version </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PackageVersion.Build"> <summary> Gets version build </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PackageVersion.Major"> <summary> Gets package Major number </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PackageVersion.Minor"> <summary> Gets package minor number </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PackageVersion.Revision"> <summary> Gets package revision </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.PackageVersion.Version"> <summary> Gets package version </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.PackageVersion.ToString"> <summary> Get a string representation of a version </summary> <returns>String representation</returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo"> <summary> Process Info. Contains app information if the process is an app. </summary> <exclude/> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.AppName"> <summary> Gets the app name. Only present if the process is an app. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.CpuUsage"> <summary> Gets CPU Usage as a percentage of available CPU resources (0-100) </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.Name"> <summary> Gets the image name </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.ProcessId"> <summary> Gets the process id (pid) </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.UserName"> <summary> Gets the user the process is running as. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.PackageFullName"> <summary> Gets the package full name. Only present if the process is an app. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.PageFile"> <summary> Gets the Page file usage info, in bytes </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.WorkingSet"> <summary> Gets the working set size, in bytes </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.PrivateWorkingSet"> <summary> Gets package working set, in bytes </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.SessionId"> <summary> Gets session id </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.TotalCommit"> <summary> Gets total commit, in bytes </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.VirtualSize"> <summary> Gets virtual size, in bytes </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.IsRunning"> <summary> Gets a value indicating whether or not the app is running (versus suspended). Only present if the process is an app. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.Publisher"> <summary> Gets publisher. Only present if the process is an app. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.Version"> <summary> Gets version. Only present if the process is an app. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.IsXAP"> <summary> Gets a value indicating whether or not the package is a XAP package. Only present if the process is an app. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.DeviceProcessInfo.ToString"> <summary> String representation of a process </summary> <returns>String representation</returns> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.AppVersion"> <summary> Object representing the app version. Only present if the process is an app. </summary> <exclude/> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.AppVersion.Major"> <summary> Gets the major version number </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.AppVersion.Minor"> <summary> Gets the minor version number </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.AppVersion.Build"> <summary> Gets the build number </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.AppVersion.Revision"> <summary> Gets the revision number </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Core.RunningProcesses"> <summary> Running processes </summary> <exclude/> </member> <member name="P:Microsoft.FactoryOrchestrator.Core.RunningProcesses.Processes"> <summary> Gets list of running processes. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.RunningProcesses.Contains(System.Int32)"> <summary> Checks to see if this process Id is in the list of processes </summary> <param name="processId">Process to look for</param> <returns>whether the process id was found</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Core.RunningProcesses.Contains(System.String,System.Boolean)"> <summary> Checks for a given package name </summary> <param name="packageName">Name of the package to look for</param> <param name="caseSensitive">Whether we should be case sensitive in our search</param> <returns>Whether the package was found</returns> </member> </members> </doc> |