WindowsDevicePortalWrapper  0.9.0.0
A client library that wraps the Windows Device Portal REST APIs.
Public Member Functions | Properties | List of all members
Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection Interface Reference

Interface for creating a connection with the device portal. More...

Inheritance diagram for Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection:
Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection Microsoft.Tools.WindowsDevicePortal.Tests.MockDevicePortalConnection

Public Member Functions

void UpdateConnection (bool requiresHttps)
 Updates the http security requirements for device communication. More...
 
void UpdateConnection (IpConfiguration ipConfig, bool requiresHttps)
 Updates the connection details (IP address) and http security requirements used when communicating with the device. More...
 

Properties

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

Interface for creating a connection with the device portal.

Member Function Documentation

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

Updates the http security requirements for device communication.

Parameters
requiresHttpsTrue if an https connection is required, false otherwise.

Implemented in Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection, Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection, and Microsoft.Tools.WindowsDevicePortal.Tests.MockDevicePortalConnection.

void Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection.UpdateConnection ( IpConfiguration  ipConfig,
bool  requiresHttps 
)

Updates the connection details (IP address) and http security requirements used when communicating with the device.

Parameters
ipConfigObject that describes the current network configuration.
requiresHttpsTrue if an https connection is required, false otherwise.

Implemented in Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection, Microsoft.Tools.WindowsDevicePortal.DefaultDevicePortalConnection, and Microsoft.Tools.WindowsDevicePortal.Tests.MockDevicePortalConnection.

Property Documentation

Uri Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection.Connection
get

Gets the base uri (ex: http://localhost) used to communicate with the device.

NetworkCredential Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection.Credentials
get

Gets the credentials used when communicating with the device.

string Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection.Family
getset

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

OperatingSystemInformation Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection.OsInfo
getset

Gets or sets information describing the operating system installed on the device.

Uri Microsoft.Tools.WindowsDevicePortal.IDevicePortalConnection.WebSocketConnection
get

Gets the base uri (ex: ws://localhost) used to communicate with web sockets on the device.


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