This is the main DevicePortal object. It contains methods for making HTTP REST calls against all of the WDP endpoints covered by the wrapper project. Different endpoints have their implementation separated out into individual files. More...

Classes
class	ActivePowerScheme
	Battery state. More...

class	AllJoynSettingsInfo
	Object represenation of All Joyn Settings. More...

class	AppPackage

class	AppPackages
	Object representing a list of Application Packages More...

class	AppsListInfo
	Application list info. More...

class	AppVersion
	Object representing the app version. Only present if the process is an app. More...

class	AudioDeviceListInfo
	Audio Device List information. More...

class	AvailableBluetoothDevicesInfo
	List of available bluetooth devices. More...

class	BatteryState
	Battery state. More...

class	BluetoothDeviceInfo

class	ControllerDriverInfo
	Controller Driver information. More...

class	DateTimeDescription
	Current Datetime information. More...

class	DateTimeInfo
	DateTime information. More...

class	Device
	Object representing a device entry More...

class	DeviceList
	Object representing a device entry More...

class	DeviceName
	Device name object. More...

class	DeviceOsFamily
	Device family object. More...

class	DeviceProcesses
	Object representing a list of processes More...

class	DeviceProcessInfo
	Process Info. Contains app information if the process is an app. More...

class	Dhcp
	DHCP object. More...

class	DisplayOrientationInfo
	Dispaly orientation information. More...

class	DisplayResolutionInfo
	Dispaly resolution information. More...

class	ErrorInformation
	Error information if a request fails. More...

class	FileOrFolderInformation
	Details about a folder or file. More...

class	FolderContents
	Folder contents object. More...

class	GpuAdapter
	GPU Adaptors More...

class	GpuPerformanceData
	GPU performance data More...

class	HeadlessAppsListInfo
	Headless app list information. More...

class	HolographicSimulationError
	Object representation of a Holographic Simulation (playback or recording) error. More...

class	HolographicSimulationPlaybackSessionState
	Object representation of the Holographic Simulation playback state More...

class	HolographicSimulationRecordingStatus
	Object representation of Holographic Simulation recording status. More...

class	InstallState
	Object representing the install state More...

class	InterPupilaryDistance
	Object representation for Interpupilary distance More...

class	IoTOSInfo
	Operating system information. More...

class	IpAddressInfo
	IP Address info More...

class	IpConfiguration
	IP Configuration object More...

class	IscInterfacesInfo
	internet connection sharing(ICS) interfaces. More...

class	KnownFolders
	Known Folders object. More...

class	MrcFileInformation
	Object representation of an individual capture file More...

class	MrcFileList
	Object representation of the capture file list More...

class	MrcProcessStatus
	Object representation of the recording process status More...

class	MrcStatus
	Object representation of the Capture status More...

class	NetworkAdapterInfo
	Networking adapter info More...

class	NetworkPerformanceData
	Network performance data More...

class	OperatingSystemInformation
	Operating system information. More...

class	PackageInfo
	object representing the package information More...

class	PackageVersion
	Object representing a package version More...

class	PairBluetoothDevicesInfo
	Information about device to be paired. More...

class	PairedBluetoothDevicesInfo
	List of paired bluetooth devices. More...

class	PairResult

class	PerceptionSimulationControlMode
	Object representation of Perception Simulation control mode. More...

class	PowerState
	Power state More...

class	ProcessInfo
	Object representing the process information More...

class	ProcessVersion
	Object representing the process version. More...

class	RemoteSettingsStatusInfo
	Remote Settings Status information. More...

class	Resolution
	Dispaly resolution specifications. More...

class	RunCommandOutputInfo
	Run command output. More...

class	RunningProcesses
	Running processes More...

class	Sandbox
	Xbox Live Sandbox representation More...

class	ServiceTags
	Service tags object More...

class	SmbInfo
	SMB Info representation More...

class	SoftAPSettingsInfo
	Object representation for Soft AP Settings. More...

class	StatusInfo
	Status information. More...

class	SystemPerformanceInformation
	System performance information More...

class	ThermalStage
	Object representation of thermal stage More...

class	Timezone
	Timezone specifications. More...

class	TimezoneInfo
	Timezone information. More...

class	TpmAcpiTablesInfo
	TPM ACPI Tables information. More...

class	TpmAzureTokenInfo
	TPM Azure Token information. More...

class	TpmLogicalDeviceSettingsInfo
	TPM Logical Device Settings information. More...

class	TpmSettingsInfo
	TPM Status information. More...

class	UpdateInstallTimeInfo
	Update install time information. More...

class	UserInfo
	UserInfo object More...

class	UserList
	List of users More...

class	WebManagementHttpSettings
	Object representation for HTTP settings More...

class	WifiInterface
	WiFi interface. More...

class	WifiInterfaces
	WiFi interfaces. More...

class	WifiNetworkInfo
	WiFi network info. More...

class	WifiNetworkProfile
	WiFi network profile. More...

class	WifiNetworks
	WiFi networks. More...

class	XboxSetting
	XboxSetting object More...

class	XboxSettingList
	List of settings. More...

Public Types
enum	DevicePortalPlatforms { DevicePortalPlatforms.Unknown = -1, DevicePortalPlatforms.Windows = 0, DevicePortalPlatforms.Mobile, DevicePortalPlatforms.HoloLens, DevicePortalPlatforms.XboxOne, DevicePortalPlatforms.IoTDragonboard410c, DevicePortalPlatforms.IoTMinnowboardMax, DevicePortalPlatforms.IoTRaspberryPi2, DevicePortalPlatforms.IoTRaspberryPi3, DevicePortalPlatforms.VirtualMachine }
	Device portal platforms More...

enum	HttpMethods { HttpMethods.Get, HttpMethods.Put, HttpMethods.Post, HttpMethods.Delete, HttpMethods.WebSocket }
	HTTP Methods More...

enum	SimulationControlMode { SimulationControlMode.Default = 0, SimulationControlMode.Simulation, SimulationControlMode.Remote, SimulationControlMode.Legacy }
	Enumeration defining the control modes used by the Holographic Perception Simulation. More...

enum	HolographicSimulationPlaybackStates { HolographicSimulationPlaybackStates.Stopped = 0, HolographicSimulationPlaybackStates.Playing, HolographicSimulationPlaybackStates.Paused, HolographicSimulationPlaybackStates.Complete, HolographicSimulationPlaybackStates.Unexpected = 9999 }
	Enumeration describing the available Holgraphic Simulation playback states. More...

Public Member Functions
async Task< ApplicationInstallStatus >	GetInstallStatus ()
	API for getting installation status. More...

async Task< X509Certificate2 >	GetRootDeviceCertificate ()
	Gets the root certificate from the device. More...

async Task< ApplicationInstallStatus >	GetInstallStatus ()
	Gets the status of a pending or most recent installation, if any. More...

async Task< AppPackages >	GetInstalledAppPackages ()
	Gets the collection of applications installed on the device. More...

async Task	InstallApplication (string appName, string packageFileName, List< string > dependencyFileNames, string certificateFileName=null, short stateCheckIntervalMs=500, short timeoutInMinutes=15, bool uninstallPreviousVersion=true)
	Installs an application More...

async Task	UninstallApplication (string packageName)
	Uninstalls the specified application. More...

async Task< KnownFolders >	GetKnownFolders ()
	Gets a list of Known Folders on the device. More...

async Task< FolderContents >	GetFolderContents (string knownFolderId, string subPath=null, string packageFullName=null)
	Gets a list of files in a Known Folder (e.g. LocalAppData). More...

async Task< Stream >	GetFile (string knownFolderId, string filename, string subPath=null, string packageFullName=null)
	Gets a file from LocalAppData or another Known Folder on the device. More...

async Task	UploadFile (string knownFolderId, string filepath, string subPath=null, string packageFullName=null)
	Uploads a file to a Known Folder (e.g. LocalAppData) More...

async Task	DeleteFile (string knownFolderId, string filename, string subPath=null, string packageFullName=null)
	Deletes a file from a Known Folder. More...

async Task	RenameFile (string knownFolderId, string filename, string newFilename, string subPath=null, string packageFullName=null)
	Renames a file in a Known Folder. More...

async Task< List< Device > >	GetDeviceList ()
	Get a listing of installed devices More...

async Task< List< string > >	GetServiceTags ()
	Gets a list of DNS-SD tags being broadcast by this device. More...

async Task	AddServiceTag (string tagValue)
	Adds a tag to this device's DNS-SD broadcast. More...

async Task	DeleteAllTags ()
	Delete all tags from the device's DNS-SD broadcast. More...

async Task	DeleteTag (string tagValue)
	Delete a specific tag from the device's DNS-SD broadcast. More...

async Task< IpConfiguration >	GetIpConfig ()
	Gets the IP configuration data of the device. More...

async Task< string >	GetDeviceFamily ()
	Gets the family name (ex: Windows.Holographic) of the device. More...

async Task< string >	GetDeviceName ()
	Gets the name of the device. More...

async Task< OperatingSystemInformation >	GetOperatingSystemInformation ()
	Gets information about the device's operating system. More...

async Task	SetDeviceName (string name)
	Sets the device's name More...

async Task< RunningProcesses >	GetRunningProcesses ()
	Gets the collection of processes running on the device. More...

async Task	StartListeningForRunningProcesses ()
	Starts listening for the running processes on the device with them being returned via the RunningProcessesMessageReceived event handler. More...

async Task	StopListeningForRunningProcesses ()
	Stop listening for the running processes on the device. More...

async Task< SystemPerformanceInformation >	GetSystemPerf ()
	Gets system performance information for the device. More...

async Task	StartListeningForSystemPerf ()
	Starts listening for the system performance information for the device with it being returned via the SystemPerfMessageReceived event handler. More...

async Task	StopListeningForSystemPerf ()
	Stop listening for the system performance information for the device. More...

async Task< Guid >	GetActivePowerScheme ()
	Returns the current active power scheme. More...

async Task< BatteryState >	GetBatteryState ()
	Returns the current state of the device's battery. More...

async Task< PowerState >	GetPowerState ()
	Gets the device's current power state. More...

async Task	Reboot ()
	Reboots the device. More...

async Task	Shutdown ()
	Shuts down the device. More...

async Task	StartListeningForProcesses ()
	Starts listening for the running processes on the device with them being returned via the ProcessesMessageReceived event handler. More...

async Task	StopListeningForProcesses ()
	Stop listening for the running processes on the device. More...

async Task< int >	LaunchApplication (string appid, string packageName)
	Starts running the specified application. More...

async Task	TerminateApplication (string packageName)
	Stops the specified application from running. More...

async Task	ConnectToWifiNetwork (Guid networkAdapter, string ssid, string networkKey)
	Connect to a WiFi network using a given network adapter and SSID. More...

async Task< WifiInterfaces >	GetWifiInterfaces ()
	Gets WiFi interfaces. More...

async Task< WifiNetworks >	GetWifiNetworks (Guid interfaceGuid)
	Gets WiFi networks as seen from a WiFi interface. More...

	DevicePortal (IDevicePortalConnection connection)
	Initializes a new instance of the DevicePortal class. More...

async Task	Connect (string ssid=null, string ssidKey=null, bool updateConnection=true, X509Certificate2 manualCertificate=null)
	Connects to the device pointed to by IDevicePortalConnection provided in the constructor. More...

async Task	SaveEndpointResponseToFile (string endpoint, string directory, HttpMethods httpMethod, Stream requestBody=null, string requestBodyContentType=null)
	Helper method used for saving the content of a response to a file. This allows unittests to easily generate real data to use as mock responses. More...

