Microsoft.FactoryOrchestrator.PowerShell.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.FactoryOrchestrator.PowerShell</name> </assembly> <members> <member name="T:Microsoft.FactoryOrchestrator.Client.ServerPollerGuidType"> <summary> Type of GUID passed to FactoryOrchestratorServerPoller </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientCmdlet"> <summary> Cmdlet class. Intended for PowerShell use only. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientCmdlet.IpAddress"> <summary> IP Address to connect to. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientCmdlet.Port"> <summary> TCP port to use for connection. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientCmdlet.#ctor"> <summary> CTOR. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientCmdlet.ProcessRecord"> <summary> Creates a PowerShell object. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorTaskListCmdlet"> <summary> Cmdlet class. Intended for PowerShell use only. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorTaskListCmdlet.Name"> <summary> Name of the TaskList. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorTaskListCmdlet.Guid"> <summary> Guid of the TaskList. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorTaskListCmdlet.#ctor"> <summary> CTOR. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorTaskListCmdlet.ProcessRecord"> <summary> Creates a PowerShell object. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorTaskCmdlet"> <summary> Cmdlet class. Intended for PowerShell use only. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorTaskCmdlet.Path"> <summary> Path of the Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorTaskCmdlet.Type"> <summary> Type of the Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorTaskCmdlet.Name"> <summary> Friendly name for the Task. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorTaskCmdlet.Arguments"> <summary> Arguments for the Task. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorTaskCmdlet.ProcessRecord"> <summary> Creates a PowerShell object. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Client.PowerShellServerPoller"> <summary> Cmdlet class. Intended for PowerShell use only. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.PowerShellServerPoller.GuidToPoll"> <summary> GUID of the object you want to poll. $null is allowed. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.PowerShellServerPoller.GuidType"> <summary> The type of object that GuidToPoll is. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.PowerShellServerPoller.PollingIntervalMs"> <summary> How frequently the polling should be done, in milliseconds. Defaults to 500ms. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.PowerShellServerPoller.AdaptiveInterval"> <summary> If true, automatically adjust the polling interval for best performance. Defaults to true. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.PowerShellServerPoller.MaxAdaptiveModifier"> <summary> 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. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.PowerShellServerPoller.#ctor"> <summary> CTOR. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.PowerShellServerPoller.ProcessRecord"> <summary> Creates a PowerShell object. </summary> </member> <member name="T:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync"> <summary> A fully synchronous class for Factory Orchestrator .NET clients. Use instances of this class to communicate with Factory Orchestrator Service(s) via PowerShell. .NET clients are recommended to use FactoryOrchestratorClient instead which is fully asynchronous. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.#ctor(System.Net.IPAddress,System.Int32)"> <summary> Creates a new FactoryOrchestratorSyncClient instance. Most .NET clients are recommended to use FactoryOrchestratorClient instead which is fully asynchronous. </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> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.GetClientVersionString"> <summary> Gets the build number of FactoryOrchestratorClient. </summary> <returns></returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.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.FactoryOrchestratorClientSync.OnConnected"> <summary> Event raised when Client-Service connection is successfully established. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.IsLocalHost"> <summary> True if Factory Orchestrator Service is running on the local device. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.IsConnected"> <summary> True if the Client-Service connection is successfully established. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.IpAddress"> <summary> The IP address of the connected device. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.Port"> <summary> The port of the connected device used. Factory Orchestrator Service defaults to 45684. </summary> </member> <member name="P:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.AsyncClient"> <summary> The async client used to communicate with the service. Needed for using the ServerPoller class in PowerShell. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.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.</param> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.GetServiceEvents"> <summary> Gets all Service events. </summary> <returns>List of all Service events.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.GetLastServiceError"> <summary> Get last Service error. </summary> <returns></returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.GetServiceVersionString"> <summary> Returns the version of Factory Orchestrator Service. </summary> <returns>string representing the Service version.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.GetOSVersionString"> <summary> Returns the version of the Windows OS. </summary> <returns>string representing the Windows OS version.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.AbortAll"> <summary> Stops all executing Tasks and/or TaskLists. </summary> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.RunTask(Microsoft.FactoryOrchestrator.Core.TaskBase)"> <summary> Runs a Task outside of a TaskList. </summary> <param name="task">The Task to run.</param> <returns>The TaskRun associated with the run.</returns> </member> <member name="M:Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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.Client.FactoryOrchestratorClientSync.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> </members> </doc> |