Add details to function descriptions (87d2bb72) · Commits · for microsoft in general / xbox / tunip3 / WindowsDevicePortalWrapper

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/AppFileExplorer.cs

+6 −6

Original line number	Diff line number	Diff line
		@@ -38,7 +38,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public static readonly string KnownFoldersApi = "api/filesystem/apps/knownfolders";

		/// <summary>
		/// Calls the API to retrieve the list of known folders.
		/// Gets a list of Known Folders on the device.
		/// </summary>
		/// <returns>List of known folders available on this device.</returns>
		public async Task<KnownFolders> GetKnownFolders()
		@@ -47,7 +47,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		}

		/// <summary>
		/// Calls the API to retrieve the contents of a given folder.
		/// Gets a list of files in a Known Folder (e.g. LocalAppData).
		/// </summary>
		/// <param name="knownFolderId">The known folder id for the root of the path.</param>
		/// <param name="subPath">An optional subpath to the folder.</param>
		@@ -64,7 +64,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		}

		/// <summary>
		/// Calls the API to download a file.
		/// Gets a file from LocalAppData or another Known Folder on the device.
		/// </summary>
		/// <param name="knownFolderId">The known folder id for the root of the path.</param>
		/// <param name="filename">The name of the file we are downloading.</param>
		@@ -90,7 +90,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		}

		/// <summary>
		/// Calls the API to upload a file.
		/// Uploads a file to a Known Folder (e.g. LocalAppData)
		/// </summary>
		/// <param name="knownFolderId">The known folder id for the root of the path.</param>
		/// <param name="filepath">The path to the file we are uploading.</param>
		@@ -112,7 +112,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		}

		/// <summary>
		/// Calls the API to delete a file.
		/// Deletes a file from a Known Folder.
		/// </summary>
		/// <param name="knownFolderId">The known folder id for the root of the path.</param>
		/// <param name="filename">The name of the file we are deleting.</param>
		@@ -133,7 +133,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		}

		/// <summary>
		/// Calls the API to rename a file.
		/// Renames a file in a Known Folder.
		/// </summary>
		/// <param name="knownFolderId">The known folder id for the root of the path.</param>
		/// <param name="filename">The name of the file we are renaming.</param>

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/Dns-Sd.cs

+1 −1

Original line number	Diff line number	Diff line
		@@ -27,7 +27,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public static readonly string TagsApi = "api/dns-sd/tags";

		/// <summary>
		/// Gets the name of the device.
		/// Gets a list of DNS-SD tags being broadcast by this device.
		/// </summary>
		/// <returns>Array of strings, each one an individual tag.</returns>
		public async Task<List<string>> GetServiceTags()

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/PerformanceData.cs

+30 −28