async Task< float >	GetInterPupilaryDistance ()
	Gets the interpupilary distance registered on the device. More...

async Task	SetIsHttpsRequired (bool httpsRequired)
	Sets the WiFi http security requirements for communication with the device. More...

async Task	SetInterPupilaryDistance (float ipd)
	Sets the interpupilary distance registered on the device. More...

async Task< bool >	GetIsHttpsRequired ()
	Gets the WiFi http security requirements for communication with the device. More...

async Task< SimulationControlMode >	GetPerceptionSimulationControlMode ()
	Gets the perception simulation control mode. More...

async Task	SetPerceptionSimulationControlMode (SimulationControlMode mode)
	Sets the perception simulation control mode. More...

async Task< ThermalStages >	GetThermalStage ()
	Gets the current thermal stage reading from the device. More...

async Task	DeleteMrcFile (string fileName)
	Removes a Mixed Reality Capture file from the device's local storage. More...

async Task< byte[]>	GetMrcFileData (string fileName, bool isThumbnailRequest=false)
	Gets the capture file data More...

async Task< MrcFileList >	GetMrcFileList ()
	Gets the list of capture files More...

async Task< MrcStatus >	GetMrcStatus ()
	Gets the status of the reality capture More...

async Task< byte[]>	GetMrcThumbnailData (string fileName)
	Gets thumbnail data for the capture More...

async Task	StartMrcRecording (bool includeHolograms=true, bool includeColorCamera=true, bool includeMicrophone=true, bool includeAudio=true)
	Starts a Mixed Reality Capture recording. More...

async Task	StopMrcRecording ()
	Stops the Mixed Reality Capture recording More...

async Task	TakeMrcPhoto (bool includeHolograms=true, bool includeColorCamera=true)
	Take a Mixed Reality Capture photo More...

async Task	DeleteHolographicSimulationRecording (string name)
	Deletes the specified Holographic Simulation recording. More...

async Task< HolographicSimulationPlaybackStates >	GetHolographicSimulationPlaybackState (string name)
	Gets the playback state of a Holographic Simulation recording. More...

async Task	LoadHolographicSimulationRecording (string name)
	Loads the specified Holographic Simulation recording. More...

async Task	UnloadHolographicSimulationRecording (string name)
	Unloads the specified Holographic Simulation recording. More...

async Task< bool >	GetHolographicSimulationRecordingStatus ()
	Gets the holographic simulation recording status. More...

async Task	StartHolographicSimulationRecording (string name, bool recordHead=true, bool recordHands=true, bool recordSpatialMapping=true, bool recordEnvironment=true)
	Starts a Holographic Simulation recording session. More...

async Task< byte[]>	StopHolographicSimulationRecording ()
	Stops a Holographic Simulation recording session. More...

async Task< AppsListInfo >	GetAppsListInfo ()
	Gets List of apps. More...

async Task< HeadlessAppsListInfo >	GetHeadlessAppsListInfo ()
	Gets list of headless apps. More...

async Task	UpdateStartupApp (string appId)
	Sets selected app as the startup app. More...

async Task	UpdateHeadlessStartupApp (string appId)
	Sets the selected app as the headless startup app. More...

async Task	RemoveHeadlessStartupApp (string appId)
	Removes the selected app from the headless startup app list. More...

async Task	ActivatePackage (string appId)
	Activiates the selected app package. More...

async Task< AudioDeviceListInfo >	GetAudioDeviceListInfo ()
	Gets the Audio Device List Information. More...

async Task	SetRenderVolume (string renderVolume)
	Sets volume for the audio devices. More...

async Task	SetCaptureVolume (string captureVolume)
	Sets volume for the audio devices. More...

AvailableBluetoothDevicesInfo	GetAvailableBluetoothDevicesInfo ()
	Gets the available bluetooth device information. More...

PairedBluetoothDevicesInfo	GetPairedBluetoothDevicesInfo ()
	Gets the paired bluetooth device information. More...

PairBluetoothDevicesInfo	GetPairBluetoothDevicesInfo (string deviceId)
	Gets the results for pairing a bluetooth device. More...

async Task	StartListeningForBluetooth (string bluetoothApi)
	Starts listening for bluetooth list of devices returned from the BluetoothDeviceListReceived handler. More...

async Task	StopListeningForBluetooth ()
	Stop listening for the list of bluetooth device. More...

async Task	StartListeningForPairedBluetooth (string bluetoothApi)
	Starts listening for paired bluetooth list of devices returned from the PairedBluetoothDeviceListReceived handler. More...

async Task	StopListeningForPairedBluetooth ()
	Stop listening for the list of paired bluetooth device. More...

async Task	StartListeningForPairBluetooth (string bluetoothApi, string payload)
	Starts listening for the result to pair the bluetooth device returned from the PairBluetoothDeviceListReceived handler. More...

async Task	StopListeningForPairBluetooth ()
	Stop listening for the results for pairing bluetooth device. More...

async Task< ErrorInformation >	UnPairBluetoothDevice (string deviceId)
	Unpairs the bluetooth device. More...

async Task< IoTOSInfo >	GetIoTOSInfo ()
	Gets the IoT OS Information. More...

async Task< TimezoneInfo >	GetTimezoneInfo ()
	Gets the Timezone information. More...

async Task< DateTimeInfo >	GetDateTimeInfo ()
	Gets the datetime information. More...

async Task< ControllerDriverInfo >	GetControllerDriverInfo ()
	Gets the controller driver information. More...

async Task< DisplayOrientationInfo >	GetDisplayOrientationInfo ()
	Gets the dispaly orientation information. More...

async Task< DisplayResolutionInfo >	GetDisplayResolutionInfo ()
	Gets the dispaly resolution information. More...

async Task	SetIoTDeviceName (string name)
	Sets the Device Name. More...

async Task< ErrorInformation >	SetNewPassword (string oldPassword, string newPassword)
	Sets a new password. More...

async Task	SetNewRemoteDebuggingPin (string newPin)
	Sets a new remote debugging pin. More...

async Task< ControllerDriverInfo >	SetControllersDrivers (string newDriver)
	Sets controllers drivers. More...

async Task< ErrorInformation >	SetTimeZone (int index)
	Sets Timezone. More...

async Task	SetDisplayResolution (string displayResolution)
	Sets display resolution. More...

async Task	SetDisplayOrientation (string displayOrientation)
	Set display orientation. More...

async Task< IscInterfacesInfo >	GetIcsInterfacesInfo ()
	Gets the internet connection sharing(ICS) interfaces . More...

async Task	IcSharingStart (string privateInterface, string publicInterface)
	Starts internet connection sharing(ICS). More...

async Task	IcSharingStop (string privateInterface, string publicInterface)
	Stops internet connection sharing(ICS). More...

async Task< SoftAPSettingsInfo >	GetSoftAPSettingsInfo ()
	Retrieves the Soft AP Settings Info. More...

async Task< AllJoynSettingsInfo >	GetAllJoynSettingsInfo ()
	Retrieves the All Joyn Settings Info. More...

async Task	SetSoftApSettings (string softApStatus, string softApSsid, string softApPassword)
	Sets SoftAp Settings. More...

async Task	SetAllJoynSettings (string allJoynStatus, string allJoynDescription, string allJoynManufacturer, string allJoynModelNumber)
	Sets AllJoyn Settings. More...

async Task< TpmSettingsInfo >	GetTpmSettingsInfo ()
	Gets Tpm Settings information. More...

async Task	SetTpmAcpiTablesInfo (string acpiTableIndex)
	Sets TPM ACPI Tables information. More...

async Task< TpmAcpiTablesInfo >	GetTpmAcpiTablesInfo ()
	Gets TPM ACPI Tables information. More...

async Task< TpmLogicalDeviceSettingsInfo >	GetTpmLogicalDeviceSettingsInfo (int logicalDeviceId)
	Gets TPM Logical Device Settings information. More...

async Task	SetTpmLogicalDeviceSettingsInfo (int logicalDeviceId, string azureUri, string azureKey)
	Sets TPM Logical Device Settings information. More...

async Task	ResetTpmLogicalDeviceSettingsInfo (int logicalDeviceId)
	Resets TPM Logical Device Settings information. More...

async Task< TpmAzureTokenInfo >	GetTpmAzureTokenInfo (int logicalDeviceId, string validity)
	Gets TPM Azure Token information. More...

async Task	RunCommand (string command, string runAsDefaultAccount)
	Runs the command. More...

async Task< RunCommandOutputInfo >	RunCommandWithoutOutput (string commandWithoutOutput, string runAsDefaultAccount, string timeout)
	Runs the command. More...

async Task< RemoteSettingsStatusInfo >	GetRemoteSettingsStatusInfo ()
	Gets the Remote Settings Status Information. More...

async Task< RemoteSettingsStatusInfo >	RemoteSettingsEnable ()
	Enables the remote settings. More...

async Task< RemoteSettingsStatusInfo >	RemoteSettingsDisable ()
	Disables the remote settings. More...

async Task< StatusInfo >	GetStatusInfo ()
	Gets Status information. More...

async Task< UpdateInstallTimeInfo >	GetUpdateInstallTime ()
	Gets the update install time information. More...

async Task	EnableFiddlerTracing (string proxyAddress, string proxyPort, string certFilePath=null)
	Enables Fiddler on the console with the specified proxy. More...

async Task	DisableFiddlerTracing ()
	Disables Fiddler on the console. More...

async Task< SmbInfo >	GetSmbShareInfo ()
	Gets the SMB Share info for the device More...

async Task< UserList >	GetXboxLiveUsers ()
	Gets the Xbox Live user info for all users present on the device More...

async Task	UpdateXboxLiveUsers (UserList users)
	Updates info for the Xbox Live users present on the device More...

async Task	RegisterApplication (string folderName)
	Registers a loose app on the console More...

async Task	UploadPackageFolder (string sourceFolder, string destinationFolder)
	Uploads a folder to the DevelopmentFiles loose folder. More...

async Task< Sandbox >	GetXboxLiveSandbox ()
	Gets the current Xbox Live sandbox value for this device. More...

async Task< Sandbox >	SetXboxLiveSandbox (string newSandbox)
	Sets the Xbox Live sandbox on the device. More...

async Task< Stream >	TakeXboxScreenshot ()
	Takes a current screenshot of the device. More...

async Task< XboxSettingList >	GetXboxSettings ()
	Gets the Xbox Settings info for all settings which can be controlled on the device. More...

async Task< XboxSetting >	GetXboxSetting (string settingName)
	Gets the value for a single setting. More...

async Task< XboxSetting >	UpdateXboxSetting (XboxSetting setting)
	Updates info for the given Xbox setting. More...

async Task< Certificate >	GetRootDeviceCertificate (bool acceptUntrustedCerts=false)
	Gets the root certificate from the device. More...

async Task< ApplicationInstallStatus >	GetInstallStatus ()
	API for getting installation status. More...

Static Public Attributes
static readonly string	InstalledPackagesApi = "api/app/packagemanager/packages"
	API to retrieve list of installed packages. More...

static readonly string	InstallStateApi = "api/app/packagemanager/state"
	Install state API. More...

static readonly string	PackageManagerApi = "api/app/packagemanager/package"
	API for package management. More...

static readonly string	GetFileApi = "api/filesystem/apps/file"
	API to upload, download or delete a file in a folder. More...

static readonly string	RenameFileApi = "api/filesystem/apps/rename"
	API to rename a file in a folder. More...

static readonly string	GetFilesApi = "api/filesystem/apps/files"
	API to retrieve the list of files in a folder. More...

