Show / Hide Table of Contents

Class DeviceBot

A bot for a DeviceConsole device.

Inheritance
object
EventPublisher<BotActionEventArgs>
BotWithEvents<IDeviceOperation>
AutomatedBotBase<IDeviceOperation>
AutomatedBot<DeviceBot, IDeviceOperation>
DeviceBot
Implements
IEventPublisher<BotActionEventArgs>
IBotWithEvents<IDeviceOperation>
IBotWithEvents
IBotWithQueue<IDeviceOperation>
IBotWithQueue
IAutomatedBot<IDeviceOperation>
IAutomatedBot
IHasParameters
IDisposable
Inherited Members
AutomatedBot<DeviceBot, IDeviceOperation>.GetOperation(IDeviceOperation)
AutomatedBot<DeviceBot, IDeviceOperation>.StartOrResumeExecution<T>(IOperation<T>, T, CancellationToken)
AutomatedBot<DeviceBot, IDeviceOperation>.StartOrResumeExecution(IDeviceOperation, CancellationToken)
AutomatedBot<DeviceBot, IDeviceOperation>.StartExecution(IOperation<DeviceBot>, CancellationToken)
AutomatedBot<DeviceBot, IDeviceOperation>.StartExecution<T>(IOperation<T>, T, CancellationToken)
AutomatedBotBase<IDeviceOperation>.QueueStarted
AutomatedBotBase<IDeviceOperation>.QueueStopped
AutomatedBotBase<IDeviceOperation>.StopAfterError
AutomatedBotBase<IDeviceOperation>.IsRunning
AutomatedBotBase<IDeviceOperation>.CurrentAction
AutomatedBotBase<IDeviceOperation>.QueueIndex
AutomatedBotBase<IDeviceOperation>.QueueCount
AutomatedBotBase<IDeviceOperation>.Start()
AutomatedBotBase<IDeviceOperation>.Start(int)
AutomatedBotBase<IDeviceOperation>.Stop()
AutomatedBotBase<IDeviceOperation>.Reset()
AutomatedBotBase<IDeviceOperation>.Dispose()
AutomatedBotBase<IDeviceOperation>.SetActions(IEnumerable<IDeviceOperation>)
AutomatedBotBase<IDeviceOperation>.OnQueueStarted()
AutomatedBotBase<IDeviceOperation>.OnQueueStopped()
AutomatedBotBase<IDeviceOperation>.HandleActionFailed(IDeviceOperation, Exception)
BotWithEvents<IDeviceOperation>.ActionStarted
BotWithEvents<IDeviceOperation>.ActionFailed
BotWithEvents<IDeviceOperation>.ActionFinished
BotWithEvents<IDeviceOperation>.Name
BotWithEvents<IDeviceOperation>.CurrentUrge
BotWithEvents<IDeviceOperation>.Parameters
BotWithEvents<IDeviceOperation>.ToString()
BotWithEvents<IDeviceOperation>.OnActionStarted()
BotWithEvents<IDeviceOperation>.OnActionFinished(IDeviceOperation)
BotWithEvents<IDeviceOperation>.OnActionFailed(IDeviceOperation, Exception)
EventPublisher<BotActionEventArgs>.Publish(object, BotActionEventArgs)
EventPublisher<BotActionEventArgs>.EventReceived
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
Namespace: Microsoft.XboxStudios.BotBrain.Devices
Assembly: BotBrain.Devices.dll
Syntax
public class DeviceBot : AutomatedBot<DeviceBot, IDeviceOperation>, IEventPublisher<BotActionEventArgs>, IBotWithEvents<IDeviceOperation>, IBotWithEvents, IBotWithQueue<IDeviceOperation>, IBotWithQueue, IAutomatedBot<IDeviceOperation>, IAutomatedBot, IHasParameters, IDisposable

Constructors

View Source

DeviceBot(IDevice)

Initializes a new instance of the DeviceBot class.

Declaration
public DeviceBot(IDevice device)
Parameters
Type Name Description
IDevice device

The device.

Properties

View Source

Device

Gets the device.

Declaration
public IDevice Device { get; }
Property Value
Type Description
IDevice

Methods

View Source

StartOrResumeExecution(IDeviceOperation, CancellationToken)

Starts executing the action on this bot, or waits for it to finish if it's already running.

Declaration
protected override Task<bool> StartOrResumeExecution(IDeviceOperation operation, CancellationToken token)
Parameters
Type Name Description
IDeviceOperation operation

The action.

CancellationToken token

A token to monitor for cancellation.

Returns
Type Description
Task<bool>

True if the operation was successful.

Overrides
AutomatedBot<DeviceBot, IDeviceOperation>.StartOrResumeExecution(IDeviceOperation, CancellationToken)

Implements

Microsoft.XboxStudios.GameStateTracker.Events.IEventPublisher<T>
IBotWithEvents<TAction>
IBotWithEvents
IBotWithQueue<T>
IBotWithQueue
IAutomatedBot<TAction>
IAutomatedBot
IHasParameters
IDisposable

Extension Methods

IEventPublisherExtensions.WaitForAsync<T>(IEventPublisher<T>, Func<T, bool>?, CancellationToken)
  • View Source
In this article
Back to top Generated by DocFX