Class LaunchGame
An operation that launches an application on a device.
Inherited Members
Namespace: Microsoft.XboxStudios.BotBrain.Devices
Assembly: BotBrain.Devices.dll
Syntax
public class LaunchGame : DeviceOperationBase, IDeviceOperation, ICancellableOperation<IDevice>, IOperation<IDevice>, ICancellableOperation, IOperation, IEquatable<IDeviceOperation?>
Constructors
View SourceLaunchGame()
Initializes a new instance of the LaunchGame class.
Declaration
public LaunchGame()
Properties
View SourceApplicationName
Gets or sets the application to launch.
Declaration
public string ApplicationName { get; set; }
Property Value
Type | Description |
---|---|
string |
EnvironmentName
Gets or sets the environment to launch applications with.
Declaration
public string? EnvironmentName { get; set; }
Property Value
Type | Description |
---|---|
string |
LaunchArguments
Gets or sets the launch configuration.
Declaration
public string LaunchArguments { get; set; }
Property Value
Type | Description |
---|---|
string |
Methods
View SourceExecuteOn(IDevice, CancellationToken)
Runs the operation on an item.
Declaration
protected override Task<bool> ExecuteOn(IDevice item, CancellationToken token)
Parameters
Type | Name | Description |
---|---|---|
IDevice | item | The item. |
CancellationToken | token | A token to monitor for cancellation. |
Returns
Type | Description |
---|---|
Task<bool> | A task that returns a boolean indicating success or failure when the operation completes. |
Overrides
View SourceToString()
Returns a string that represents the current object.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string | A string that represents the current object. |