static readonly string	KnownFoldersApi = "api/filesystem/apps/knownfolders"
	API to retrieve the list of accessible top-level folders. More...

static readonly string	InstalledDevicesApi = "api/devicemanager/devices"
	API to retrieve list of installed devices. More...

static readonly string	TagApi = "api/dns-sd/tag"
	API to add or delete a tag to the DNS-SD advertisement. More...

static readonly string	TagsApi = "api/dns-sd/tags"
	API to retrieve or delete the currently applied tags for the device. More...

static readonly string	AvailableBugChecksApi = "api/debug/dump/kernel/dumplish"
	API to retrieve list of the available bugcheck minidumps. More...

static readonly string	AvailableCrashDumpsApi = "api/debug/dump/usermode/dumps"
	API to retrieve list of the available crash dumps (for sideloaded applications). More...

static readonly string	BugcheckFileApi = "api/debug/dump/kernel/dump"
	API to download a bugcheck minidump file. More...

static readonly string	BugcheckSettingsApi = "api/debug/dump/kernel/crashcontrol"
	API to control bugcheck minidump settings. More...

static readonly string	CrashDumpFileApi = "api/debug/dump/usermode/crashdump"
	API to download or delete a crash dump file (for a sideloaded application). More...

static readonly string	CrashDumpSettingsApi = "api/debug/dump/usermode/crashcontrol"
	API to control the crash dump settings for a sideloaded application. More...

static readonly string	LiveKernelDumpApi = "api/debug/dump/livekernel"
	API to retrieve a live kernel dump. More...

static readonly string	LiveProcessDumpApi = "api/debug/dump/usermode/live"
	API to retrieve a live dump from a running user mode process. More...

static readonly string	CreateRealtimeEtwSessionApi = "api/etw/session/realtime"
	API to create a realtime ETW session. More...

static readonly string	GetCustomEtwProvidersApi = "api/etw/customproviders"
	API to getthe list of registered custom ETW providers. More...

static readonly string	GetEtwProvidersApi = "api/etw/providers"
	API to getthe list of registered ETW providers. More...

static readonly string	IpConfigApi = "api/networking/ipconfig"
	API for getting IP config data. More...

static readonly string	DeviceFamilyApi = "api/os/devicefamily"
	API for getting the device family. More...

static readonly string	MachineNameApi = "api/os/machinename"
	API for getting the machine name. More...

static readonly string	OsInfoApi = "api/os/info"
	API for getting the OS information. More...

static readonly string	RunningProcessApi = "api/resourcemanager/processes"
	API for getting all running processes More...

static readonly string	SystemPerfApi = "api/resourcemanager/systemperf"
	API for getting system performance More...

static readonly string	ActivePowerSchemeApi = "api/power/activecfg"
	API for getting or setting the active power scheme. More...

static readonly string	BatteryStateApi = "api/power/battery"
	API for getting battery state. More...

static readonly string	PowerSchemeSubValueApi = "api/power/cfg"
	API for getting or setting a power scheme's sub-value. More...

static readonly string	PowerStateApi = "api/power/state"
	API for controlling power state. More...

static readonly string	SleepStudyReportApi = "api/power/sleepstudy/report"
	API for getting a sleep study report. More...

static readonly string	SleepStudyReportsApi = "api/power/sleepstudy/reports"
	API for getting the list of sleep study reports. More...

static readonly string	SleepStudyTransformApi = "api/power/sleepstudy/transform"
	API for getting a sleep study report. More...

static readonly string	RebootApi = "api/control/restart"
	API for rebooting the device. More...

static readonly string	ShutdownApi = "api/control/shutdown"
	API for shutting down the device. More...

static readonly string	TaskManagerApi = "api/taskmanager/app"
	API for starting or stopping a modern application. More...

static readonly string	WifiInterfacesApi = "api/wifi/interfaces"
	API for getting the WiFi interfaces. More...

static readonly string	WifiNetworkApi = "api/wifi/network"
	API for the controlling the WiFi network. More...

static readonly string	WifiNetworksApi = "api/wifi/networks"
	API for getting available WiFi networks. More...

static readonly string	WindowsErrorReportingFileApi = "api/wer/report/file"
	API for downloading a Windows error reporting file. More...

static readonly string	WindowsErrorReportingFilesApi = "api/wer/report/files"
	API for getting the list of files in a Windows error report. More...

static readonly string	WindowsErrorReportsApi = "api/wer/reports"
	API for getting the list of Windows error reports. More...

static readonly string	WindowsPerformanceBootTraceApi = "api/wpr/boottrace"
	API for starting and stopping a Windows performance recorder boot performance trace session. More...

static readonly string	WindowsPerformanceCustomTraceApi = "api/wpr/customtrace"
	API for starting a Windows performance recorder trace using a custom profile. More...

static readonly string	WindowsPerformanceTraceApi = "api/wpr/trace"
	API for starting and stopping a Windows performance recorder trace session. More...

static readonly string	WindowsPerformanceTraceStatusApi = "api/wpr/status"
	API for getting the status of a Windows performance recorder trace session. More...

static readonly string	DevicePortalCertificateIssuer = "Microsoft Windows Web Management"
	Issuer for the device certificate. More...

static readonly string	RootCertificateEndpoint = "config/rootcertificate"
	Endpoint used to access the certificate. More...

static readonly string	HolographicIpdApi = "api/holographic/os/settings/ipd"
	API for getting or setting Interpupilary distance More...

static readonly string	HolographicServicesApi = "api/holographic/os/services"
	API for getting a list of running HoloLens specific services. More...

static readonly string	HolographicWebManagementHttpSettingsApi = "api/holographic/os/webmanagement/settings/https"
	API for getting or setting HTTPS setting More...

static readonly string	HolographicPerceptionClient = "api/holographic/perception/client"
	API for running a Perception client. More...

static readonly string	HolographicSimulationModeApi = "api/holographic/simulation/control/mode"
	API for getting or setting the Holographic Perception Simulation control mode. More...

static readonly string	HolographicSimulationStreamApi = "api/holographic/simulation/control/Stream"
	API for controlling the Holographic Perception Simulation control stream. More...

static readonly string	ThermalStageApi = "api/holographic/thermal/stage"
	API for getting the thermal stage More...

static readonly string	MrcFileApi = "api/holographic/mrc/file"
	API for getting or deleting a Mixed Reality Capture file. More...

static readonly string	MrcFileListApi = "api/holographic/mrc/files"
	API for getting the list of Holographic Mixed Reality Capture files. More...

static readonly string	MrcPhotoApi = "api/holographic/mrc/photo"
	API for taking a Mixed Reality Capture photo. More...

static readonly string	MrcSettingsApi = "api/holographic/mrc/settings"
	API for getting or setting the default Mixed Reality Capture settings. More...

static readonly string	MrcStartRecordingApi = "api/holographic/mrc/video/control/start"
	API for starting a Holographic Mixed Reality Capture recording. More...

static readonly string	MrcStatusApi = "api/holographic/mrc/status"
	API for getting the Holographic Mixed Reality Capture status. More...

static readonly string	MrcStopRecordingApi = "api/holographic/mrc/video/control/stop"
	API for stopping a Holographic Mixed Reality Capture recording. More...

static readonly string	MrcLiveStreamApi = "api/holographic/stream/live.mp4"
	API for getting a live Holographic Mixed Reality Capture stream. More...

static readonly string	MrcLiveStreamHighwResApi = "api/holographic/stream/live_high.mp4"
	API for getting a high resolution live Holographic Mixed Reality Capture stream. More...

static readonly string	MrcLiveStreamLowResApi = "api/holographic/stream/live_low.mp4"
	API for getting a low resolution live Holographic Mixed Reality Capture stream. More...

static readonly string	MrcLiveStreamMediumResApi = "api/holographic/stream/live_med.mp4"
	API for getting a medium resolution live Holographic Mixed Reality Capture stream. More...

static readonly string	MrcThumbnailApi = "api/holographic/mrc/thumbnail"
	API for getting a mixed reality capture thumbnail More...

static readonly string	HolographicSimulationPlaybackSessionFileApi = "api/holographic/simulation/playback/session/file"
	API for loading or unloading a Holographic Perception Simulation recording. More...

static readonly string	HolographicSimulationPlaybackPauseApi = "api/holographic/simulation/playback/session/pause"
	API for pausing a Holographic Perception Simulation recording. More...

static readonly string	HolographicSimulationPlaybackFileApi = "api/holographic/simulation/playback/file"
	API for uploading or deleting a Holographic Perception Simulation recording file. More...

static readonly string	HolographicSimulationPlaybackFilesApi = "api/holographic/simulation/playback/files"
	API for retrieving a list of a Holographic Perception Simulation recording files. More...

static readonly string	HolographicSimulationPlaybackPlayApi = "api/holographic/simulation/playback/session/play"
	API for starting playback of a Holographic Perception Simulation recording. More...

static readonly string	HolographicSimulationPlaybackRecordingsApi = "api/holographic/simulation/playback/session/files"
	API for loading or unloading a Holographic Perception Simulation recording. More...

static readonly string	HolographicSimulationPlaybackStateApi = "api/holographic/simulation/playback/session"
	API for retrieving the playback state of a Holographic Perception Simulation recording. More...

static readonly string	HolographicSimulationPlaybackStopApi = "api/holographic/simulation/playback/session/stop"
	API for starting playback of a Holographic Perception Simulation recording. More...

static readonly string	HolographicSimulationPlaybackDataTypesApi = "api/holographic/simulation/playback/session/types"
	API for retrieving the types of data in a Holographic Perception Simulation recording. More...

static readonly string	HolographicSimulationRecordingStatusApi = "api/holographic/simulation/recording/status"
	API for getting a Holographic Perception Simulation recording status. More...

static readonly string	StartHolographicSimulationRecordingApi = "api/holographic/simulation/recording/start"
	API for starting a Holographic Perception Simulation recording. More...

static readonly string	StopHolographicSimulationRecordingApi = "api/holographic/simulation/recording/stop"
	API for stopping a Holographic Perception Simulation recording. More...

static readonly string	AppsListApi = "api/iot/appx/default"
	IoT device application list API. More...

static readonly string	HeadlessAppsListApi = "api/iot/appx/listHeadlessApps"
	IoT device headless application list API. More...

static readonly string	HeadlessStartupAppApi = "api/iot/appx/startupHeadlessApp"
	IoT device headless startup application API. More...

static readonly string	ActivatePackageApi = "api/iot/appx/app"
	IoT device package activation API. More...

static readonly string	AudioDeviceListApi = "api/iot/audio/listdevices"
	List Audio Devices API. More...

static readonly string	SetRenderVolumeApi = "api/iot/audio/setrendervolume"
	API to set render volume on audio devices connected to IoT Core devices. More...

static readonly string	SetCaptureVolumeApi = "api/iot/audio/setcapturevolume"
	API to set capture volume on audio devices connected to IoT Core devices. More...

static readonly string	AvailableBluetoothDevicesApi = "api/iot/bt/getavailable"
	Available bluetooth device list API. More...

static readonly string	PairedBluetoothDevicesApi = "api/iot/bt/getpaired"
	Paired bluetooth devices list API. More...

static readonly string	PairBluetoothDevicesApi = "api/iot/bt/pair"
	API to pair a bluetooth device. More...

static readonly string	UnpairBluetoothDevicesApi = "api/iot/bt/unpair"
	API to unpair a bluetooth device. More...

static readonly string	IoTOsInfoApi = "api/iot/device/information"
	IOT device information API. More...

