Class BotWithQueueViewModel<T>

The view model for a bot with a queue of actions which can be started from any index.

Inheritance
object
BindableBase
ViewModelBase
BotViewModelBase
BotViewModel
BotWithQueueViewModel<T>
BotWithPresetActionsViewModel<TBot, T>
Implements
Inherited Members
Namespace: Phoenix.BotBrain
Assembly: Phoenix.Plugin.BotBrain.BotScripting.dll
Syntax
public abstract class BotWithQueueViewModel<T> : BotViewModel, IBotViewModelWithActions, IBotViewModel, INotifyPropertyChanged, IOnSelected, ICanMoveItemsTo, IDisposable
Type Parameters
Name Description
T

The type of actions the bot supports.

Constructors

View Source

BotWithQueueViewModel(IServiceProvider)

Initializes a new instance of the BotWithQueueViewModel<T> class.

Declaration
public BotWithQueueViewModel(IServiceProvider services)
Parameters
Type Name Description
IServiceProvider services

The service provider.

Properties

View Source

CanResume

Gets a value indicating whether or not the bot can be resumed.

Declaration
public override bool CanResume { get; }
Property Value
Type Description
bool
Overrides

Methods

View Source

CreateBot()

Creates a bot.

Declaration
protected abstract IAutomatedBot<T> CreateBot()
Returns
Type Description
IAutomatedBot<T>

The bot.
View Source

DisposeBot(IAutomatedBot)

Disposes the bot.

Declaration
protected override void DisposeBot(IAutomatedBot bot)
Parameters
Type Name Description
IAutomatedBot bot

The bot.
Overrides
View Source

OnBotQueueStarted(object?, EventArgs)

Called when a bot queue starts.

Declaration
protected virtual void OnBotQueueStarted(object? sender, EventArgs e)
Parameters
Type Name Description
object sender

The sender.
EventArgs e

Not used.
View Source

OnBotQueueStopped(object?, EventArgs)

Called when a bot queue finishes.

Declaration
protected virtual void OnBotQueueStopped(object? sender, EventArgs e)
Parameters
Type Name Description
object sender

The sender.
EventArgs e

Not used.
View Source

PushBotActions()

Pushes the queued actions from the UI to the underlying bot.

Declaration
protected virtual Task PushBotActions()
Returns
Type Description
Task

A task.
View Source

RegisterBotEvents()

Registers bot events.

Declaration
protected override void RegisterBotEvents()
Overrides
View Source

ResumeAsync()

Resumes the bot.

Declaration
public override Task ResumeAsync()
Returns
Type Description
Task

A task.
Overrides
View Source

SetupBot()

Sets up the bot in order to start it.

Declaration
protected override Task SetupBot()
Returns
Type Description
Task

A task.
Overrides

Implements

Extension Methods