Microsoft.FactoryOrchestrator.Client

10.3.5

Microsoft.FactoryOrchestrator.Client.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Microsoft.FactoryOrchestrator.Client</name>
    </assembly>
    <members>
        <member name="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient">
            <summary>
            An asynchronous class for Factory Orchestrator .NET clients. Use instances of this class to communicate with Factory Orchestrator Service(s).
            WARNING: Use FactoryOrchestratorUWPClient for UWP clients or your UWP app will crash!
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.#ctor(System.Net.IPAddress,System.Int32,System.String,System.String)">
            <summary>
            Creates a new FactoryOrchestratorClient instance. WARNING: Use FactoryOrchestratorUWPClient for UWP clients or your UWP app will crash!
            </summary>
            <param name="host">IP address of the device running Factory Orchestrator Service. Use IPAddress.Loopback for local device.</param>
            <param name="port">Port to use. Factory Orchestrator Service defaults to 45684.</param>
            <param name="serverIdentity">Distinguished name for the server defaults to FactoryServer.</param>
            <param name="certhash">Hash value for the server certificate defaults to E8BF0011168803E6F4AF15C9AFE8C9C12F368C8F.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.#ctor(System.Net.IPAddress,System.Net.Security.RemoteCertificateValidationCallback,System.Int32,System.String)">
            <summary>
            Creates a new FactoryOrchestratorClient instance. WARNING: Use FactoryOrchestratorUWPClient for UWP clients or your UWP app will crash!
            </summary>
            <param name="host">IP address of the device running Factory Orchestrator Service. Use IPAddress.Loopback for local device.</param>
            <param name="certificateValidationCallback">A System.Net.Security.RemoteCertificateValidationCallback delegate responsible for validating the server certificate.</param>
            <param name="port">Port to use. Factory Orchestrator Service defaults to 45684.</param>
            <param name="serverIdentity">Distinguished name for the server defaults to FactoryServer.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.DiscoverFactoryOrchestratorDevices(System.Int32,System.String,System.String)">
            <summary>
            Uses DNS-SD to find all Factory Orchestrator services on your local network.
            </summary>
            <param name="secondsToWait">Number of seconds to wait for services to respond</param>
            <param name="serverIdentity">The service certificate identity to use</param>
            <param name="certhash">The service certificate hash to use</param>
            <returns>List of FactoryOrchestratorClient representing all discovered clients</returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.Connect(System.Boolean)">
            <summary>
            Establishes a connection to the Factory Orchestrator Service.
            Throws an exception if it cannot connect.
            </summary>
            <param name="ignoreVersionMismatch">If true, ignore a Client-Service version mismatch.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.TryConnect(System.Boolean)">
            <summary>
            Attempts to establish a connection to the Factory Orchestrator Service.
            </summary>
            <param name="ignoreVersionMismatch">If true, ignore a Client-Service version mismatch.</param>
            <returns>true if it was able to connect.</returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.SendAndInstallApp(System.String,System.Collections.Generic.List{System.String},System.String)">
            <summary>
            Copies an app package to the Service and installs it. Requires Windows Device Portal.
            If the app package is already on the Service's computer, use InstallApp() instead.
            </summary>
            <param name="appFilename">Path on the Client's computer to the app package (.appx, .appxbundle, .msix, .msixbundle).</param>
            <param name="dependentPackages">List of paths on the Client's computer to the app's dependent packages.</param>
            <param name="certificateFile">Path on the Client'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.Client.FactoryOrchestratorClient.SendFileToDevice(System.String,System.String,System.Boolean)">
            <summary>
            Copies a file from the client to the device running Factory Orchestrator Service. Creates directories if needed.
            </summary>
            <param name="clientFilename">Path on client PC to the file to copy.</param>
            <param name="serverFilename">Path on device running Factory Orchestrator Service where the file will be saved.</param>
            <param name="sendToContainer">If true, send the file to the container running on the connected device.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.GetFileFromDevice(System.String,System.String,System.Boolean)">
            <summary>
            Copies a file from the device running Factory Orchestrator Service to the client. Creates directories if needed.
            </summary>
            <param name="serverFilename">Path on running Factory Orchestrator Service to the file to copy.</param>
            <param name="clientFilename">Path on client PC where the file will be saved.</param>
            <param name="getFromContainer">If true, get the file from the container running on the connected device.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.TryDeleteLocalFile(System.String)">
            <summary>
            Tries to delete a local file.
            </summary>
            <param name="clientFilename">The file to delete.</param>
            <returns></returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.GetDirectoryFromDevice(System.String,System.String,System.Boolean)">
            <summary>
            Copies a folder from the device running Factory Orchestrator Service to the client. Creates directories if needed.
            </summary>
            <param name="serverDirectory">Path on device running Factory Orchestrator Service to the folder to copy.</param>
            <param name="clientDirectory">Path on client PC where the folder will be saved.</param>
            <param name="getFromContainer">If true, get the file from the container running on the connected device.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.SendDirectoryToDevice(System.String,System.String,System.Boolean)">
            <summary>
            Copies a folder from the client to the device running Factory Orchestrator Service. Creates directories if needed.
            </summary>
            <param name="clientDirectory">Path on client PC to the folder to copy.</param>
            <param name="serverDirectory">Path on device running Factory Orchestrator Service where the folder will be saved.</param>
            <param name="sendToContainer">If true, copy the folder to the container running on the connected device.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.ShutdownDevice(System.UInt32)">
            <summary>
            Shutdown the device running Factory Orchestrator Service.
            </summary>
            <param name="secondsUntilShutdown">How long to delay shutdown, in seconds.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.RebootDevice(System.UInt32)">
            <summary>
            Reboot the device running Factory Orchestrator Service.
            </summary>
            <param name="secondsUntilReboot">How long to delay reboot, in seconds.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.GetClientVersionString">
            <summary>
            Gets the build number of FactoryOrchestratorClient.
            </summary>
            <returns></returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.CreateIpcRequest(System.String,System.Object[])">
            <summary>
            Creates the IPC request.
            </summary>
            <param name="methodName">Name of the method.</param>
            <param name="args">The arguments to the method.</param>
            <returns>IpcRequest object</returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.CreateIpcRequest(System.String)">
            <summary>
            Creates the IPC request.
            </summary>
            <param name="methodName">Name of the method. The method is assumed to have no parameters.</param>
            <returns>IpcRequest object</returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.CreateIpcException(System.Exception)">
            <summary>
            Creates a FactoryOrchestratorConnectionException or promotes the Server exception if needed.
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.CreateDirectory(System.String)">
            <summary>
            Creates a directory on the client.
            </summary>
            <param name="path">Directory to create.</param>
            <returns></returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.CreateClientFileReader(System.String)">
            <summary>
            Creates the client file reader.
            </summary>
            <param name="clientFilename">The client filename.</param>
            <returns></returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.CreateClientFileWriter(System.String)">
            <summary>
            Creates the client file writer. File is overwritten if it exists.
            </summary>
            <param name="clientFilename">The client filename.</param>
            <returns></returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.EnumerateLocalDirectories(System.String)">
            <summary>
            Enumerates local directories in a given folder.
            </summary>
            <param name="path">The directory to eumerate.</param>
            <returns></returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.EnumerateLocalFiles(System.String)">
            <summary>
            Enumerates local files in a given folder.
            </summary>
            <param name="path">The directory to eumerate.</param>
            <returns></returns>
        </member>
        <member name="E:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.OnConnected">
            <summary>
            Event raised when Client-Service connection is successfully established.
            </summary>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.IsLocalHost">
            <summary>
            True if Factory Orchestrator Service is running on the local device.
            </summary>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.IsConnected">
            <summary>
            True if the Client-Service connection is successfully established.
            </summary>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.IpAddress">
            <summary>
            The IP address of the connected device.
            </summary>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.Port">
            <summary>
            The port of the connected device used. Factory Orchestrator Service defaults to 45684.
            </summary>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.HostName">
            <summary>
            The hostname of the connected device.
            </summary>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.OSVersion">
            <summary>
            The OS version information of the connected device.
            </summary>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.ServerIdentity">
            <summary>
            Distinguished name for the server.
            </summary>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.CertificateHash">
            <summary>
            Hash value for server certificate.
            </summary>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.ServerCertificateValidationCallback">
            <summary>
            System.Net.Security.RemoteCertificateValidationCallback delegate responsible for validating the server certificate
            </summary>
        </member>
        <member name="F:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient._IpcClient">
            <summary>
            The IPC client used to communicate with the service.
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.Connect(System.String,System.String)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.ResetService(System.Boolean,System.Boolean)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetServiceEvents">
            <summary>
            Asynchronously Gets all Service events.
            </summary>
            <returns>List of all Service events.</returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.GetServiceEvents(System.DateTime)">
            <summary>
            Asynchronously Get all Service events since given time.
            </summary>
            <param name="timeLastChecked"></param>
            <returns>List of Service events.</returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.GetServiceEvents(System.UInt64)">
            <summary>
            Asynchronously Get all Service events since given index.
            </summary>
            <param name="lastEventIndex"></param>
            <returns>List of Service events.</returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.GetLastServiceError">
            <summary>
            Asynchronously Get last Service error.
            </summary>
            <returns></returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.GetServiceVersionString">
            <summary>
            Asynchronously Returns the version of Factory Orchestrator Service.
            </summary>
            <returns>string representing the Service version.</returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.GetOSVersionString">
            <summary>
            Asynchronously Returns the version of the OS.
            </summary>
            <returns>string representing the OS version.</returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.GetOSPlatform">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetOEMVersionString">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.SetTeExePath(System.String)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.SetLogFolder(System.String,System.Boolean)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetLogFolder">
            <summary>
            Asynchronously Gets the log folder path used by Factory Orchestrator.
            </summary>
            <returns>Path to the log folder.</returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.GetIpAddressesAndNicNames">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetContainerIpAddresses">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.IsExecutingBootTasks">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.IsContainerRunning">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetDisabledPages">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.IsNetworkAccessEnabled">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetWdpHttpPort">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetDnsHostName">
            <summary>
            Asynchronously Gets the DNS host name of the connected device.
            </summary>
            <returns>The DNS host name.</returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.CreateTaskListFromDirectory(System.String,System.Boolean)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.LoadTaskListsFromXmlFile(System.String)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.SaveTaskListToXmlFile(System.Guid,System.String)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.SaveAllTaskListsToXmlFile(System.String)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.CreateTaskListFromTaskList(Microsoft.FactoryOrchestrator.Core.TaskList)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetTaskListGuids">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetTaskListSummaries">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetBootTaskListGuids">
            <summary>
            Asynchronously Gets the GUID of every "boot" TaskList on the Service.
            </summary>
            <returns>The list of TaskList GUIDs.</returns>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.GetBootTaskListSummaries">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.QueryTaskList(System.Guid)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.DeleteTaskList(System.Guid)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.UpdateTaskList(Microsoft.FactoryOrchestrator.Core.TaskList)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.ReorderTaskLists(System.Collections.Generic.List{System.Guid})">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.QueryTask(System.Guid)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetInstalledApps">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetInstalledAppsDetailed">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.InstallApp(System.String,System.Collections.Generic.List{System.String},System.String)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.EnableLocalLoopbackForApp(System.String)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.RunAllTaskLists">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.RunTaskList(System.Guid,System.Int32)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.AbortAll">
            <summary>
            Asynchronously Stops all executing Tasks and/or TaskLists.
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.AbortTaskList(System.Guid)">
            <summary>
            Asynchronously Stops executing a TaskList.
            </summary>
            <param name="taskListGuid">The GUID of the TaskList to stop.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.AbortTaskRun(System.Guid)">
            <summary>
            Asynchronously Stops executing a TaskRun.
            </summary>
            <param name="taskRunGuid">The GUID of the TaskRun to stop.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient.RunExecutable(System.String,System.String,System.String,System.Boolean)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.RunApp(System.String)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.TerminateApp(System.String)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.RunTask(System.Guid)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.RunTask(Microsoft.FactoryOrchestrator.Core.TaskBase,System.Nullable{System.Guid})">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.UpdateTaskRun(Microsoft.FactoryOrchestrator.Core.TaskRun)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.QueryTaskRun(System.Guid)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.GetFile(System.String,System.Int64,System.Int32,System.Boolean)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.SendFile(System.String,System.Byte[],System.Boolean,System.Boolean)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.DeleteFileOrFolder(System.String,System.Boolean)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.MoveFileOrFolder(System.String,System.String,System.Boolean)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.EnumerateDirectories(System.String,System.Boolean,System.Boolean)">
            <summary>
            Asynchronously 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.Client.FactoryOrchestratorClient.EnumerateFiles(System.String,System.Boolean,System.Boolean)">
            <summary>
            Asynchronously 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.Client.IPCClientOnConnected">
            <summary>
            Signature for event handlers.
            </summary>
        </member>
        <member name="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorConnectionException">
            <summary>
            A FactoryOrchestratorConnectionException describes a Factory Orchestrator Client-Service connection issue.
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorConnectionException.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorConnectionException"/> class.
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorConnectionException.#ctor(System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorConnectionException"/> class.
            </summary>
            <param name="message">The message that describes the error.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorConnectionException.#ctor(System.String,System.Exception)">
            <summary>
            Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorConnectionException"/> 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.Client.FactoryOrchestratorConnectionException.#ctor(System.Net.IPAddress)">
            <summary>
            Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorConnectionException"/> class.
            </summary>
            <param name="ip">IP address the client is attempting to communicate with.</param>
        </member>
        <member name="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorVersionMismatchException">
            <summary>
            A FactoryOrchestratorVersionMismatchException is thrown if the Major versions of the Client and Service are incompatable.
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorVersionMismatchException.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorVersionMismatchException"/> class.
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorVersionMismatchException.#ctor(System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorVersionMismatchException"/> class.
            </summary>
            <param name="message">The message that describes the error.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorVersionMismatchException.#ctor(System.String,System.Exception)">
            <summary>
            Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorVersionMismatchException"/> 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.Client.FactoryOrchestratorVersionMismatchException.#ctor(System.Net.IPAddress,System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorVersionMismatchException"/> class.
            </summary>
            <param name="ip">The ip address of the Service.</param>
            <param name="serviceVersion">The service version.</param>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorVersionMismatchException.ClientVersion">
            <summary>
            Gets the client version.
            </summary>
            <value>
            The client version.
            </value>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorVersionMismatchException.ServiceVersion">
            <summary>
            Gets the service version.
            </summary>
            <value>
            The service version.
            </value>
        </member>
        <member name="T:Microsoft.FactoryOrchestrator.Client.ServerPoller">
            <summary>
            Factory Ochestrator uses a polling model. ServerPoller is used to create a polling thread for a given Factory Ochestrator GUID. It can optionally raise a ServerPollerEvent event via OnUpdatedObject.
            All Factory Orchestrator GUID types are supported.
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.ServerPoller.#ctor(System.Nullable{System.Guid},System.Type,System.Int32,System.Boolean,System.Int32)">
            <summary>
            Create a new ServerPoller. The ServerPoller is associated with a specific FactoryOrchestratorClient and object you want to poll. The desired object is referred to by its GUID. The GUID can be NULL for TaskRun polling.
            If it is NULL and the guidType is TaskList, a List of TaskListSummary objects is returned.
            </summary>
            <param name="guidToPoll">GUID of the object you want to poll</param>
            <param name="guidType">The type of object that GuidToPoll is</param>
            <param name="pollingIntervalMs">How frequently the polling should be done, in milliseconds. Defaults to 500ms.</param>
            <param name="adaptiveInterval">If true, automatically adjust the polling interval for best performance. Defaults to true.</param>
            <param name="maxAdaptiveModifier">If adaptiveInterval is set, this defines the maximum multiplier/divisor that will be applied to the polling interval. For example, if maxAdaptiveModifier=2 and pollingIntervalMs=100, the object would be polled at a rate between 50ms to 200ms. Defaults to 5.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.ServerPoller.StartPolling(Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient)">
            <summary>
            Starts polling the object.
            </summary>
            <param name="client">The FactoryOrchestratorClient object to use for polling.</param>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.ServerPoller.StopPolling">
            <summary>
            Stops polling the object.
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.ServerPoller.Dispose">
            <summary>
            Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.ServerPoller.Dispose(System.Boolean)">
            <summary>
            Releases unmanaged and - optionally - managed resources.
            </summary>
            <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.ServerPoller.LatestObject">
            <summary>
            Returns the latest object retrieved from the server.
            </summary>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.ServerPoller.PollingGuid">
            <summary>
            The GUID of the object you are polling. Can be NULL for some scenarios.
            </summary>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.ServerPoller.IsPolling">
            <summary>
            If true, the poller is actively polling for updates.
            </summary>
        </member>
        <member name="E:Microsoft.FactoryOrchestrator.Client.ServerPoller.OnUpdatedObject">
            <summary>
            Event raised when a new object is received. It is only thrown if the object has changed since last polled.
            </summary>
        </member>
        <member name="E:Microsoft.FactoryOrchestrator.Client.ServerPoller.OnException">
            <summary>
            Event raised when a poll attempt throws an exception.
            </summary>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.ServerPoller.OnlyRaiseOnExceptionEventForConnectionException">
            <summary>
            If true, OnException only raised when the exception is a FactoryOrchestratorConnectionException.
            Other exceptions are ignored!
            </summary>
        </member>
        <member name="T:Microsoft.FactoryOrchestrator.Client.ServerPollerEventArgs">
            <summary>
            Class used to share the new object with the callee via OnUpdatedObject.
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.ServerPollerEventArgs.#ctor(System.Object)">
            <summary>
            Creates a new ServerPollerEventArgs instance.
            </summary>
            <param name="result">Object from latest poll of the Server.</param>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.ServerPollerEventArgs.Result">
            <summary>
            The updated object polled on the server.
            </summary>
        </member>
        <member name="T:Microsoft.FactoryOrchestrator.Client.ServerPollerEventHandler">
            <summary>
            Event handler delegate for a when a new object has been retrieved from the Server.
            </summary>
            <param name="source">The ServerPoller that retrieved the object.</param>
            <param name="e">The result of the latest poll operation.</param>
        </member>
        <member name="T:Microsoft.FactoryOrchestrator.Client.ServerPollerExceptionHandler">
            <summary>
            Event handler delegate for a when the poller hit an exception while polling.
            </summary>
            <param name="source">The ServerPoller that retrieved the object.</param>
            <param name="e">The exception from the latest poll operation.</param>
        </member>
        <member name="T:Microsoft.FactoryOrchestrator.Client.ServerPollerExceptionHandlerEventArgs">
            <summary>
            Class containing the exception thrown from the latest poll operation.
            </summary>
        </member>
        <member name="M:Microsoft.FactoryOrchestrator.Client.ServerPollerExceptionHandlerEventArgs.#ctor(System.Exception)">
            <summary>
            Creates a new ServerPollerExceptionArgs instance.
            </summary>
            <param name="exception">Exception from latest poll of the Server.</param>
        </member>
        <member name="P:Microsoft.FactoryOrchestrator.Client.ServerPollerExceptionHandlerEventArgs.Exception">
            <summary>
            The updated object polled on the server.
            </summary>
        </member>
    </members>
</doc>