static readonly string	TimezoneInfoApi = "api/iot/device/timezones"
	IOT device timezone API. More...

static readonly string	DateTimeInfoApi = "api/iot/device/datetime"
	IOT device datetime API. More...

static readonly string	ControllerDriverApi = "api/iot/device/controllersdriver"
	IOT device Controller Driver API. More...

static readonly string	DisplayResolutionApi = "api/iot/device/displayresolution"
	IOT display resolution API. More...

static readonly string	DisplayOrientationApi = "api/iot/device/displayorientation"
	IOT display orientation API. More...

static readonly string	DeviceNameApi = "api/iot/device/name"
	IOT device name API. More...

static readonly string	ResetPasswordApi = "api/iot/device/password"
	IOT Device password API. More...

static readonly string	NewRemoteDebuggingPinApi = "api/iot/device/remotedebuggingpin"
	IOT remote debugging pin API. More...

static readonly string	SetTimeZoneApi = "api/iot/device/settimezone"
	IOT set timezone API. More...

static readonly string	IcsInterfacesApi = "api/iot/ics/interfaces"
	IOT ICS Interface API. More...

static readonly string	IcSharingApi = "api/iot/ics/sharing"
	IOT ICS Sharing API. More...

static readonly string	SoftAPSettingsApi = "api/iot/iotonboarding/softapsettings"
	IOT SoftAP Settings API. More...

static readonly string	AllJoynSettingsApi = "api/iot/iotonboarding/alljoynsettings"
	IOT AllJoyn Settings API. More...

static readonly string	TpmSettingsApi = "api/iot/tpm/settings"
	TPM settings API. More...

static readonly string	TpmAcpiTablesApi = "api/iot/tpm/acpitables"
	Advanced Configuration and Power Interface(ACPI) information API. More...

static readonly string	TpmAzureTokenApi = "api/iot/tpm/azuretoken"
	TPM Azure Token API. More...

static readonly string	RunCommandApi = "api/iot/processmanagement/runcommand"
	IOT Run Command API. More...

static readonly string	RunCommandWithoutOutputApi = "api/iot/processmanagement/runcommandwithoutput"
	IOT Run Command Without Output API. More...

static readonly string	RemoteSettingsStatusApi = "api/iot/remote/status"
	Remote status API. More...

static readonly string	RemoteSettingsEnableApi = "api/iot/remote/enable"
	Enable Remote Settings API. More...

static readonly string	RemoteSettingsDisableApi = "api/iot/remote/disable"
	Disable Remote Settings API. More...

static readonly string	InstallTimeApi = "api/iot/windowsupdate/installtime"
	Install time API. More...

static readonly string	StatusApi = "api/iot/windowsupdate/status"
	Update status API. More...

static readonly string	FiddlerSetupApi = "ext/fiddler"
	Endpoint for enabling and disabling a Fiddler proxy. More...

static readonly string	XboxLiveUserApi = "ext/user"
	Endpoint for User management REST calls More...

static readonly string	RegisterPackageApi = "api/app/packagemanager/register"
	REST endpoint for registering a package from a loose folder More...

static readonly string	UploadPackageFolderApi = "api/app/packagemanager/upload"
	REST endpoint for uploading a folder to the DevelopmentFiles loose folder. More...

static readonly string	XboxLiveSandboxApi = "ext/xboxlive/sandbox"
	Endpoint for getting or changing the Xbox Live sandbox for the device. More...

static readonly string	GetXboxScreenshotApi = "ext/screenshot"
	Endpoint for getting a screenshot. More...

static readonly string	XboxSettingsApi = "ext/settings"
	Endpoint for Xbox settings management REST calls. More...

Properties
WebSocketMessageReceivedEventHandler< DeviceProcesses >	ProcessesMessageReceived `[get, set]`
	Gets or sets the processes message received handler. More...

string	Address `[get]`
	Gets the device address. More...

HttpStatusCode	ConnectionHttpStatusCode `[get]`
	Gets the status code for establishing our connection. More...

string	ConnectionFailedDescription `[get]`
	Gets a description of why the connection failed. More...

string	DeviceFamily `[get]`
	Gets the device operating system family. More...

string	OperatingSystemVersion `[get]`
	Gets the operating system version. More...

DevicePortalPlatforms	Platform `[get]`
	Gets the device platform. More...

string	PlatformName `[get]`
	Gets the device platform name. More...

Events
UnvalidatedCertEventHandler	UnvalidatedCert
	Gets or sets handler for untrusted certificate handling More...

ApplicationInstallStatusEventHandler	AppInstallStatus
	App Install Status handler. More...

WebSocketMessageReceivedEventHandler< RunningProcesses >	RunningProcessesMessageReceived
	The running processes message received handler. More...

WebSocketMessageReceivedEventHandler< SystemPerformanceInformation >	SystemPerfMessageReceived
	The system perf message received handler. More...

DeviceConnectionStatusEventHandler	ConnectionStatus
	Handler for reporting connection status. More...

WebSocketMessageReceivedEventHandler< AvailableBluetoothDevicesInfo >	BluetoothDeviceListReceived
	Gets or sets the list of bluetooth devices received handler. More...

WebSocketMessageReceivedEventHandler< PairedBluetoothDevicesInfo >	PairedBluetoothDeviceListReceived
	Gets or sets the list of paired bluetooth devices received handler. More...

WebSocketMessageReceivedEventHandler< PairBluetoothDevicesInfo >	PairBluetoothDeviceListReceived
	Gets the results of pairing bluetooth device received handler. More...

Detailed Description

This is the main DevicePortal object. It contains methods for making HTTP REST calls against all of the WDP endpoints covered by the wrapper project. Different endpoints have their implementation separated out into individual files.

Windows update APIs for IoT.

Wrappers for remote settings for IoT.

TPM Limpet APIs for IoT.

Wrappers for IoT Onboarding methods.

<content> MOCK implementation of App Deployment methods. </content>

<content> MOCK implementation of device certificate handling methods. </content>

<content> MOCK implementation of HTTP Delete </content>

<content> MOCK implementation of HTTP Get </content>

<content> MOCK implementation of HTTP Post </content>

<content> MOCK implementation of HTTP PUT </content>

<content> .net 4.x implementation of device certificate handling methods. </content>

<content> .net 4.x implementation of App Deployment methods. </content>

<content> .net 4.x implementation of HTTP Delete </content>

<content> .net 4.x implementation of HTTP Get </content>

<content> .net 4.x implementation of HTTP Post </content>

<content> .net 4.x implementation of HTTP Put </content>

<content> Wrappers for App Deployment methods. </content>

<content> Wrappers for App File explorer methods </content>

<content> Wrappers for device management methods. </content>

<content> Wrappers for DNS methods </content>

<content> Wrappers for crash dump collection methods. </content>

<content> Wrappers for ETW methods </content>

<content> Wrappers for Networking methods. </content>

<content> Wrappers for OS Information. </content>

<content> Wrappers for Performance methods </content>

<content> Wrappers for Power methods. </content>

<content> Wrappers for Remote Control methods. </content>

<content> Wrappers for Resource Manager methods. </content>

<content> Wrappers for Task Manager methods </content>

<content> Wrappers for WiFi management methods. </content>

<content> Wrappers for Holographic OS methods </content>

<content> Wrappers for Holographic Perception methods </content>

<content> Wrappers for Holographic Thermal methods </content>

<content> Wrappers for Mixed reality capture methods </content>

<content> Wrappers for Perception Simulation Playback methods </content>

<content> Wrappers for Perception Simulation Recording methods </content>

<content> Methods for working with Http headers. </content>

<content> Methods for working with Http requests. </content>

<content> Methods for working with Http responses. </content>

<content> HTTP DELETE Wrapper </content>

<content> HTTP GET Wrapper </content>

<content> HTTP POST Wrapper </content>

<content> HTTP PUT Wrapper </content>

<content> Wrappers for Application Management. </content>

<content> Wrappers for Audio Devices. </content>

<content> Wrappers for Bluetooth Connectivity. </content>

<content> Wrappers for Device Information. </content>

<content> Wrappers for Internet Connection Sharing(ICS) Settings. </content>

<content> Wrappers for IoT Process Management. </content>

<content> Fiddler setup Wrappers </content>

<content> SMBShare Wrappers </content>

<content> UserManagement Wrappers </content>

<content> Register Application Wrappers </content>

<content> Xbox Live Sandbox Wrappers </content>

<content> MediaCapture Wrappers </content>

<content> XboxSettings Wrappers </content>

<content> Universal Windows Platform implementation of device certificate handling methods. </content>

<content> Universal Windows Platform implementation of App Deployment methods. </content>

<content> Universal Windows Platform implementation of HTTP Delete </content>

<content> Universal Windows Platform implementation of HTTP Get </content>

<content> Universal Windows Platform implementation of HTTP Post </content>

<content> Universal Windows Platform implementation of HTTP Put </content>

Member Enumeration Documentation

enum Microsoft.Tools.WindowsDevicePortal.DevicePortal.DevicePortalPlatforms

strong

Device portal platforms

Enumerator
Unknown	Unknown platform
Windows	Windows platform
Mobile	Mobile platform
HoloLens	HoloLens platform
XboxOne	Xbox One platform
IoTDragonboard410c	Windows IoT on Dragonboard 410c
IoTMinnowboardMax	Windows IoT on Minnowboard Max
IoTRaspberryPi2	Windows IoT on Raspberry Pi 2
IoTRaspberryPi3	Windows IoT on Raspberry Pi 3
VirtualMachine	A virtual machine. This may or may not be an emulator.

enum Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationPlaybackStates

strong

Enumeration describing the available Holgraphic Simulation playback states.

Enumerator
Stopped	The simulation has been stopped.
Playing	The simulation is playing.
Paused	The simulation has been paused.
Complete	Playback has completed.
Unexpected	Playback is in an unexpected / unknown state.

enum Microsoft.Tools.WindowsDevicePortal.DevicePortal.HttpMethods

strong

HTTP Methods

Enumerator
Get	The HTTP Get method.
Put	The HTTP Put method.
Post	The HTTP Post method.
Delete	The HTTP Delete method.
WebSocket	The HTTP WebSocket method.

enum Microsoft.Tools.WindowsDevicePortal.DevicePortal.SimulationControlMode

strong

Enumeration defining the control modes used by the Holographic Perception Simulation.

Enumerator
Default	Default mode.
Simulation	Simulation mode.
Remote	Remote mode.
Legacy	Legacy mode.

Constructor & Destructor Documentation

Microsoft.Tools.WindowsDevicePortal.DevicePortal.DevicePortal ( IDevicePortalConnection connection )

inline

Initializes a new instance of the DevicePortal class.

Parameters

connection Implementation of a connection object.

Member Function Documentation

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.ActivatePackage ( string appId )

inline

Activiates the selected app package.

Parameters

appId App Id.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.AddServiceTag ( string tagValue )

inline

Adds a tag to this device's DNS-SD broadcast.

Parameters

tagValue The tag to assign to the device.

Returns: Task tracking adding the tag.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.Connect	(	string	ssid = `null`,
		string	ssidKey = `null`,
		bool	updateConnection = `true`,
		X509Certificate2	manualCertificate = `null`
	)

inline

Connects to the device pointed to by IDevicePortalConnection provided in the constructor.

Parameters

ssid	Optional network SSID.
ssidKey	Optional network key.
updateConnection	Indicates whether we should update this connection's IP address after connecting.
manualCertificate	A manually provided X509 Certificate for trust validation against this device.

