AR Design
UBC EML collab with UBC SALA - visualizing IoT data in AR
Static Public Member Functions | List of all members
HoloToolkit.Unity.BuildDeployPortal Class Reference

Function used to communicate with the device through the REST API More...

Static Public Member Functions

static void OpenWebPortal (ConnectInfo targetDevice)
 Opens the Device Portal for the target device. More...
 
static MachineName GetMachineName (ConnectInfo targetDevice)
 Gets the MachineName of the target device. More...
 
static bool IsAppInstalled (string packageFamilyName, string targetIp)
 
static bool IsAppInstalled (string packageFamilyName, ConnectInfo targetDevice)
 Determines if the target application is currently running on the target device. More...
 
static bool IsAppRunning (string appName, string targetDevice)
 
static bool IsAppRunning (string appName, ConnectInfo targetDevice)
 Determines if the target application is running on the target device. More...
 
static bool InstallApp (string appFullPath, ConnectInfo targetDevice, bool waitForDone=true)
 Installs the target application on the target device. More...
 
static bool UninstallApp (string packageFamilyName, string targetIp)
 
static bool UninstallApp (string packageFamilyName, ConnectInfo targetDevice, bool showDialog=true)
 Uninstalls the target application on the target device. More...
 
static bool LaunchApp (string packageFamilyName, ConnectInfo targetDevice, bool showDialog=true)
 Launches the target application on the target device. More...
 
static bool KillApp (string packageFamilyName, string targetIp)
 
static bool KillApp (string packageFamilyName, ConnectInfo targetDevice, bool showDialog=true)
 Kills the target application on the target device. More...
 
static bool DeviceLogFile_View (string packageFamilyName, string targetIp)
 
static bool DeviceLogFile_View (string packageFamilyName, ConnectInfo targetDevice)
 Downloads and launches the Log file for the target application on the target device. More...
 
static NetworkInfo GetNetworkInfo (ConnectInfo targetDevice)
 Returns the NetworkInfo for the target device. More...
 

Detailed Description

Function used to communicate with the device through the REST API

Definition at line 20 of file BuildDeployPortal.cs.

Member Function Documentation

§ DeviceLogFile_View() [1/2]

static bool HoloToolkit.Unity.BuildDeployPortal.DeviceLogFile_View ( string  packageFamilyName,
string  targetIp 
)
static

Definition at line 646 of file BuildDeployPortal.cs.

§ DeviceLogFile_View() [2/2]

static bool HoloToolkit.Unity.BuildDeployPortal.DeviceLogFile_View ( string  packageFamilyName,
ConnectInfo  targetDevice 
)
static

Downloads and launches the Log file for the target application on the target device.

Parameters
packageFamilyName
targetDevice
Returns
True, if download success.

Definition at line 657 of file BuildDeployPortal.cs.

§ GetMachineName()

static MachineName HoloToolkit.Unity.BuildDeployPortal.GetMachineName ( ConnectInfo  targetDevice)
static

Gets the MachineName of the target device.

Parameters
targetDevice
Returns
MachineName

Definition at line 319 of file BuildDeployPortal.cs.

§ GetNetworkInfo()

static NetworkInfo HoloToolkit.Unity.BuildDeployPortal.GetNetworkInfo ( ConnectInfo  targetDevice)
static

Returns the NetworkInfo for the target device.

Parameters
targetDevice
Returns

Definition at line 698 of file BuildDeployPortal.cs.

§ InstallApp()

static bool HoloToolkit.Unity.BuildDeployPortal.InstallApp ( string  appFullPath,
ConnectInfo  targetDevice,
bool  waitForDone = true 
)
static

Installs the target application on the target device.

Parameters
appFullPath
targetDevice
waitForDoneShould the thread wait until installation is complete?
Returns
True, if Installation was a success.

Definition at line 416 of file BuildDeployPortal.cs.

§ IsAppInstalled() [1/2]

static bool HoloToolkit.Unity.BuildDeployPortal.IsAppInstalled ( string  packageFamilyName,
string  targetIp 
)
static

Definition at line 334 of file BuildDeployPortal.cs.

§ IsAppInstalled() [2/2]

static bool HoloToolkit.Unity.BuildDeployPortal.IsAppInstalled ( string  packageFamilyName,
ConnectInfo  targetDevice 
)
static

Determines if the target application is currently running on the target device.

Parameters
packageFamilyName
targetDevice
Returns
True, if application is currently installed on device.

Definition at line 345 of file BuildDeployPortal.cs.

§ IsAppRunning() [1/2]

static bool HoloToolkit.Unity.BuildDeployPortal.IsAppRunning ( string  appName,
string  targetDevice 
)
static

Definition at line 351 of file BuildDeployPortal.cs.

§ IsAppRunning() [2/2]

static bool HoloToolkit.Unity.BuildDeployPortal.IsAppRunning ( string  appName,
ConnectInfo  targetDevice 
)
static

Determines if the target application is running on the target device.

Parameters
appName
targetDevice
Returns
True, if the application is running.

Definition at line 362 of file BuildDeployPortal.cs.

§ KillApp() [1/2]

static bool HoloToolkit.Unity.BuildDeployPortal.KillApp ( string  packageFamilyName,
string  targetIp 
)
static

Definition at line 609 of file BuildDeployPortal.cs.

§ KillApp() [2/2]

static bool HoloToolkit.Unity.BuildDeployPortal.KillApp ( string  packageFamilyName,
ConnectInfo  targetDevice,
bool  showDialog = true 
)
static

Kills the target application on the target device.

Parameters
packageFamilyName
targetDevice
showDialog
Returns
true, if application was successfully stopped.

Definition at line 621 of file BuildDeployPortal.cs.

§ LaunchApp()

static bool HoloToolkit.Unity.BuildDeployPortal.LaunchApp ( string  packageFamilyName,
ConnectInfo  targetDevice,
bool  showDialog = true 
)
static

Launches the target application on the target device.

Parameters
packageFamilyName
targetDevice
showDialog
Returns
True, if application was successfully launched and is currently running on the target device.

Definition at line 588 of file BuildDeployPortal.cs.

§ OpenWebPortal()

static void HoloToolkit.Unity.BuildDeployPortal.OpenWebPortal ( ConnectInfo  targetDevice)
static

Opens the Device Portal for the target device.

Parameters
targetDevice

Definition at line 308 of file BuildDeployPortal.cs.

§ UninstallApp() [1/2]

static bool HoloToolkit.Unity.BuildDeployPortal.UninstallApp ( string  packageFamilyName,
string  targetIp 
)
static

Definition at line 541 of file BuildDeployPortal.cs.

§ UninstallApp() [2/2]

static bool HoloToolkit.Unity.BuildDeployPortal.UninstallApp ( string  packageFamilyName,
ConnectInfo  targetDevice,
bool  showDialog = true 
)
static

Uninstalls the target application on the target device.

Parameters
packageFamilyName
targetDevice
showDialog
Returns
True, if uninstall was a success.

Definition at line 553 of file BuildDeployPortal.cs.

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