Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection Class Reference

Default implementation of the IDevicePortalConnection interface. This implementation is designed to be compatibile with all device families. More...

Inheritance diagram for Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection:

Public Member Functions
	DefaultDevicePortalConnection (string address, string userName, string password)
	Initializes a new instance of the DefaultDevicePortalConnection class. More...
X509Certificate2	GetDeviceCertificate ()
	Gets the provided device certificate. More...
void	SetDeviceCertificate (X509Certificate2 certificate)
	Stores a manually provided device certificate. More...
void	UpdateConnection (bool requiresHttps)
	Updates the device's connection Uri. More...
void	UpdateConnection (IpConfiguration ipConfig, bool requiresHttps=false)
	Updates the device's connection Uri. More...
	DefaultDevicePortalConnection (string address, string userName, string password)
	Initializes a new instance of the DefaultDevicePortalConnection class. More...
void	UpdateConnection (bool requiresHttps)
	Updates the device's connection Uri. More...
void	UpdateConnection (IpConfiguration ipConfig, bool requiresHttps=false)
	Updates the device's connection Uri. More...

Properties
Uri	Connection [get]
	Gets the URI used to connect to the device. More...
Uri	WebSocketConnection [get]
	Gets Web Socket Connection property More...
NetworkCredential	Credentials [get]
	Gets the credentials used to connect to the device. More...
string	Family [get, set]
	Gets or sets the device's operating system family. More...
OperatingSystemInformation	OsInfo [get, set]
	Gets or sets the operating system information. More...
Properties inherited from Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection
Uri	Connection [get]
	Gets the base uri (ex: http://localhost) used to communicate with the device. More...
Uri	WebSocketConnection [get]
	Gets the base uri (ex: ws://localhost) used to communicate with web sockets on the device. More...
NetworkCredential	Credentials [get]
	Gets the credentials used when communicating with the device. More...
string	Family [get, set]
	Gets or sets the family of the device (ex: Windows.Holographic). More...
OperatingSystemInformation	OsInfo [get, set]
	Gets or sets information describing the operating system installed on the device. More...

Detailed Description

Default implementation of the IDevicePortalConnection interface. This implementation is designed to be compatibile with all device families.

Constructor & Destructor Documentation

Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.DefaultDevicePortalConnection ( string  address, string  userName, string  password  )

inline

Initializes a new instance of the DefaultDevicePortalConnection class.

Parameters

address	The fully qualified (ex: "https:/1.2.3.4:4321") address of the device.
userName	The user name used in the connection credentials.
password	The password used in the connection credentials.

Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.DefaultDevicePortalConnection ( string  address, string  userName, string  password  )

inline

Initializes a new instance of the DefaultDevicePortalConnection class.

Parameters

address	The fully qualified (ex: "https:/1.2.3.4:4321") address of the device.
userName	The user name used in the connection credentials.
password	The password used in the connection credentials.

Member Function Documentation

X509Certificate2 Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.GetDeviceCertificate ( )

inline

Gets the provided device certificate.

Returns

Stored device certificate.

void Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.SetDeviceCertificate ( X509Certificate2  certificate )

inline

Stores a manually provided device certificate.

Parameters

certificate

The device's root certificate.

void Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.UpdateConnection ( bool  requiresHttps )

inline

Updates the device's connection Uri.

Parameters

requiresHttps

Indicates whether or not to always require a secure connection.

Implements Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection.

void Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.UpdateConnection ( IpConfiguration  ipConfig, bool  requiresHttps = false  )

inline

Updates the device's connection Uri.

Parameters

ipConfig	The device's IP configuration data.
requiresHttps	Indicates whether or not to always require a secure connection.

Implements Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection.

void Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.UpdateConnection ( bool  requiresHttps )

inline

Updates the device's connection Uri.

Parameters

requiresHttps

Indicates whether or not to always require a secure connection.

Implements Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection.

void Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.UpdateConnection ( IpConfiguration  ipConfig, bool  requiresHttps = false  )

inline

Updates the device's connection Uri.

Parameters

ipConfig	The device's IP configuration data.
requiresHttps	Indicates whether or not to always require a secure connection.

Implements Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection.

Property Documentation

Uri Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.Connection

get

Gets the URI used to connect to the device.

NetworkCredential Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.Credentials

get

Gets the credentials used to connect to the device.

string Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.Family

getset

Gets or sets the device's operating system family.

OperatingSystemInformation Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.OsInfo

getset

Gets or sets the operating system information.

Uri Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection.WebSocketConnection

get

Gets Web Socket Connection property

---

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

• WindowsDevicePortalWrapper/WindowsDevicePortalWrapper/DefaultDevicePortalConnection.cs