Connect sends ConnectionStatus events to indicate the current progress in the connection process. Some applications may opt to not register for the ConnectionStatus event and await on Connect.

Returns: Task for tracking the connect.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.ConnectToWifiNetwork	(	Guid	networkAdapter,
		string	ssid,
		string	networkKey
	)

inline

Connect to a WiFi network using a given network adapter and SSID.

Parameters

networkAdapter	Network adaptor GUID.
ssid	SSID of the network.
networkKey	Network key.

Returns: Task tracking connection status.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.DeleteAllTags ( )

inline

Delete all tags from the device's DNS-SD broadcast.

Returns: Task tracking deletion of all tags.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.DeleteFile	(	string	knownFolderId,
		string	filename,
		string	subPath = `null`,
		string	packageFullName = `null`
	)

inline

Deletes a file from a Known Folder.

Parameters

knownFolderId	The known folder id for the root of the path.
filename	The name of the file we are deleting.
subPath	An optional subpath to the folder.
packageFullName	The package full name if using LocalAppData.

Returns: Task tracking completion of the delete request.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.DeleteHolographicSimulationRecording ( string name )

inline

Deletes the specified Holographic Simulation recording.

Parameters

name	The name of the recording to delete (ex: testsession.xef).

Returns: Task tracking completion of the REST call.

This method is only supported on HoloLens devices.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.DeleteMrcFile ( string fileName )

inline

Removes a Mixed Reality Capture file from the device's local storage.

Parameters

fileName The name of the file to be deleted.

This method is only supported on HoloLens devices.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.DeleteTag ( string tagValue )

inline

Delete a specific tag from the device's DNS-SD broadcast.

Parameters

tagValue The tag to delete from the device broadcast.

Returns: Task tracking deletion of the tag.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.DisableFiddlerTracing ( )

inline

Disables Fiddler on the console.

Returns: Task tracking completion. A reboot will be required before tracing stops.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.EnableFiddlerTracing	(	string	proxyAddress,
		string	proxyPort,
		string	certFilePath = `null`
	)

inline

Enables Fiddler on the console with the specified proxy.

Parameters

proxyAddress	The address of the proxy.
proxyPort	The port the proxy is listening on.
certFilePath	An optional path to the cert file to use.

Returns: Task tracking completion. A reboot will be required before the tracing begins.

async Task<Guid> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetActivePowerScheme ( )

inline

Returns the current active power scheme.

Returns: The power scheme identifier.

async Task<AllJoynSettingsInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetAllJoynSettingsInfo ( )

inline

Retrieves the All Joyn Settings Info.

Returns: AllJoynSettingsInfo for this device.

async Task<AppsListInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetAppsListInfo ( )

inline

Gets List of apps.

Returns: Object containing the list of applications.

async Task<AudioDeviceListInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetAudioDeviceListInfo ( )

inline

Gets the Audio Device List Information.

Returns: String containing the Audio Device List information.

AvailableBluetoothDevicesInfo Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetAvailableBluetoothDevicesInfo ( )

inline

Gets the available bluetooth device information.

Returns: List of Available bluetooth devices

async Task<BatteryState> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetBatteryState ( )

inline

Returns the current state of the device's battery.

Returns: BatteryState object containing details such as the current battery level.

async Task<ControllerDriverInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetControllerDriverInfo ( )

inline

Gets the controller driver information.

Returns: String containing the controller driver information.

async Task<DateTimeInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetDateTimeInfo ( )

inline

Gets the datetime information.

Returns: String containing the datetime information.

async Task<string> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetDeviceFamily ( )

inline

Gets the family name (ex: Windows.Holographic) of the device.

Returns: String containing the device's family.

async Task<List<Device> > Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetDeviceList ( )

inline

Get a listing of installed devices

Returns: List of installed devices

async Task<string> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetDeviceName ( )

inline

Gets the name of the device.

Returns: String containing the device's name.

async Task<DisplayOrientationInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetDisplayOrientationInfo ( )

inline

Gets the dispaly orientation information.

Returns: String containing the dispaly orientation information.

async Task<DisplayResolutionInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetDisplayResolutionInfo ( )

inline

Gets the dispaly resolution information.

Returns: String containing the dispaly resolution information.

async Task<Stream> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetFile	(	string	knownFolderId,
		string	filename,
		string	subPath = `null`,
		string	packageFullName = `null`
	)

inline

Gets a file from LocalAppData or another Known Folder on the device.

Parameters

knownFolderId	The known folder id for the root of the path.
filename	The name of the file we are downloading.
subPath	An optional subpath to the folder.
packageFullName	The package full name if using LocalAppData.

Returns: Stream to the downloaded file.

async Task<FolderContents> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetFolderContents	(	string	knownFolderId,
		string	subPath = `null`,
		string	packageFullName = `null`
	)

inline

Gets a list of files in a Known Folder (e.g. LocalAppData).

Parameters

knownFolderId	The known folder id for the root of the path.
subPath	An optional subpath to the folder.
packageFullName	The package full name if using LocalAppData.

Returns: Contents of the requested folder.

async Task<HeadlessAppsListInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetHeadlessAppsListInfo ( )

inline

Gets list of headless apps.

Returns: Object containing the list of headless applications.

async Task<HolographicSimulationPlaybackStates> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetHolographicSimulationPlaybackState ( string name )

inline

Gets the playback state of a Holographic Simulation recording.

Parameters

name	The name of the recording (ex: testsession.xef).

Returns: HolographicSimulationPlaybackStates enum value describing the state of the recording.

This method is only supported on HoloLens devices.

async Task<bool> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetHolographicSimulationRecordingStatus ( )

inline

Gets the holographic simulation recording status.

Returns: True if recording, false otherwise.

This method is only supported on HoloLens devices.

async Task<IscInterfacesInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetIcsInterfacesInfo ( )

inline

Gets the internet connection sharing(ICS) interfaces .

Returns: String containing the internet connection sharing(ICS) interfaces.

async Task<AppPackages> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetInstalledAppPackages ( )

inline

Gets the collection of applications installed on the device.

Returns: AppPackages object containing the list of installed application packages.

async Task<ApplicationInstallStatus> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetInstallStatus ( )

inline

API for getting installation status.

Returns: The status

async Task<ApplicationInstallStatus> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetInstallStatus ( )

inline

Gets the status of a pending or most recent installation, if any.

Returns: The status

async Task<ApplicationInstallStatus> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetInstallStatus ( )

inline

API for getting installation status.

Returns: The status

async Task<float> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetInterPupilaryDistance ( )

inline

Gets the interpupilary distance registered on the device.

Returns: Interpupilary distance, in millimeters.

This method is only supported on HoloLens devices.

async Task<IoTOSInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetIoTOSInfo ( )

inline

Gets the IoT OS Information.

Returns: String containing the OS information.

async Task<IpConfiguration> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetIpConfig ( )

inline

Gets the IP configuration data of the device.

Returns: object containing details of the device's network configuration.

async Task<bool> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetIsHttpsRequired ( )

inline

Gets the WiFi http security requirements for communication with the device.

Returns: True if WiFi based communication requires a secure connection, false otherwise.

This method is only supported on HoloLens devices.

async Task<KnownFolders> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetKnownFolders ( )

inline

Gets a list of Known Folders on the device.

Returns: List of known folders available on this device.

async Task<byte[]> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetMrcFileData	(	string	fileName,
		bool	isThumbnailRequest = `false`
	)

inline

Gets the capture file data

Parameters

fileName	Name of the file to retrieve
isThumbnailRequest	Whether or not we just want a thumbnail

Returns: Byte array containing the file data.

This method is only supported on HoloLens devices.

async Task<MrcFileList> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetMrcFileList ( )

inline

Gets the list of capture files

Returns: List of the capture files

This method is only supported on HoloLens devices.

async Task<MrcStatus> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetMrcStatus ( )

inline

Gets the status of the reality capture

Returns: Status of the capture

This method is only supported on HoloLens devices.

async Task<byte[]> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetMrcThumbnailData ( string fileName )

inline

Gets thumbnail data for the capture

Parameters

fileName Name of the capture file

Returns: Byte array containing the thumbnail image data

This method is only supported on HoloLens devices.

async Task<OperatingSystemInformation> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetOperatingSystemInformation ( )

inline

Gets information about the device's operating system.

Returns: OperatingSystemInformation object containing details of the installed operating system.

PairBluetoothDevicesInfo Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetPairBluetoothDevicesInfo ( string deviceId )

inline

Gets the results for pairing a bluetooth device.

Returns: Results of pairing a bluetooth device

PairedBluetoothDevicesInfo Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetPairedBluetoothDevicesInfo ( )

inline

Gets the paired bluetooth device information.

Returns: List of paired bluetooth devices

async Task<SimulationControlMode> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetPerceptionSimulationControlMode ( )

inline

Gets the perception simulation control mode.

Returns: The simulation control mode.

This method is only supported on HoloLens devices.

async Task<PowerState> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetPowerState ( )

inline

Gets the device's current power state.

Returns: PowerState object containing details such as whether or not the device is in low power mode.

async Task<RemoteSettingsStatusInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetRemoteSettingsStatusInfo ( )

inline

Gets the Remote Settings Status Information.

Returns: String containing the Remote Settings Status information.

async Task<Certificate> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetRootDeviceCertificate ( bool acceptUntrustedCerts = false )

inline

Gets the root certificate from the device.

Parameters

acceptUntrustedCerts Whether or not we should accept untrusted certificates.

Returns: The device certificate.

async Task<X509Certificate2> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetRootDeviceCertificate ( )

inline

Gets the root certificate from the device.

Returns: The device certificate.

async Task<RunningProcesses> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetRunningProcesses ( )

inline

Gets the collection of processes running on the device.

Returns: RunningProcesses object containing the list of running processes.

async Task<List<string> > Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetServiceTags ( )

inline

Gets a list of DNS-SD tags being broadcast by this device.

Returns: Array of strings, each one an individual tag.

async Task<SmbInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetSmbShareInfo ( )

inline

Gets the SMB Share info for the device

Returns: The SMB path, username, and password.

async Task<SoftAPSettingsInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetSoftAPSettingsInfo ( )

inline

Retrieves the Soft AP Settings Info.

Returns: SoftAPSettingsInfo for this device.

async Task<StatusInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetStatusInfo ( )

inline

Gets Status information.

Returns: String containing the status information.

async Task<SystemPerformanceInformation> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetSystemPerf ( )

inline

Gets system performance information for the device.

Returns: SystemPerformanceInformation object containing information such as memory usage.

async Task<ThermalStages> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetThermalStage ( )

inline

Gets the current thermal stage reading from the device.

Returns: ThermalStages enum value.

This method is only supported on HoloLens devices.

async Task<TimezoneInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetTimezoneInfo ( )

inline

Gets the Timezone information.

Returns: String containing the timezone information.

async Task<TpmAcpiTablesInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetTpmAcpiTablesInfo ( )

inline

Gets TPM ACPI Tables information.

Returns: List of string containing the TPM ACPI Tables information.

async Task<TpmAzureTokenInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetTpmAzureTokenInfo	(	int	logicalDeviceId,
		string	validity
	)

inline

Gets TPM Azure Token information.

Returns: String containing the TPM Azure Token information.

async Task<TpmLogicalDeviceSettingsInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetTpmLogicalDeviceSettingsInfo ( int logicalDeviceId )

inline

Gets TPM Logical Device Settings information.

Returns: String containing the TPM Logical Device Settings information.

async Task<TpmSettingsInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetTpmSettingsInfo ( )

inline