Original line number	Diff line number	Diff line
		@@ -183,10 +183,10 @@ namespace Microsoft.Tools.WindowsDevicePortal
		#region Device contract

		/// <summary>
		/// Object representing the process version.
		/// Object representing the app version. Only present if the process is an app.
		/// </summary>
		[DataContract]
		public class ProcessVersion
		public class AppVersion
		{
		/// <summary>
		/// Gets the major version number
		@@ -214,19 +214,19 @@ namespace Microsoft.Tools.WindowsDevicePortal
		}

		/// <summary>
		/// Process Info
		/// Process Info. Contains app information if the process is an app.
		/// </summary>
		[DataContract]
		public class DeviceProcessInfo
		{
		/// <summary>
		/// Gets the app name
		/// Gets the app name. Only present if the process is an app.
		/// </summary>
		[DataMember(Name = "AppName")]
		public string AppName { get; private set; }

		/// <summary>
		/// Gets CPU usage
		/// Gets CPU Usage as a percentage of available CPU resources (0-100)
		/// </summary>
		[DataMember(Name = "CPUUsage")]
		public float CpuUsage { get; private set; }
		@@ -238,19 +238,19 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public string Name { get; private set; }

		/// <summary>
		/// Gets the process id
		/// Gets the process id (pid)
		/// </summary>
		[DataMember(Name = "ProcessId")]
		public int ProcessId { get; private set; }

		/// <summary>
		/// Gets the owner name
		/// Gets the user the process is running as.
		/// </summary>
		[DataMember(Name = "UserName")]
		public string UserName { get; private set; }

		/// <summary>
		/// Gets the package full name
		/// Gets the package full name. Only present if the process is an app.
		/// </summary>
		[DataMember(Name = "PackageFullName")]
		public string PackageFullName { get; private set; }
		@@ -280,37 +280,39 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public uint SessionId { get; private set; }

		/// <summary>
		/// Gets total commit
		/// Gets total commit in bytes
		/// </summary>
		[DataMember(Name = "TotalCommit")]
		public double TotalCommit { get; private set; }

		/// <summary>
		/// Gets virtual size
		/// Gets virtual size in bytes
		/// </summary>
		[DataMember(Name = "VirtualSize")]
		public double VirtualSize { get; private set; }

		/// <summary>
		/// Gets a value indicating whether or not the process is running
		/// Gets a value indicating whether or not the app is running
		/// (versus suspended). Only present if the process is an app.
		/// </summary>
		[DataMember(Name = "IsRunning")]
		public bool IsRunning { get; private set; }

		/// <summary>
		/// Gets publisher
		/// Gets publisher. Only present if the process is an app.
		/// </summary>
		[DataMember(Name = "Publisher")]
		public string Publisher { get; private set; }

		/// <summary>
		/// Gets version
		/// Gets version. Only present if the process is an app.
		/// </summary>
		[DataMember(Name = "Version")]
		public ProcessVersion Version { get; private set; }
		public AppVersion Version { get; private set; }

		/// <summary>
		/// Gets a value indicating whether or not the package is a XAP package
		/// Gets a value indicating whether or not the package is a XAP
		/// package. Only present if the process is an app.
		/// </summary>
		[DataMember(Name = "IsXAP")]
		public bool IsXAP { get; private set; }
		@@ -332,13 +334,13 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public class GpuAdapter
		{
		/// <summary>
		/// Gets total Dedicated memory
		/// Gets total Dedicated memory in bytes
		/// </summary>
		[DataMember(Name = "DedicatedMemory")]
		public uint DedicatedMemory { get; private set; }

		/// <summary>
		/// Gets used Dedicated memory
		/// Gets used Dedicated memory in bytes
		/// </summary>
		[DataMember(Name = "DedicatedMemoryUsed")]
		public uint DedicatedMemoryUsed { get; private set; }
		@@ -350,19 +352,19 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public string Description { get; private set; }

		/// <summary>
		/// Gets system memory
		/// Gets system memory in bytes
		/// </summary>
		[DataMember(Name = "SystemMemory")]
		public uint SystemMemory { get; private set; }

		/// <summary>
		/// Gets memory used
		/// Gets memory used in bytes
		/// </summary>
		[DataMember(Name = "SystemMemoryUsed")]
		public uint SystemMemoryUsed { get; private set; }

		/// <summary>
		/// Gets engines utilization
		/// Gets engines utilization as percent of maximum.
		/// </summary>
		[DataMember(Name = "EnginesUtilization")]
		public List<float> EnginesUtilization { get; private set; }
		@@ -388,13 +390,13 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public class NetworkPerformanceData
		{
		/// <summary>
		/// Gets bytes in
		/// Gets current download speed in bytes per second
		/// </summary>
		[DataMember(Name = "NetworkInBytes")]
		public int BytesIn { get; private set; }

		/// <summary>
		/// Gets bytes out
		/// Gets current upload speed in bytes per second
		/// </summary>
		[DataMember(Name = "NetworkOutBytes")]
		public int BytesOut { get; private set; }
		@@ -407,7 +409,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public class RunningProcesses
		{
		/// <summary>
		/// Gets processes info
		/// Gets list of running processes.
		/// </summary>
		[DataMember(Name = "Processes")]
		public DeviceProcessInfo[] Processes { get; private set; }
		@@ -478,7 +480,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public int AvailablePages { get; private set; }

		/// <summary>
		/// Gets commit limit
		/// Gets commit limit in bytes
		/// </summary>
		[DataMember(Name = "CommitLimit")]
		public int CommitLimit { get; private set; }
		@@ -490,25 +492,25 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public int CommittedPages { get; private set; }

		/// <summary>
		/// Gets CPU load
		/// Gets CPU load as percent of maximum (0 - 100)
		/// </summary>
		[DataMember(Name = "CpuLoad")]
		public int CpuLoad { get; private set; }

		/// <summary>
		/// Gets IO Other Speed
		/// Gets IO Other Speed in bytes per second
		/// </summary>
		[DataMember(Name = "IOOtherSpeed")]
		public int IoOtherSpeed { get; private set; }

		/// <summary>
		/// Gets IO Read speed
		/// Gets IO Read speed in bytes per second.
		/// </summary>
		[DataMember(Name = "IOReadSpeed")]
		public int IoReadSpeed { get; private set; }

		/// <summary>
		/// Gets IO write speed
		/// Gets IO write speed in bytes per second
		/// </summary>
		[DataMember(Name = "IOWriteSpeed")]
		public int IoWriteSpeed { get; private set; }

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/WiFiManagement.cs

+3 −3

Original line number	Diff line number	Diff line
		@@ -32,7 +32,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public static readonly string WifiNetworksApi = "api/wifi/networks";

		/// <summary>
		/// Connect to a WiFi network.
		/// Connect to a WiFi network using a given network adapter and SSID.
		/// </summary>
		/// <param name="networkAdapter">Network adaptor GUID.</param>
		/// <param name="ssid">SSID of the network.</param>
		@@ -64,7 +64,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		}

		/// <summary>
		/// Gets WiFi networks.
		/// Gets WiFi networks as seen from a WiFi interface.
		/// </summary>
		/// <param name="interfaceGuid">Interface to get networks from.</param>
		/// <returns>List of available networks.</returns>
		@@ -171,7 +171,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public bool IsConnectable { get; private set; }

		/// <summary>
		/// Gets the infrastructure type.
		/// Gets the infrastructure type - ad hoc or standard.
		/// </summary>
		[DataMember(Name = "InfrastructureType")]
		public string InfrastructureType { get; private set; }

WindowsDevicePortalWrapper/WindowsDevicePortalWrapper/Core/AppDeployment.cs

+1 −1

Original line number	Diff line number	Diff line
		@@ -20,7 +20,7 @@ namespace Microsoft.Tools.WindowsDevicePortal
		public partial class DevicePortal
		{
		/// <summary>
		/// API for getting installation status.
		/// Gets the status of a pending or most recent installation, if any.
		/// </summary>
		/// <returns>The status</returns>
		public async Task<ApplicationInstallStatus> GetInstallStatus()