Microsoft.Tools.WindowsDevicePortal Namespace Reference

Namespaces

Classes
class	ApplicationInstallStatusEventArgs
	Application install status event args More...
class	DefaultDevicePortalConnection
	Default implementation of the IDevicePortalConnection interface. This implementation is designed to be compatibile with all device families. More...
class	DeviceConnectionStatusEventArgs
	Contains the details about the connection status More...
class	DevicePortal
	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...
class	DevicePortalException
	Base exception class for a Device Portal exception More...
interface	IDevicePortalConnection
	Interface for creating a connection with the device portal. More...
class	Utilities
	Utility class for common functions
class	WebSocket
	MOCK implementation of HTTP web socket wrapper
class	WebSocketMessageReceivedEventArgs
	Web socket message received event args More...

Enumerations
enum	ApplicationInstallStatus { ApplicationInstallStatus.None, ApplicationInstallStatus.InProgress, ApplicationInstallStatus.Completed, ApplicationInstallStatus.Failed }
	Application install status More...
enum	ApplicationInstallPhase { ApplicationInstallPhase.Idle, ApplicationInstallPhase.UninstallingPreviousVersion, ApplicationInstallPhase.CopyingFile, ApplicationInstallPhase.Installing }
	Install phase More...
enum	DeviceConnectionStatus { DeviceConnectionStatus.None, DeviceConnectionStatus.Connecting, DeviceConnectionStatus.Connected, DeviceConnectionStatus.Failed }
	Connection status enumeration More...
enum	DeviceConnectionPhase {   DeviceConnectionPhase.Idle, DeviceConnectionPhase.AcquiringCertificate, DeviceConnectionPhase.DeterminingConnectionRequirements, DeviceConnectionPhase.RequestingOperatingSystemInformation,   DeviceConnectionPhase.ConnectingToTargetNetwork, DeviceConnectionPhase.UpdatingDeviceAddress }
	Connection phase enumeration More...
enum	ThermalStages { ThermalStages.Normal, ThermalStages.Warm, ThermalStages.Critical, ThermalStages.Unknown = 9999 }
	Thermal State enumeration More...

Functions
delegate bool	UnvalidatedCertEventHandler (DevicePortal sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors sslPolicyErrors)
	Handler for when an unvalidated cert is received. More...
delegate void	ApplicationInstallStatusEventHandler (DevicePortal sender, ApplicationInstallStatusEventArgs args)
	Application install status event handler More...
delegate void	DeviceConnectionStatusEventHandler (DevicePortal sender, DeviceConnectionStatusEventArgs args)
	Handler for reporting on device connection status More...
delegate void	WebSocketMessageReceivedEventHandler< T > (DevicePortal sender, WebSocketMessageReceivedEventArgs< T > args)
	Web socket message received event handler More...

Enumeration Type Documentation

enum Microsoft.Tools.WindowsDevicePortal.ApplicationInstallPhase

strong

Install phase

Enumerator
Idle	Idle phase
UninstallingPreviousVersion	Uninstalling the previous version
CopyingFile	Copying the package file
Installing	Installing the package

enum Microsoft.Tools.WindowsDevicePortal.ApplicationInstallStatus

strong

Application install status

Enumerator
None	No install status
InProgress	Installation is in progress
Completed	Installation is completed
Failed	Installation failed

enum Microsoft.Tools.WindowsDevicePortal.DeviceConnectionPhase

strong

Connection phase enumeration

Enumerator
Idle	Idle phase
AcquiringCertificate	Acquiring the device certificate
DeterminingConnectionRequirements	Determining the device connection requirements
RequestingOperatingSystemInformation	Getting some basic information about the device OS
ConnectingToTargetNetwork	Connecting the device to a provided network
UpdatingDeviceAddress	Updating the device address to reflect the new network

enum Microsoft.Tools.WindowsDevicePortal.DeviceConnectionStatus

strong

Connection status enumeration

Enumerator
None	No status
Connecting	Currently Connecting
Connected	Connection complete
Failed	Connection failed

enum Microsoft.Tools.WindowsDevicePortal.ThermalStages

strong

Thermal State enumeration

Enumerator
Normal	No thermal stage
Warm	Warm stage
Critical	Critical stage
Unknown	Unknown stage

Function Documentation

delegate void Microsoft.Tools.WindowsDevicePortal.ApplicationInstallStatusEventHandler	(	DevicePortal	sender,
		ApplicationInstallStatusEventArgs	args
	)

Application install status event handler

Parameters

sender	sender object
args	install args

delegate void Microsoft.Tools.WindowsDevicePortal.DeviceConnectionStatusEventHandler	(	DevicePortal	sender,
		DeviceConnectionStatusEventArgs	args
	)

Handler for reporting on device connection status

Parameters

sender	sender object
args	connection status details

delegate bool Microsoft.Tools.WindowsDevicePortal.UnvalidatedCertEventHandler	(	DevicePortal	sender,
		X509Certificate	certificate,
		X509Chain	chain,
		SslPolicyErrors	sslPolicyErrors
	)

Handler for when an unvalidated cert is received.

Parameters

sender	The sender of the event.
certificate	The server's certificate.
chain	The cert chain.
sslPolicyErrors	Policy Errors.

Returns

whether the cert should still pass validation.

delegate void Microsoft.Tools.WindowsDevicePortal.WebSocketMessageReceivedEventHandler< T >	(	DevicePortal	sender,
		WebSocketMessageReceivedEventArgs< T >	args
	)

Web socket message received event handler

Parameters

sender	Sender DevicePortal object
args	Web socket message received args

Template Parameters

T	Return type for the websocket messages.