Gets Tpm Settings information.

Returns: String containing theTpm Settings information.

async Task<UpdateInstallTimeInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetUpdateInstallTime ( )

inline

Gets the update install time information.

Returns: String containing the update install time information.

async Task<WifiInterfaces> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetWifiInterfaces ( )

inline

Gets WiFi interfaces.

Returns: List of WiFi interfaces.

async Task<WifiNetworks> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetWifiNetworks ( Guid interfaceGuid )

inline

Gets WiFi networks as seen from a WiFi interface.

Parameters

interfaceGuid Interface to get networks from.

Returns: List of available networks.

async Task<Sandbox> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetXboxLiveSandbox ( )

inline

Gets the current Xbox Live sandbox value for this device.

Returns: The value of the current sandbox this device is in.

async Task<UserList> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetXboxLiveUsers ( )

inline

Gets the Xbox Live user info for all users present on the device

Returns: UserList object containing a List of UserInfo objects representing the users on the device.

async Task<XboxSetting> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetXboxSetting ( string settingName )

inline

Gets the value for a single setting.

Parameters

settingName Name of the setting we want to retrieve.

Returns: XboxSetting object containing a information about the settings on the device.

async Task<XboxSettingList> Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetXboxSettings ( )

inline

Gets the Xbox Settings info for all settings which can be controlled on the device.

Returns: XboxSettingList object containing a List of XboxSetting objects representing the settings on the device.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.IcSharingStart	(	string	privateInterface,
		string	publicInterface
	)

inline

Starts internet connection sharing(ICS).

Parameters

privateInterface	Private Interface.
publicInterface	Public Interface.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.IcSharingStop	(	string	privateInterface,
		string	publicInterface
	)

inline

Stops internet connection sharing(ICS).

Parameters

privateInterface	Private Interface.
publicInterface	Public Interface.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.InstallApplication	(	string	appName,
		string	packageFileName,
		List< string >	dependencyFileNames,
		string	certificateFileName = `null`,
		short	stateCheckIntervalMs = `500`,
		short	timeoutInMinutes = `15`,
		bool	uninstallPreviousVersion = `true`
	)

inline

Installs an application

Parameters

appName	Friendly name (ex: Hello World) of the application. If this parameter is not provided, the name of the package is assumed to be the app name.
packageFileName	Full name of the application package file.
dependencyFileNames	List containing the full names of any required dependency files.
certificateFileName	Full name of the optional certificate file.
stateCheckIntervalMs	How frequently we should check the installation state.
timeoutInMinutes	Operation timeout.
uninstallPreviousVersion	Indicate whether or not the previous app version should be uninstalled prior to installing.

InstallApplication sends ApplicationInstallStatus events to indicate the current progress in the installation process. Some applications may opt to not register for the AppInstallStatus event and await on InstallApplication.

Returns: Task for tracking completion of install initialization.

async Task<int> Microsoft.Tools.WindowsDevicePortal.DevicePortal.LaunchApplication	(	string	appid,
		string	packageName
	)

inline

Starts running the specified application.

Parameters

appid	Application ID
packageName	The name of the application package.

Returns: Process identifier for the application instance.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.LoadHolographicSimulationRecording ( string name )

inline

Loads the specified Holographic Simulation recording.

Parameters

name	The name of the recording to load (ex: testsession.xef).

Returns: Task tracking completion of the REST call.

This method is only supported on HoloLens devices.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.Reboot ( )

inline

Reboots the device.

Returns: Task tracking reboot completion.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.RegisterApplication ( string folderName )

inline

Registers a loose app on the console

Parameters

folderName Relative folder path where the app can be found.

Returns: Task for tracking async completion.

async Task<RemoteSettingsStatusInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.RemoteSettingsDisable ( )

inline

Disables the remote settings.

Returns: Task tracking completion of the REST call.

async Task<RemoteSettingsStatusInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.RemoteSettingsEnable ( )

inline

Enables the remote settings.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.RemoveHeadlessStartupApp ( string appId )

inline

Removes the selected app from the headless startup app list.

Parameters

appId App Id.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.RenameFile	(	string	knownFolderId,
		string	filename,
		string	newFilename,
		string	subPath = `null`,
		string	packageFullName = `null`
	)

inline

Renames a file in a Known Folder.

Parameters

knownFolderId	The known folder id for the root of the path.
filename	The name of the file we are renaming.
newFilename	The new name for this file.
subPath	An optional subpath to the folder.
packageFullName	The package full name if using LocalAppData.

Returns: Task tracking completion of the rename request.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.ResetTpmLogicalDeviceSettingsInfo ( int logicalDeviceId )

inline

Resets TPM Logical Device Settings information.

Parameters

logicalDeviceId Logical Device Id.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.RunCommand	(	string	command,
		string	runAsDefaultAccount
	)

inline

Runs the command.

Parameters

command Command.

///

Parameters

runAsDefaultAccount Run As Default Account.

Returns: Task tracking completion of the REST call.

async Task<RunCommandOutputInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.RunCommandWithoutOutput	(	string	commandWithoutOutput,
		string	runAsDefaultAccount,
		string	timeout
	)

inline

Runs the command.

Parameters

commandWithoutOutput	Command Without Output.
runAsDefaultAccount	Run As Default Account.
timeout	Timeout.

Returns: String containing the output after the command is executed.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SaveEndpointResponseToFile	(	string	endpoint,
		string	directory,
		HttpMethods	httpMethod,
		Stream	requestBody = `null`,
		string	requestBodyContentType = `null`
	)

inline

Helper method used for saving the content of a response to a file. This allows unittests to easily generate real data to use as mock responses.

Parameters

endpoint	API endpoint we are calling.
directory	Directory to store our file.
httpMethod	The http method to be performed.
requestBody	An optional stream to use for the request body content.
requestBodyContentType	The content type of the request stream.

Returns: Task waiting for HTTP call to return and file copy to complete.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetAllJoynSettings	(	string	allJoynStatus,
		string	allJoynDescription,
		string	allJoynManufacturer,
		string	allJoynModelNumber
	)

inline

Sets AllJoyn Settings.

Parameters

allJoynStatus	AllJoyn Status.
allJoynDescription	AllJoyn Description.
allJoynManufacturer	AllJoyn Manufacturer.
allJoynNumber	AllJoyn Number.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetCaptureVolume ( string captureVolume )

inline

Sets volume for the audio devices.

Parameters

captureVolume Capture Volume.

Returns: Task tracking completion of the REST call.

async Task<ControllerDriverInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetControllersDrivers ( string newDriver )

inline

Sets controllers drivers.

Parameters

newDriver Driver to set.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetDeviceName ( string name )

inline

Sets the device's name

Parameters

name	The name to assign to the device.

The new name does not take effect until the device has been restarted.

Returns: Task tracking setting the device name completion.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetDisplayOrientation ( string displayOrientation )

inline

Set display orientation.

Parameters

displayOrientation Desired orientation.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetDisplayResolution ( string displayResolution )

inline

Sets display resolution.

Parameters

displayResolution New display resolution.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetInterPupilaryDistance ( float ipd )

inline

Sets the interpupilary distance registered on the device.

Parameters

ipd	Interpupilary distance, in millimeters.

Returns: Task for tracking the POST call

This method is only supported on HoloLens devices.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetIoTDeviceName ( string name )

inline

Sets the Device Name.

Parameters

name	Name to set for the device.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetIsHttpsRequired ( bool httpsRequired )

inline

Sets the WiFi http security requirements for communication with the device.

Parameters

httpsRequired Desired value for HTTPS communication

Returns: True if WiFi based communication requires a secure connection, false otherwise.

This method is only supported on HoloLens devices.

async Task<ErrorInformation> Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetNewPassword	(	string	oldPassword,
		string	newPassword
	)

inline

Sets a new password.

Parameters

oldPassword	Old password.
newPassword	New desired password.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetNewRemoteDebuggingPin ( string newPin )

inline

Sets a new remote debugging pin.

Parameters

newPin New pin.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetPerceptionSimulationControlMode ( SimulationControlMode mode )

inline

Sets the perception simulation control mode.

Parameters

mode	The simulation control mode.

This method is only supported on HoloLens devices.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetRenderVolume ( string renderVolume )

inline

Sets volume for the audio devices.

Parameters

renderVolume Render Volume.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetSoftApSettings	(	string	softApStatus,
		string	softApSsid,
		string	softApPassword
	)

inline

Sets SoftAp Settings.

Parameters

softApStatus	SoftAp Status.
softApSsid	SoftAp Ssid.

///

Parameters

SoftAp Password SoftAp Password.

Returns: Task tracking completion of the REST call.

async Task<ErrorInformation> Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetTimeZone ( int index )

inline

Sets Timezone.

Parameters

index Timezone index.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetTpmAcpiTablesInfo ( string acpiTableIndex )

inline

Sets TPM ACPI Tables information.

Parameters

acpiTableIndex ACPI Table Index.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetTpmLogicalDeviceSettingsInfo	(	int	logicalDeviceId,
		string	azureUri,
		string	azureKey
	)

inline

Sets TPM Logical Device Settings information.

Parameters

logicalDeviceId	Logical Device Id.
azureUri	Azure Uri.
Azure Key	Azure Key.

Returns: Task tracking completion of the REST call.

async Task<Sandbox> Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetXboxLiveSandbox ( string newSandbox )

inline

Sets the Xbox Live sandbox on the device.

Parameters

newSandbox The new sandbox to move this device into.

Returns: Task tracking completion. A reboot will be required may be required before the sandbox change takes effect on some devices.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.Shutdown ( )

inline

Shuts down the device.

Returns: Task tracking shutdown completion.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StartHolographicSimulationRecording	(	string	name,
		bool	recordHead = `true`,
		bool	recordHands = `true`,
		bool	recordSpatialMapping = `true`,
		bool	recordEnvironment = `true`
	)

inline

Starts a Holographic Simulation recording session.

Parameters

name	The name of the recording.
recordHead	Should head data be recorded? The default value is true.
recordHands	Should hand data be recorded? The default value is true.
recordSpatialMapping	Should Spatial Mapping data be recorded? The default value is true.
recordEnvironment	Should environment data be recorded? The default value is true.

Returns: Task tracking completion of the REST call.

This method is only supported on HoloLens devices.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StartListeningForBluetooth ( string bluetoothApi )

inline

Starts listening for bluetooth list of devices returned from the BluetoothDeviceListReceived handler.

Returns: Task for connecting to the websocket but not for listening to it.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StartListeningForPairBluetooth	(	string	bluetoothApi,
		string	payload
	)

inline

Starts listening for the result to pair the bluetooth device returned from the PairBluetoothDeviceListReceived handler.

Returns: Task for connecting to the websocket but not for listening to it.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StartListeningForPairedBluetooth ( string bluetoothApi )

inline

Starts listening for paired bluetooth list of devices returned from the PairedBluetoothDeviceListReceived handler.

Returns: Task for connecting to the websocket but not for listening to it.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StartListeningForProcesses ( )

inline

Starts listening for the running processes on the device with them being returned via the ProcessesMessageReceived event handler.

Returns: Task for connecting to the websocket but not for listening to it.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StartListeningForRunningProcesses ( )

inline

Starts listening for the running processes on the device with them being returned via the RunningProcessesMessageReceived event handler.

Returns: Task for connecting to the websocket but not for listening to it.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StartListeningForSystemPerf ( )

inline

Starts listening for the system performance information for the device with it being returned via the SystemPerfMessageReceived event handler.

