Class Xbox

The xbox implementation for deployment of packages.

Inheritance

System.Object

CapabilityBase

DeviceBase

Xbox

Implements

System.IServiceProvider

IDevice

ICapability

IDeviceControllable

IDeviceInput

IFileSystemIOAppPackage

IFileSystemIOSystem

IFileSystemIOTitle

System.IDisposable

IDevicePackages

IDeviceStatus

Inherited Members

DeviceBase.DeviceTypeName

DeviceBase.DeviceTypeDisplayName

DeviceBase.Id

DeviceBase.Name

DeviceBase.Alias

DeviceBase.IPAddress

DeviceBase.DisplayName

DeviceBase.Configuration

DeviceBase.ConfigurationType

DeviceBase.AttachedObjectModel

DeviceBase.DeviceImplementation

DeviceBase.ConnectionStatus

DeviceBase.PhoenixId

DeviceBase.Logger

DeviceBase.Events

CapabilityBase.GetCapabilityInterface<T>()

CapabilityBase.HasCapabilityInterface(Type)

CapabilityBase.HasCapabilityInterface<T>()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Phoenix.Devices

Assembly: Phoenix.Devices.Xbox.dll

Syntax

public sealed class Xbox : DeviceBase, IServiceProvider, IDevice, ICapability, IDeviceControllable, IDeviceInput, IFileSystemIOAppPackage, IFileSystemIOSystem, IFileSystemIOTitle, IDisposable, IDeviceStatus

Constructors

Xbox(IPAddress, String, String, IPhoenixLogger, XboxConnectionInfo, String, IEventAggregator, Guid)

Initializes a new instance of the Xbox class.

Declaration

public Xbox(IPAddress deviceIP, string name, string alias, IPhoenixLogger logger, XboxConnectionInfo connectionInfo, string consoleId, IEventAggregator events, Guid phoenixId)

Parameters

Type	Name	Description
System.Net.IPAddress	deviceIP	The IP address of the device.
System.String	name	The name of the device.
System.String	alias	The alias of the device if known.
IPhoenixLogger	logger	The current logger.
XboxConnectionInfo	connectionInfo	Contains the XDK access key and device portal auth settings.
System.String	consoleId	The expected console id that will be matched to the id the console provides.
IEventAggregator	events	The event aggregator service.
System.Guid	phoenixId	The id for the device.

Fields

SystemPackageRegex

Gets the regex used to determine if a package is a system package.

Declaration

public static readonly Regex SystemPackageRegex

Field Value

Type	Description
System.Text.RegularExpressions.Regex

Properties

AccessKey

Gets or sets the XDK access key for this device.

Declaration

public string AccessKey { get; set; }

Property Value

Type	Description
System.String

CanRebootDevice

Gets a value indicating whether it's possible to reboot the device in its current state.

Declaration

public bool CanRebootDevice { get; }

Property Value

Type	Description
System.Boolean

ConnectionInfo

Gets the device connection info.

Declaration

public XboxConnectionInfo ConnectionInfo { get; }

Property Value

Type	Description
XboxConnectionInfo

DevicePortalConnectionInfo

Gets or sets the device portal connection info.

Declaration

public DevicePortalConnectionInfo DevicePortalConnectionInfo { get; set; }

Property Value

Type	Description
DevicePortalConnectionInfo

IsDevicePortalConnected

Gets a value indicating whether or not there is a device portal connection.

Declaration

public bool IsDevicePortalConnected { get; }

Property Value

Type	Description
System.Boolean

IsRebooting

Gets a value indicating whether a known reboot is in progress.

Declaration

public bool IsRebooting { get; }

Property Value

Type	Description
System.Boolean

IsXdkConnected

Gets a value indicating whether or not there is a XDK connection.

Declaration

public bool IsXdkConnected { get; }

Property Value

Type	Description
System.Boolean

MaxNumConnectedGamepads

Gets the maximum number of connected gamepads that the device supports at once.

Declaration

public int MaxNumConnectedGamepads { get; }

Property Value

Type	Description
System.Int32

StatusCheckInterval

Gets the duration to wait before refreshing device status.

Declaration

public TimeSpan StatusCheckInterval { get; }

Property Value

Type	Description
System.TimeSpan

SupportedInteractions

Gets the supported interactions for the device. Interactions will throw a DeviceNotSupportedException if an attempt to use an unsupported interaction takes place.