Returns: Task for connecting to the websocket but not for listening to it.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StartMrcRecording	(	bool	includeHolograms = `true`,
		bool	includeColorCamera = `true`,
		bool	includeMicrophone = `true`,
		bool	includeAudio = `true`
	)

inline

Starts a Mixed Reality Capture recording.

Parameters

includeHolograms	Whether to include holograms
includeColorCamera	Whether to include the color camera
includeMicrophone	Whether to include microphone data
includeAudio	Whether to include audio data

This method is only supported on HoloLens devices.

Returns: Task tracking completion of the REST call.

async Task<byte[]> Microsoft.Tools.WindowsDevicePortal.DevicePortal.StopHolographicSimulationRecording ( )

inline

Stops a Holographic Simulation recording session.

Returns: Byte array containing the recorded data.

Exceptions

InvalidOperationException No recording was in progress.

This method is only supported on HoloLens devices.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StopListeningForBluetooth ( )

inline

Stop listening for the list of bluetooth device.

Returns: Task to stop listening for bluetooth devices and disconnecting from the websocket .

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StopListeningForPairBluetooth ( )

inline

Stop listening for the results for pairing bluetooth device.

Returns: Task to stop listening for the bluetooth device and disconnecting from the websocket .

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StopListeningForPairedBluetooth ( )

inline

Stop listening for the list of paired bluetooth device.

Returns: Task to stop listening for bluetooth devices and disconnecting from the websocket .

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StopListeningForProcesses ( )

inline

Stop listening for the running processes on the device.

Returns: Task for stop listening for processes and disconnecting from the websocket .

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StopListeningForRunningProcesses ( )

inline

Stop listening for the running processes on the device.

Returns: Task for stop listening for processes and disconnecting from the websocket .

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StopListeningForSystemPerf ( )

inline

Stop listening for the system performance information for the device.

Returns: Task for stop listening for system perf and disconnecting from the websocket .

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.StopMrcRecording ( )

inline

Stops the Mixed Reality Capture recording

This method is only supported on HoloLens devices.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.TakeMrcPhoto	(	bool	includeHolograms = `true`,
		bool	includeColorCamera = `true`
	)

inline

Take a Mixed Reality Capture photo

Parameters

includeHolograms	Whether to include holograms
includeColorCamera	Whether to include the color camera

This method is only supported on HoloLens devices.

Returns: Task tracking completion of the REST call.

async Task<Stream> Microsoft.Tools.WindowsDevicePortal.DevicePortal.TakeXboxScreenshot ( )

inline

Takes a current screenshot of the device.

Returns: A stream of the screenshot in PNG form.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.TerminateApplication ( string packageName )

inline

Stops the specified application from running.

Parameters

packageName The name of the application package.

Returns: Task for tracking termination completion

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.UninstallApplication ( string packageName )

inline

Uninstalls the specified application.

Parameters

packageName The name of the application package to uninstall.

Returns: Task tracking the uninstall operation.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.UnloadHolographicSimulationRecording ( string name )

inline

Unloads the specified Holographic Simulation recording.

Parameters

name	The name of the recording to unload (ex: testsession.xef).

Returns: Task tracking completion of the REST call.

This method is only supported on HoloLens devices.

async Task<ErrorInformation> Microsoft.Tools.WindowsDevicePortal.DevicePortal.UnPairBluetoothDevice ( string deviceId )

inline

Unpairs the bluetooth device.

Parameters

deviceId Device Id.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.UpdateHeadlessStartupApp ( string appId )

inline

Sets the selected app as the headless startup app.

Parameters

appId App Id.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.UpdateStartupApp ( string appId )

inline

Sets selected app as the startup app.

Parameters

appId App Id.

Returns: Task tracking completion of the REST call.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.UpdateXboxLiveUsers ( UserList users )

inline

Updates info for the Xbox Live users present on the device

Parameters

users List of users to be updated.

Returns: Task for tracking async completion.

async Task<XboxSetting> Microsoft.Tools.WindowsDevicePortal.DevicePortal.UpdateXboxSetting ( XboxSetting setting )

inline

Updates info for the given Xbox setting.

Parameters

setting Setting to be updated.

Returns: Task for tracking async completion.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.UploadFile	(	string	knownFolderId,
		string	filepath,
		string	subPath = `null`,
		string	packageFullName = `null`
	)

inline

Uploads a file to a Known Folder (e.g. LocalAppData)

Parameters

knownFolderId	The known folder id for the root of the path.
filepath	The path to the file we are uploading.
subPath	An optional subpath to the folder.
packageFullName	The package full name if using LocalAppData.

Returns: Task tracking completion of the upload request.

async Task Microsoft.Tools.WindowsDevicePortal.DevicePortal.UploadPackageFolder	(	string	sourceFolder,
		string	destinationFolder
	)

inline

Uploads a folder to the DevelopmentFiles loose folder.

Parameters

sourceFolder	The source folder to upload.
destinationFolder	The destination path to upload it to.

Returns: Task for tracking async completion.

Member Data Documentation

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.ActivatePackageApi = "api/iot/appx/app"

static

IoT device package activation API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.ActivePowerSchemeApi = "api/power/activecfg"

static

API for getting or setting the active power scheme.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.AllJoynSettingsApi = "api/iot/iotonboarding/alljoynsettings"

static

IOT AllJoyn Settings API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.AppsListApi = "api/iot/appx/default"

static

IoT device application list API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.AudioDeviceListApi = "api/iot/audio/listdevices"

static

List Audio Devices API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.AvailableBluetoothDevicesApi = "api/iot/bt/getavailable"

static

Available bluetooth device list API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.AvailableBugChecksApi = "api/debug/dump/kernel/dumplish"

static

API to retrieve list of the available bugcheck minidumps.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.AvailableCrashDumpsApi = "api/debug/dump/usermode/dumps"

static

API to retrieve list of the available crash dumps (for sideloaded applications).

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.BatteryStateApi = "api/power/battery"

static

API for getting battery state.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.BugcheckFileApi = "api/debug/dump/kernel/dump"

static

API to download a bugcheck minidump file.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.BugcheckSettingsApi = "api/debug/dump/kernel/crashcontrol"

static

API to control bugcheck minidump settings.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.ControllerDriverApi = "api/iot/device/controllersdriver"

static

IOT device Controller Driver API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.CrashDumpFileApi = "api/debug/dump/usermode/crashdump"

static

API to download or delete a crash dump file (for a sideloaded application).

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.CrashDumpSettingsApi = "api/debug/dump/usermode/crashcontrol"

static

API to control the crash dump settings for a sideloaded application.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.CreateRealtimeEtwSessionApi = "api/etw/session/realtime"

static

API to create a realtime ETW session.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.DateTimeInfoApi = "api/iot/device/datetime"

static

IOT device datetime API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.DeviceFamilyApi = "api/os/devicefamily"

static

API for getting the device family.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.DeviceNameApi = "api/iot/device/name"

static

IOT device name API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.DevicePortalCertificateIssuer = "Microsoft Windows Web Management"

static

Issuer for the device certificate.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.DisplayOrientationApi = "api/iot/device/displayorientation"

static

IOT display orientation API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.DisplayResolutionApi = "api/iot/device/displayresolution"

static

IOT display resolution API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.FiddlerSetupApi = "ext/fiddler"

static

Endpoint for enabling and disabling a Fiddler proxy.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetCustomEtwProvidersApi = "api/etw/customproviders"

static

API to getthe list of registered custom ETW providers.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetEtwProvidersApi = "api/etw/providers"

static

API to getthe list of registered ETW providers.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetFileApi = "api/filesystem/apps/file"

static

API to upload, download or delete a file in a folder.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetFilesApi = "api/filesystem/apps/files"

static

API to retrieve the list of files in a folder.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.GetXboxScreenshotApi = "ext/screenshot"

static

Endpoint for getting a screenshot.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HeadlessAppsListApi = "api/iot/appx/listHeadlessApps"

static

IoT device headless application list API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HeadlessStartupAppApi = "api/iot/appx/startupHeadlessApp"

static

IoT device headless startup application API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicIpdApi = "api/holographic/os/settings/ipd"

static

API for getting or setting Interpupilary distance

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicPerceptionClient = "api/holographic/perception/client"

static

API for running a Perception client.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicServicesApi = "api/holographic/os/services"

static

API for getting a list of running HoloLens specific services.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationModeApi = "api/holographic/simulation/control/mode"

static

API for getting or setting the Holographic Perception Simulation control mode.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationPlaybackDataTypesApi = "api/holographic/simulation/playback/session/types"

static

API for retrieving the types of data in a Holographic Perception Simulation recording.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationPlaybackFileApi = "api/holographic/simulation/playback/file"

static

API for uploading or deleting a Holographic Perception Simulation recording file.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationPlaybackFilesApi = "api/holographic/simulation/playback/files"

static

API for retrieving a list of a Holographic Perception Simulation recording files.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationPlaybackPauseApi = "api/holographic/simulation/playback/session/pause"

static

API for pausing a Holographic Perception Simulation recording.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationPlaybackPlayApi = "api/holographic/simulation/playback/session/play"

static

API for starting playback of a Holographic Perception Simulation recording.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationPlaybackRecordingsApi = "api/holographic/simulation/playback/session/files"

static

API for loading or unloading a Holographic Perception Simulation recording.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationPlaybackSessionFileApi = "api/holographic/simulation/playback/session/file"

static

API for loading or unloading a Holographic Perception Simulation recording.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationPlaybackStateApi = "api/holographic/simulation/playback/session"

static

API for retrieving the playback state of a Holographic Perception Simulation recording.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationPlaybackStopApi = "api/holographic/simulation/playback/session/stop"

static

API for starting playback of a Holographic Perception Simulation recording.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationRecordingStatusApi = "api/holographic/simulation/recording/status"

static

API for getting a Holographic Perception Simulation recording status.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicSimulationStreamApi = "api/holographic/simulation/control/Stream"

static

API for controlling the Holographic Perception Simulation control stream.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.HolographicWebManagementHttpSettingsApi = "api/holographic/os/webmanagement/settings/https"

static

API for getting or setting HTTPS setting

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.IcSharingApi = "api/iot/ics/sharing"

static

IOT ICS Sharing API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.IcsInterfacesApi = "api/iot/ics/interfaces"

static

IOT ICS Interface API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.InstalledDevicesApi = "api/devicemanager/devices"

static

API to retrieve list of installed devices.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.InstalledPackagesApi = "api/app/packagemanager/packages"

static

API to retrieve list of installed packages.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.InstallStateApi = "api/app/packagemanager/state"

static

Install state API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.InstallTimeApi = "api/iot/windowsupdate/installtime"

static

Install time API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.IoTOsInfoApi = "api/iot/device/information"

static

IOT device information API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.IpConfigApi = "api/networking/ipconfig"

static

API for getting IP config data.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.KnownFoldersApi = "api/filesystem/apps/knownfolders"

static

API to retrieve the list of accessible top-level folders.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.LiveKernelDumpApi = "api/debug/dump/livekernel"

static

API to retrieve a live kernel dump.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.LiveProcessDumpApi = "api/debug/dump/usermode/live"

static

API to retrieve a live dump from a running user mode process.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MachineNameApi = "api/os/machinename"

static

API for getting the machine name.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MrcFileApi = "api/holographic/mrc/file"

static

API for getting or deleting a Mixed Reality Capture file.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MrcFileListApi = "api/holographic/mrc/files"

static

API for getting the list of Holographic Mixed Reality Capture files.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MrcLiveStreamApi = "api/holographic/stream/live.mp4"

static

API for getting a live Holographic Mixed Reality Capture stream.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MrcLiveStreamHighwResApi = "api/holographic/stream/live_high.mp4"

static

API for getting a high resolution live Holographic Mixed Reality Capture stream.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MrcLiveStreamLowResApi = "api/holographic/stream/live_low.mp4"

static

API for getting a low resolution live Holographic Mixed Reality Capture stream.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MrcLiveStreamMediumResApi = "api/holographic/stream/live_med.mp4"

static

API for getting a medium resolution live Holographic Mixed Reality Capture stream.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MrcPhotoApi = "api/holographic/mrc/photo"

static

API for taking a Mixed Reality Capture photo.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MrcSettingsApi = "api/holographic/mrc/settings"

static

API for getting or setting the default Mixed Reality Capture settings.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MrcStartRecordingApi = "api/holographic/mrc/video/control/start"

static

API for starting a Holographic Mixed Reality Capture recording.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MrcStatusApi = "api/holographic/mrc/status"

static

API for getting the Holographic Mixed Reality Capture status.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MrcStopRecordingApi = "api/holographic/mrc/video/control/stop"

static

API for stopping a Holographic Mixed Reality Capture recording.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.MrcThumbnailApi = "api/holographic/mrc/thumbnail"

static

API for getting a mixed reality capture thumbnail

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.NewRemoteDebuggingPinApi = "api/iot/device/remotedebuggingpin"

static

IOT remote debugging pin API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.OsInfoApi = "api/os/info"

static

API for getting the OS information.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.PackageManagerApi = "api/app/packagemanager/package"

static

API for package management.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.PairBluetoothDevicesApi = "api/iot/bt/pair"

static

API to pair a bluetooth device.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.PairedBluetoothDevicesApi = "api/iot/bt/getpaired"

static

Paired bluetooth devices list API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.PowerSchemeSubValueApi = "api/power/cfg"

static

API for getting or setting a power scheme's sub-value.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.PowerStateApi = "api/power/state"

static

API for controlling power state.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.RebootApi = "api/control/restart"

static

API for rebooting the device.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.RegisterPackageApi = "api/app/packagemanager/register"

static

REST endpoint for registering a package from a loose folder

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.RemoteSettingsDisableApi = "api/iot/remote/disable"

static

Disable Remote Settings API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.RemoteSettingsEnableApi = "api/iot/remote/enable"

static

Enable Remote Settings API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.RemoteSettingsStatusApi = "api/iot/remote/status"

static

Remote status API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.RenameFileApi = "api/filesystem/apps/rename"

static

API to rename a file in a folder.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.ResetPasswordApi = "api/iot/device/password"

static

IOT Device password API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.RootCertificateEndpoint = "config/rootcertificate"

static

Endpoint used to access the certificate.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.RunCommandApi = "api/iot/processmanagement/runcommand"

static

IOT Run Command API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.RunCommandWithoutOutputApi = "api/iot/processmanagement/runcommandwithoutput"

static

IOT Run Command Without Output API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.RunningProcessApi = "api/resourcemanager/processes"

static

API for getting all running processes

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetCaptureVolumeApi = "api/iot/audio/setcapturevolume"

static

API to set capture volume on audio devices connected to IoT Core devices.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetRenderVolumeApi = "api/iot/audio/setrendervolume"

static

API to set render volume on audio devices connected to IoT Core devices.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.SetTimeZoneApi = "api/iot/device/settimezone"

static

IOT set timezone API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.ShutdownApi = "api/control/shutdown"

static

API for shutting down the device.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.SleepStudyReportApi = "api/power/sleepstudy/report"

static

API for getting a sleep study report.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.SleepStudyReportsApi = "api/power/sleepstudy/reports"

static

API for getting the list of sleep study reports.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.SleepStudyTransformApi = "api/power/sleepstudy/transform"

static

API for getting a sleep study report.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.SoftAPSettingsApi = "api/iot/iotonboarding/softapsettings"

static

IOT SoftAP Settings API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.StartHolographicSimulationRecordingApi = "api/holographic/simulation/recording/start"

static

API for starting a Holographic Perception Simulation recording.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.StatusApi = "api/iot/windowsupdate/status"

static

Update status API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.StopHolographicSimulationRecordingApi = "api/holographic/simulation/recording/stop"

static

API for stopping a Holographic Perception Simulation recording.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.SystemPerfApi = "api/resourcemanager/systemperf"

static

API for getting system performance

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.TagApi = "api/dns-sd/tag"

static

API to add or delete a tag to the DNS-SD advertisement.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.TagsApi = "api/dns-sd/tags"

static

API to retrieve or delete the currently applied tags for the device.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.TaskManagerApi = "api/taskmanager/app"

static

API for starting or stopping a modern application.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.ThermalStageApi = "api/holographic/thermal/stage"

static

API for getting the thermal stage

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.TimezoneInfoApi = "api/iot/device/timezones"

static

IOT device timezone API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.TpmAcpiTablesApi = "api/iot/tpm/acpitables"

static

Advanced Configuration and Power Interface(ACPI) information API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.TpmAzureTokenApi = "api/iot/tpm/azuretoken"

static

TPM Azure Token API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.TpmSettingsApi = "api/iot/tpm/settings"

static

TPM settings API.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.UnpairBluetoothDevicesApi = "api/iot/bt/unpair"

static

API to unpair a bluetooth device.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.UploadPackageFolderApi = "api/app/packagemanager/upload"

static

REST endpoint for uploading a folder to the DevelopmentFiles loose folder.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.WifiInterfacesApi = "api/wifi/interfaces"

static

API for getting the WiFi interfaces.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.WifiNetworkApi = "api/wifi/network"

static

API for the controlling the WiFi network.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.WifiNetworksApi = "api/wifi/networks"

static

API for getting available WiFi networks.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.WindowsErrorReportingFileApi = "api/wer/report/file"

static

API for downloading a Windows error reporting file.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.WindowsErrorReportingFilesApi = "api/wer/report/files"

static

API for getting the list of files in a Windows error report.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.WindowsErrorReportsApi = "api/wer/reports"

static

API for getting the list of Windows error reports.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.WindowsPerformanceBootTraceApi = "api/wpr/boottrace"

static

API for starting and stopping a Windows performance recorder boot performance trace session.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.WindowsPerformanceCustomTraceApi = "api/wpr/customtrace"

static

API for starting a Windows performance recorder trace using a custom profile.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.WindowsPerformanceTraceApi = "api/wpr/trace"

static

API for starting and stopping a Windows performance recorder trace session.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.WindowsPerformanceTraceStatusApi = "api/wpr/status"

static

API for getting the status of a Windows performance recorder trace session.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.XboxLiveSandboxApi = "ext/xboxlive/sandbox"

static

Endpoint for getting or changing the Xbox Live sandbox for the device.

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.XboxLiveUserApi = "ext/user"

static

Endpoint for User management REST calls

readonly string Microsoft.Tools.WindowsDevicePortal.DevicePortal.XboxSettingsApi = "ext/settings"

static

Endpoint for Xbox settings management REST calls.

Property Documentation

string Microsoft.Tools.WindowsDevicePortal.DevicePortal.Address

get

Gets the device address.

string Microsoft.Tools.WindowsDevicePortal.DevicePortal.ConnectionFailedDescription

get

Gets a description of why the connection failed.

HttpStatusCode Microsoft.Tools.WindowsDevicePortal.DevicePortal.ConnectionHttpStatusCode

get

Gets the status code for establishing our connection.

string Microsoft.Tools.WindowsDevicePortal.DevicePortal.DeviceFamily

get

Gets the device operating system family.

string Microsoft.Tools.WindowsDevicePortal.DevicePortal.OperatingSystemVersion

get

Gets the operating system version.

DevicePortalPlatforms Microsoft.Tools.WindowsDevicePortal.DevicePortal.Platform

get

Gets the device platform.

string Microsoft.Tools.WindowsDevicePortal.DevicePortal.PlatformName

get

Gets the device platform name.

WebSocketMessageReceivedEventHandler<DeviceProcesses> Microsoft.Tools.WindowsDevicePortal.DevicePortal.ProcessesMessageReceived

getset

Gets or sets the processes message received handler.

Event Documentation

ApplicationInstallStatusEventHandler Microsoft.Tools.WindowsDevicePortal.DevicePortal.AppInstallStatus

App Install Status handler.

WebSocketMessageReceivedEventHandler<AvailableBluetoothDevicesInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.BluetoothDeviceListReceived

Gets or sets the list of bluetooth devices received handler.

DeviceConnectionStatusEventHandler Microsoft.Tools.WindowsDevicePortal.DevicePortal.ConnectionStatus

Handler for reporting connection status.

WebSocketMessageReceivedEventHandler<PairBluetoothDevicesInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.PairBluetoothDeviceListReceived

Gets the results of pairing bluetooth device received handler.

WebSocketMessageReceivedEventHandler<PairedBluetoothDevicesInfo> Microsoft.Tools.WindowsDevicePortal.DevicePortal.PairedBluetoothDeviceListReceived

Gets or sets the list of paired bluetooth devices received handler.

WebSocketMessageReceivedEventHandler<RunningProcesses> Microsoft.Tools.WindowsDevicePortal.DevicePortal.RunningProcessesMessageReceived

The running processes message received handler.

WebSocketMessageReceivedEventHandler<SystemPerformanceInformation> Microsoft.Tools.WindowsDevicePortal.DevicePortal.SystemPerfMessageReceived

The system perf message received handler.

UnvalidatedCertEventHandler Microsoft.Tools.WindowsDevicePortal.DevicePortal.UnvalidatedCert

Gets or sets handler for untrusted certificate handling

The documentation for this class was generated from the following files:

WindowsDevicePortalWrapper/UnitTestProject/WDPMockImplementations/AppDeployment.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper/CertificateHandling.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/AppFileExplorer.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/DeviceManager.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/Dns-Sd.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/DumpCollection.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/Etw.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/Networking.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/OsInformation.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/PerformanceData.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/Power.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/RemoteControl.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/ResourceManager.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/TaskManager.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/WiFiManagement.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/WindowsErrorReporting.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Core/WindowsPerformanceRecorder.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/DevicePortal.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/HoloLens/HolographicOs.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/HoloLens/HolographicPerception.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/HoloLens/HolographicThermal.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/HoloLens/MixedRealityCapture.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/HoloLens/PerceptionSimulationPlayback.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/HoloLens/PerceptionSimulationRecording.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/HttpRest/HttpHeadersHelper.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/HttpRest/RestGet.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/ApplicationManager.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/AudioDevices.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/BluetoothConnectivity.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/DeviceInfo.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/IcsManager.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/IoTOnboarding.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/Limpet.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/ProcessManagement.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/RemoteSettings.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/IoT/WindowsUpdate.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Xbox/FiddlerSetup.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Xbox/SmbShare.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Xbox/UserManagement.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Xbox/XboxAppDeployment.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Xbox/XboxLiveSandbox.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Xbox/XboxMediaCapture.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/Xbox/XboxSettings.cs
WindowsDevicePortalWrapper/UnitTestProject/WDPMockImplementations/RestDelete.cs
WindowsDevicePortalWrapper/UnitTestProject/WDPMockImplementations/RestPost.cs
WindowsDevicePortalWrapper/UnitTestProject/WDPMockImplementations/RestPut.cs
WindowsDevicePortalWrapper/WindowsDevicePortalWrapper.Shared/HttpRest/RequestHelpers.cs

Classes

Public Types

Public Member Functions

Static Public Attributes

Properties

Events

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation

Event Documentation