Declaration

public PackageInteractions SupportedInteractions { get; }

Property Value

Type	Description
PackageInteractions

XboxLiveDeviceId

Gets a value representing the XBL device Id.

Declaration

public override string XboxLiveDeviceId { get; }

Property Value

Type	Description
System.String

Overrides

DeviceBase.XboxLiveDeviceId

Methods

AppPackageDirectoryExists(PhoenixPath)

Checks if a directory exists in a System directory.

Declaration

public Task<bool> AppPackageDirectoryExists(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The directory to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	True if the directory exists, false if not.

AppPackageFileExistsAsync(PhoenixPath)

Checks if a file exists in an App Package directory.

Declaration

public Task<bool> AppPackageFileExistsAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The file to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	True if the file exists, false if not.

CheckAllowHeadlessXUserAutomationAsync(String)

Kit config method for checking allow headless xuser automation.

Declaration

[DeviceConfigCheckMethod("Allow Headless XUser Automation", "Xbox")]
public async Task<DeviceConfigResult> CheckAllowHeadlessXUserAutomationAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The value of allow headless xuser automation we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

CheckAvailableStorageAsync(String)

Kit config method for checking the available storage space.

Declaration

[DeviceConfigCheckMethod("Available Storage", "Xbox")]
public async Task<DeviceConfigResult> CheckAvailableStorageAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The amount of storage space required.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

CheckCrashDumpTypeAsync(String)

Kit config method for checking the crash dump type.

Declaration

[DeviceConfigCheckMethod("Crash Dump Type", "Xbox")]
public async Task<DeviceConfigResult> CheckCrashDumpTypeAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The type of crash dump to we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

CheckDebugMemoryModeAsync(String)

Kit config method for checking the debug memory mode.

Declaration

[DeviceConfigCheckMethod("Debug Memory Mode", "Xbox")]
public async Task<DeviceConfigResult> CheckDebugMemoryModeAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The type of debug memory mode we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

CheckDefaultStorageDeviceAsync(String)

Kit config method for checking the default storage device.

Declaration

[DeviceConfigCheckMethod("Default Storage Device", "Xbox")]
public async Task<DeviceConfigResult> CheckDefaultStorageDeviceAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The type of storage device we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

CheckExtraTitleMemoryAsync(String)

Kit config method for checking the extra title memory.

Declaration

[DeviceConfigCheckMethod("Extra Title Memory (MB)", "Xbox")]
public async Task<DeviceConfigResult> CheckExtraTitleMemoryAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The extra title memory we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

CheckGuestAccessToFileSharesAsync(String)

Kit config method for checking the guest access to file shares settings.

Declaration

[DeviceConfigCheckMethod("Guest Access To File Shares", "Xbox")]
public async Task<DeviceConfigResult> CheckGuestAccessToFileSharesAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	A string that contains the expected guest access setting.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config results object.

CheckProfilingModeAsync(String)

Kit config method for checking the profiling mode.

Declaration

[DeviceConfigCheckMethod("Profiling Mode", "Xbox")]
public async Task<DeviceConfigResult> CheckProfilingModeAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The type of profiling mode we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

CheckRecoveryVersionAsync(String)

Kit config method for checking the XDK recovery version.

Declaration

[DeviceConfigCheckMethod("Recovery Version", "Xbox")]
public async Task<DeviceConfigResult> CheckRecoveryVersionAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	A string that contains the expected recovery version number.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config results object.

CheckSandboxIdAsync(String)

Kit config method for checking the Sandbox ID.

Declaration

[DeviceConfigCheckMethod("Sandbox ID", "Xbox")]
public async Task<DeviceConfigResult> CheckSandboxIdAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The version of the XDK we want to flash to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

CheckToolingMemoryOverflowAsync(String)

Kit config method for checking tooling memory overflow.

Declaration

[DeviceConfigCheckMethod("Tooling Memory Overflow", "Xbox")]
public async Task<DeviceConfigResult> CheckToolingMemoryOverflowAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The value of tooling overflow memory we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

CheckXdkVersionAsync(String)

Kit config method for checking the XDK version.

Declaration

[DeviceConfigCheckMethod("XDK Version", "Xbox")]
public async Task<DeviceConfigResult> CheckXdkVersionAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The version of the XDK we want to flash to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

Cleanup()

Performs device cleanup

Declaration

public override void Cleanup()

Overrides

DeviceBase.Cleanup()

Constrain(IPackage)

Declaration

public Task Constrain(IPackage package)

Parameters

Type	Name	Description
IPackage	package

Returns

Type	Description
System.Threading.Tasks.Task

CopyAppPackageDirectoryAsync(PhoenixPath, PhoenixPath)

Copies a directory from source to destination for app package.

Declaration

public Task CopyAppPackageDirectoryAsync(PhoenixPath source, PhoenixPath destination)

Parameters

Type	Name	Description
PhoenixPath	source	The source.
PhoenixPath	destination	The destination.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

CopyAppPackageFileAsync(PhoenixPath, PhoenixPath)

Copies a file from source to destination for app package.

Declaration

public Task CopyAppPackageFileAsync(PhoenixPath source, PhoenixPath destination)

Parameters

Type	Name	Description
PhoenixPath	source	The source.
PhoenixPath	destination	The destination.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

CopySystemDirectoryAsync(PhoenixPath, PhoenixPath)

Copies a directory from source to destination for system.

Declaration

public Task CopySystemDirectoryAsync(PhoenixPath source, PhoenixPath destination)

Parameters

Type	Name	Description
PhoenixPath	source	The source.
PhoenixPath	destination	The destination.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

CopySystemFileAsync(PhoenixPath, PhoenixPath)

Copies a file from source to destination for system.

Declaration

public Task CopySystemFileAsync(PhoenixPath source, PhoenixPath destination)

Parameters

Type	Name	Description
PhoenixPath	source	The source.
PhoenixPath	destination	The destination.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

CopyTitleDirectoryAsync(PhoenixPath, PhoenixPath)

Copies a directory from source to destination.

Declaration

public Task CopyTitleDirectoryAsync(PhoenixPath source, PhoenixPath destination)

Parameters

Type	Name	Description
PhoenixPath	source	Directory source.
PhoenixPath	destination	Copy destination.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

CopyTitleFileAsync(PhoenixPath, PhoenixPath)

Copies a file from source to destination.

Declaration

public Task CopyTitleFileAsync(PhoenixPath source, PhoenixPath destination)

Parameters

Type	Name	Description
PhoenixPath	source	File source.
PhoenixPath	destination	Copy destination.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

CreateAppPackageDirectoryAsync(PhoenixPath)

Creates a directory in the system directory

Declaration

public Task CreateAppPackageDirectoryAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path to create the directory.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

CreateAppPackageFileAsync(PhoenixPath)

Creates a file in the system directory

Declaration

public Task CreateAppPackageFileAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path to create the file.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

CreateGamepad()

Creates a virtual gamepad for the device.

Declaration

public Guid CreateGamepad()

Returns

Type	Description
System.Guid	The id for the gamepad.

CreateSystemDirectoryAsync(PhoenixPath)

Creates a directory in the system directory

Declaration

public Task CreateSystemDirectoryAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path to create the directory.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

CreateSystemFileAsync(PhoenixPath)

Creates a file in the system directory

Declaration

public Task CreateSystemFileAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path to create the file.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

CreateTitleDirectoryAsync(PhoenixPath)

Creates a directory.

Declaration

public Task CreateTitleDirectoryAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The directory to create.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

CreateTitleFileAsync(PhoenixPath)

Creates a file.

Declaration

public Task CreateTitleFileAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The file to create.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

DeleteAppPackageDirectoryAsync(PhoenixPath)

Deletes a directory from an App Package directory

Declaration

public Task DeleteAppPackageDirectoryAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The directory path to delete.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

DeleteAppPackageFileAsync(PhoenixPath)

Deletes a file from an App Package directory

Declaration

public Task DeleteAppPackageFileAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The file path to delete.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

DeleteSystemDirectoryAsync(PhoenixPath)

Deletes a directory from a System directory

Declaration

public Task DeleteSystemDirectoryAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The directory path to delete.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

DeleteSystemFileAsync(PhoenixPath)

Deletes a file from a System directory

Declaration

public Task DeleteSystemFileAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The file path to delete.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

DeleteTitleDirectoryAsync(PhoenixPath)

Deletes a Directory.

Declaration

public Task DeleteTitleDirectoryAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The directory to delete.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

DeleteTitleFileAsync(PhoenixPath)

Deletes a file.

Declaration

public Task DeleteTitleFileAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The file to delete.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the result of the asynchronous operation.

DisconnectAllGamepads()

Disconnects all virtual gamepads from the device.

Declaration

public async Task DisconnectAllGamepads()

Returns

Type	Description
System.Threading.Tasks.Task	awaitable task

DisconnectGamepad(Guid)

Disconnects the specified gamepad from the device.

Declaration

public void DisconnectGamepad(Guid gamepadId)

Parameters

Type	Name	Description
System.Guid	gamepadId	The gamepad to disconnect.

Dispose()

Disposes of the console resources.

Declaration

public void Dispose()

FindRunningTitleDisplayNameAsync()

Declaration

public async Task<string> FindRunningTitleDisplayNameAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

FindSystemFilesAsync(PhoenixPath, String)

Recursively looks through the directories under the specified path for files matching the specified pattern.

Declaration

public Task<IEnumerable<PhoenixFileInfo>> FindSystemFilesAsync(PhoenixPath path, string pattern)

Parameters

Type	Name	Description
PhoenixPath	path	Base path to start the search from.
System.String	pattern	Pattern to look for in file names, e.g. FileNam.txt No regular expressions. Simple file lookup. Can use wildcard ().

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixFileInfo>>	A list of the files that were found. Empty if none.

FindTitleFilesAsync(PhoenixPath, String)

Recursively looks through the directories under the specified path for files matching the specified pattern.

Declaration

public Task<IEnumerable<PhoenixFileInfo>> FindTitleFilesAsync(PhoenixPath path, string pattern)

Parameters

Type	Name	Description
PhoenixPath	path	Base path to start the search from.
System.String	pattern	Pattern to look for in file names, e.g. FileNam.txt No regular expressions. Simple file lookup. Can use wildcard ().

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixFileInfo>>	A list of the files that were found. Empty if none.

FixAllowHeadlessXUserAutomationAsync(String)

Kit config method for fixing allow headless xuser automation.

Declaration

[DeviceConfigFixMethod("Allow Headless XUser Automation", "Xbox")]
public async Task<DeviceConfigResult> FixAllowHeadlessXUserAutomationAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The value of allow headless xuser automation we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

FixCrashDumpTypeAsync(String)

Kit config method for fixing the crash dump type.

Declaration

[DeviceConfigFixMethod("Crash Dump Type", "Xbox")]
public async Task<DeviceConfigResult> FixCrashDumpTypeAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The type of crash dump to we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

FixDebugMemoryModeAsync(String)

Kit config method for fixing the debug memory mode.

Declaration

[DeviceConfigFixMethod("Debug Memory Mode", "Xbox")]
public async Task<DeviceConfigResult> FixDebugMemoryModeAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The type of debug memory mode we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

FixDefaultStorageDeviceAsync(String)

Kit config method for fixing the default storage device.

Declaration

[DeviceConfigFixMethod("Default Storage Device", "Xbox")]
public async Task<DeviceConfigResult> FixDefaultStorageDeviceAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The type of storage device we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

FixExtraTitleMemoryAsync(String)

Kit config method for fixing the extra title memory.

Declaration

[DeviceConfigFixMethod("Extra Title Memory (MB)", "Xbox")]
public async Task<DeviceConfigResult> FixExtraTitleMemoryAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The extra title memory we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

FixGuestAccessToFileSharesAsync(String)

Kit config method for fixing the guest access to file shares settings.

Declaration

[DeviceConfigFixMethod("Guest Access To File Shares", "Xbox")]
public async Task<DeviceConfigResult> FixGuestAccessToFileSharesAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The guest access value to be set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

FixProfilingModeAsync(String)

Kit config method for fixing the profiling mode.

Declaration

[DeviceConfigFixMethod("Profiling Mode", "Xbox")]
public async Task<DeviceConfigResult> FixProfilingModeAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The type of profiling mode we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

FixRecoveryVersionAsync(String, String)

Installs the specific XDK recovery version on the console.

Declaration

[DeviceConfigFixMethod("Recovery Version", "Xbox")]
public async Task<DeviceConfigResult> FixRecoveryVersionAsync(string expected, string recoveryPath)

Parameters

Type	Name	Description
System.String	expected	The version of the recovery to install on this console.
System.String	recoveryPath	The path to the folder containing the recovery files.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The KitConfigResult which specifies if recovery was successfully installed on device.

FixSandboxIdAsync(String)

Kit config method for fixing the Sandbox ID.

Declaration

[DeviceConfigFixMethod("Sandbox ID", "Xbox")]
public async Task<DeviceConfigResult> FixSandboxIdAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The version of the XDK we want to flash to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

FixToolingMemoryOverflowAsync(String)

Kit config method for fixing tooling memory overflow.

Declaration

[DeviceConfigFixMethod("Tooling Memory Overflow", "Xbox")]
public async Task<DeviceConfigResult> FixToolingMemoryOverflowAsync(string expectedResult)

Parameters

Type	Name	Description
System.String	expectedResult	The value of tooling memory overflow we want to set to.

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConfigResult>	The kit config result object.

GetAllPackages()

Declaration

public Task<IList<IPackage>> GetAllPackages()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<IPackage>>

GetApplicationDirectoriesAsync()

Gets the directories containing a manifest file from the scratch drive.

Declaration

public async Task<IEnumerable<PhoenixDirectoryInfo>> GetApplicationDirectoriesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixDirectoryInfo>>	A list of the directories that were found. Empty if none.

GetAppPackageDirectoriesAsync(PhoenixPath)

Gets the app package directories.

Declaration

public Task<IEnumerable<PhoenixDirectoryInfo>> GetAppPackageDirectoriesAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path the directories are located at.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixDirectoryInfo>>	An IEnumerable of Directories.

GetAppPackageFilesAsync(PhoenixPath)

Gets the app package files.

Declaration

public Task<IEnumerable<PhoenixFileInfo>> GetAppPackageFilesAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path the files are located at.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixFileInfo>>	An IEnumerable of files.

GetAppPackageMetadataAsync(PhoenixPath)

Gets the packages metadata from a path.

Declaration

public async Task<Dictionary<string, string>> GetAppPackageMetadataAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path to the app package.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<System.String, System.String>>	Metadata in the form of a string

GetAppPackagesAsync()

Gets the App Packages.

Declaration

public async Task<IEnumerable<PhoenixDirectoryInfo>> GetAppPackagesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixDirectoryInfo>>	A list of App Packages.

GetButtonsState(Guid)

Gets the button state for the specified gamepad.

Declaration

public GamepadButtons? GetButtonsState(Guid gamepadId)

Parameters

Type	Name	Description
System.Guid	gamepadId	The gamepad to query buttons from.

Returns

Type	Description
System.Nullable<GamepadButtons>	The button states (null if the gamepad cannot be found)

GetDirectAppPackagePath(PhoenixPath)

Gets the direct path on the local file system or UNC path.

Declaration

public PhoenixPath GetDirectAppPackagePath(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path to translate

Returns

Type	Description
PhoenixPath	The local file system or UNC path of path; null if not supported

GetDirectSystemPath(PhoenixPath)

Gets the direct path on the local file system or UNC path.

Declaration

public PhoenixPath GetDirectSystemPath(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path to translate

Returns

Type	Description
PhoenixPath	The local file system or UNC path of path; null if not supported

GetDirectTitlePath(PhoenixPath)

Gets the direct path on the local file system or UNC path.

Declaration

public PhoenixPath GetDirectTitlePath(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path to translate

Returns

Type	Description
PhoenixPath	The local file system or UNC path of path; null if not supported

Remarks

None of the title paths are supported while the title is running.

GetIsDeviceAvailable()

Checks this device to see if it is connected and usable.

Declaration

public bool GetIsDeviceAvailable()

Returns

Type	Description
System.Boolean	Whether or not this device is connected and usable.

GetIsRunningAsync(IPackage)

Declaration

public Task<bool> GetIsRunningAsync(IPackage package)

Parameters

Type	Name	Description
IPackage	package

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

GetJoystickPosition(Guid, JoystickType)

Gets the joystick position for the specified gamepad.

Declaration

public JoystickPosition GetJoystickPosition(Guid gamepadId, JoystickType joystick)

Parameters

Type	Name	Description
System.Guid	gamepadId	The gamepad to get the joystick position from.
JoystickType	joystick	The joystick type to query.

Returns

Type	Description
JoystickPosition	The joystick position for the specified gamepad and joystick type. (null if not found)

GetPackages(PackageFilter)

Declaration

public async Task<IList<IPackage>> GetPackages(PackageFilter filter)

Parameters

Type	Name	Description
PackageFilter	filter

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<IPackage>>

GetRunningPackages()

Declaration

public Task<IList<IPackage>> GetRunningPackages()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<IPackage>>

GetScratchDriveAsync()

Gets the scratch drive.

Declaration

public async Task<PhoenixDirectoryInfo> GetScratchDriveAsync()

Returns

Type	Description
System.Threading.Tasks.Task<PhoenixDirectoryInfo>	PhoenixDirectoryInfo for the scratch drive.

GetService(Type)

Gets a service from a specific service provider.

Declaration

public override object GetService(Type serviceType)

Parameters

Type	Name	Description
System.Type	serviceType	The type of service to get.

Returns

Type	Description
System.Object	The requested service.

Overrides

CapabilityBase.GetService(Type)

GetSystemDirectoriesAsync(PhoenixPath)

Gets the system directories.

Declaration

public Task<IEnumerable<PhoenixDirectoryInfo>> GetSystemDirectoriesAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path the directories are located at.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixDirectoryInfo>>	An IEnumerable of Directories.

GetSystemDrivesAsync()

Returns the System drives.

Declaration

public Task<IEnumerable<PhoenixDirectoryInfo>> GetSystemDrivesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixDirectoryInfo>>	Empty list if drives cannot be found.

GetSystemFilesAsync(PhoenixPath)

Gets the system files.

Declaration

public Task<IEnumerable<PhoenixFileInfo>> GetSystemFilesAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path the files are located at.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixFileInfo>>	An IEnumerable of files.

GetTitleDirectoriesAsync(PhoenixPath)

Gets the Title directories.

Declaration

public Task<IEnumerable<PhoenixDirectoryInfo>> GetTitleDirectoriesAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path the directories are located at.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixDirectoryInfo>>	An IEnumerable of Directories.

GetTitleDrivesAsync()

Gets the drives from a running an ERA Title.

Declaration

public Task<IEnumerable<PhoenixDirectoryInfo>> GetTitleDrivesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixDirectoryInfo>>	IEnumerable of the drives represented by PhoenixDirectoryInfo. Empty list if none can be found.

GetTitleFilesAsync(PhoenixPath)

Gets the Title files.

Declaration

public Task<IEnumerable<PhoenixFileInfo>> GetTitleFilesAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The path the files are located at.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixFileInfo>>	An IEnumerable of files.

GetTitleScratchDrive()

Gets the scratch drive of the Xbox Title system.

Declaration

public PhoenixDirectoryInfo GetTitleScratchDrive()

Returns

Type	Description
PhoenixDirectoryInfo	A PhoenixDirectoryInfo representing the drive.

GetTriggerPosition(Guid, TriggerType)

Gets the trigger position for the specified gamepad.

Declaration

public float? GetTriggerPosition(Guid gamepadId, TriggerType trigger)

Parameters

Type	Name	Description
System.Guid	gamepadId	The gamepad to get the trigger position from.
TriggerType	trigger	The trigger type to query.

Returns

Type	Description
System.Nullable<System.Single>	The trigger position for the specified gamepad and trigger type (null if gamepad not found)

HoldButtons(Guid, GamepadButtons)

Holds the specified buttons.

Declaration

public void HoldButtons(Guid gamepadId, GamepadButtons buttons)

Parameters

Type	Name	Description
System.Guid	gamepadId	The gamepad to send the button hold to.
GamepadButtons	buttons	The buttons to hold.

IsSystem(WinPackageInfo)

Gets whether or not the package is a system package.

Declaration

public static bool IsSystem(WinPackageInfo package)

Parameters

Type	Name	Description
WinPackageInfo	package	The xbox package to check.

Returns

Type	Description
System.Boolean	Whether or not the passed in package is a system package.

Launch(IApplication)

Declaration

public Task Launch(IApplication application)

Parameters

Type	Name	Description
IApplication	application

Returns

Type	Description
System.Threading.Tasks.Task

Launch(IApplication, String)

Declaration

public Task Launch(IApplication application, string commandLine)

Parameters

Type	Name	Description
IApplication	application
System.String	commandLine

Returns

Type	Description
System.Threading.Tasks.Task

Launch(String)

Declaration

public Task Launch(string aumid)

Parameters

Type	Name	Description
System.String	aumid

Returns

Type	Description
System.Threading.Tasks.Task

Launch(String, String)

Declaration

public Task Launch(string aumid, string commandLine)

Parameters

Type	Name	Description
System.String	aumid
System.String	commandLine

Returns

Type	Description
System.Threading.Tasks.Task

OnDeviceAliasChanged(String, String)

Declaration

protected override void OnDeviceAliasChanged(string oldValue, string value)

Parameters

Type	Name	Description
System.String	oldValue
System.String	value

Overrides

DeviceBase.OnDeviceAliasChanged(String, String)

OpenFileSystemItemAsync(PhoenixPath)

Opens a FileSystemItem

Declaration

public async Task OpenFileSystemItemAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The file path to open.

Returns

Type	Description
System.Threading.Tasks.Task	The task performing the request.

PushLoosePackageAsync(String, IProgress<DeploymentProgressInfo>, Boolean, CancellationToken)

Installs a loose files application on the device.

Declaration

public async Task<bool> PushLoosePackageAsync(string looseDirectory, IProgress<DeploymentProgressInfo> progress, bool removeExtraFiles, CancellationToken cancelToken)

Parameters

Type	Name	Description
System.String	looseDirectory	The directory the manifest file is in.
System.IProgress<DeploymentProgressInfo>	progress	The IProgress object to report progress to.
System.Boolean	removeExtraFiles	Whether or not the deployment will remove extra files.
System.Threading.CancellationToken	cancelToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	True upon success

Reboot()

Reboots the device.

Declaration

public void Reboot()

RebootAsync()

Asynchronously reboots this device.

Declaration

public async Task RebootAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A task that represents the reboot operation.

RebootAsync(CancellationToken)

Asynchronously reboots this device.

Declaration

public async Task RebootAsync(CancellationToken token)

Parameters

Type	Name	Description
System.Threading.CancellationToken	token	A cancellation token that should be used to cancel the work.

Returns

Type	Description
System.Threading.Tasks.Task	A task that represents the reboot operation.

ReleaseButtons(Guid, GamepadButtons)

Releases the specified buttons.

Declaration

public void ReleaseButtons(Guid gamepadId, GamepadButtons buttons)

Parameters

Type	Name	Description
System.Guid	gamepadId	The gamepad to send the button release to.
GamepadButtons	buttons	The buttons to release.

Resume(IPackage)

Declaration

public Task Resume(IPackage package)

Parameters

Type	Name	Description
IPackage	package

Returns

Type	Description
System.Threading.Tasks.Task

Serialize()

Serializes device information.

Declaration

public override SerializableIDevice Serialize()

Returns

Type	Description
SerializableIDevice	The SerializableIDevice.

Overrides

DeviceBase.Serialize()

SetJoystickPosition(Guid, JoystickType, JoystickPosition)

Sets the joystick position for the specified gamepad.

Declaration

public void SetJoystickPosition(Guid gamepadId, JoystickType joystick, JoystickPosition position)

Parameters

Type	Name	Description
System.Guid	gamepadId	The gamepad to set the joystick position for.
JoystickType	joystick	The joystick type.
JoystickPosition	position	The joystick position.

SetTriggerPosition(Guid, TriggerType, Single)

Sets the trigger position for the specified gamepad.

Declaration

public void SetTriggerPosition(Guid gamepadId, TriggerType trigger, float position)

Parameters

Type	Name	Description
System.Guid	gamepadId	The gamepad to set the trigger position for.
TriggerType	trigger	The trigger type.
System.Single	position	The trigger position.

Shutdown()

Shuts down this device.

Declaration

public void Shutdown()

ShutdownAsync()

Asynchronously shuts down this device.

Declaration

public async Task ShutdownAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A task that represents the shutdown operation.

ShutdownAsync(CancellationToken)

Asynchronously shuts down this device.

Declaration

public async Task ShutdownAsync(CancellationToken token)

Parameters

Type	Name	Description
System.Threading.CancellationToken	token	A cancellation token that should be used to cancel the work.

Returns

Type	Description
System.Threading.Tasks.Task	A task that represents the shutdown operation.

Snap(IApplication)

Declaration

public Task Snap(IApplication application)

Parameters

Type	Name	Description
IApplication	application

Returns

Type	Description
System.Threading.Tasks.Task

StreamPackageAsync(String, IProgress<DeploymentProgressInfo>, Boolean, CancellationToken)

Installs an application package on the device.

Declaration

public async Task<bool> StreamPackageAsync(string packageFile, IProgress<DeploymentProgressInfo> progress, bool onlyLaunchChunk, CancellationToken cancelToken)

Parameters

Type	Name	Description
System.String	packageFile	The package to install on the device.
System.IProgress<DeploymentProgressInfo>	progress	The IProgress object to report progress to.
System.Boolean	onlyLaunchChunk	Whether or not to only deploy the launch chunk.
System.Threading.CancellationToken	cancelToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	True upon success

Suspend(IPackage)

Declaration

public Task Suspend(IPackage package)

Parameters

Type	Name	Description
IPackage	package

Returns

Type	Description
System.Threading.Tasks.Task

SystemDirectoryExistsAsync(PhoenixPath)

Checks if a directory exists in a System directory.

Declaration

public Task<bool> SystemDirectoryExistsAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The directory to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	True if the directory exists, false if not.

SystemFileExistsAsync(PhoenixPath)

Checks if a file exists in a System directory.

Declaration

public Task<bool> SystemFileExistsAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The file to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	True if the file exists, false if not.

Terminate(IPackage)

Declaration

public Task Terminate(IPackage package)

Parameters

Type	Name	Description
IPackage	package

Returns

Type	Description
System.Threading.Tasks.Task

TitleDirectoryExistsAsync(PhoenixPath)

Checks if a directory exists in a Title directory.

Declaration

public Task<bool> TitleDirectoryExistsAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The directory to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	True if the directory exists, false if not.

TitleFileExistsAsync(PhoenixPath)

Checks if a file exists in a Title directory.

Declaration

public Task<bool> TitleFileExistsAsync(PhoenixPath path)

Parameters

Type	Name	Description
PhoenixPath	path	The file to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	True if the file exists, false if not.

TryPairWithUser(Guid, PhoenixUser, Boolean)

Tries to pair a gamepad with a user.

Declaration

public async Task<bool> TryPairWithUser(Guid gamepadId, PhoenixUser user, bool exclusive)

Parameters

Type	Name	Description
System.Guid	gamepadId	The gamepad to pair the user to.
PhoenixUser	user	The user to pair with the gamepad.
System.Boolean	exclusive	Whether or not the gamepad should be paired exclusively with the user or not.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	Whether or not the pairing was successful.

Unconstrain(IPackage)

Declaration

public Task Unconstrain(IPackage package)

Parameters

Type	Name	Description
IPackage	package

Returns

Type	Description
System.Threading.Tasks.Task

Uninstall(IPackage)

Declaration

public Task Uninstall(IPackage package)

Parameters

Type	Name	Description
IPackage	package

Returns

Type	Description
System.Threading.Tasks.Task

Unsnap(IPackage)

Declaration

public Task Unsnap(IPackage package)

Parameters

Type	Name	Description
IPackage	package

Returns

Type	Description
System.Threading.Tasks.Task

UpdateAsync(XdkReference, Boolean, Boolean, Boolean)

Updates the xbox kit to a new XDK version and/or provisions the OS.

Declaration

public async Task<bool> UpdateAsync(XdkReference xdk, bool updateRecovery, bool provisionGameOS, bool factoryReset)

Parameters

Type	Name	Description
XdkReference	xdk	The XDK reference paths wrapper.
System.Boolean	updateRecovery	Whether or not to update the recovery
System.Boolean	provisionGameOS	Whether or not to provision the GameOS (and Tool OS if it exists)
System.Boolean	factoryReset	Whether or not to factory reset when updating the recovery (default false)

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	whether or not the update was successful.

Explicit Interface Implementations

IDeviceStatus.GetAsync()

Declaration

async Task<DeviceConnectionStatus> IDeviceStatus.GetAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeviceConnectionStatus>

IDeviceStatus.Set(DeviceConnectionStatus)

Sets the DeviceConnectionStatus for a device.

Declaration

void IDeviceStatus.Set(DeviceConnectionStatus status)

Parameters

Type	Name	Description
DeviceConnectionStatus	status	The status to set.

Implements

System.IServiceProvider

IDevice

ICapability

IDeviceControllable

IDeviceInput

IFileSystemIOAppPackage

IFileSystemIOSystem

IFileSystemIOTitle

System.IDisposable

IDevicePackages

IDeviceStatus

Extension Methods

XboxXbConnectExtensions.GetXdkVersionAsync(Xbox)

XboxXbConnectExtensions.GetRecoveryVersionAsync(Xbox)