Interface IHarnessBuilderUIHost<RUNNER>

Namespace: Phoenix.ComponentBuilderAPI
Assembly: Phoenix.ComponentBuilderAPI.dll

A context object passed to builder UIs.

public interface IHarnessBuilderUIHost<RUNNER> : ILicenseProvider, IDisposable where RUNNER : IHarnessRunner

Type Parameters

RUNNER

Implements

ILicenseProvider, IDisposable

Properties

ExtractedPacz

The extracted pacz being edited. The plug-in is not responsible for disposing the returned object.

Logger

Get a logger to use when writing messages.

Methods

CallRunnerAsync<T>(Func<IHarnessRunnerHost, RUNNER, T>)

The builder UI and the runner will not be in the same thread. Use this function to safely access the runner. The function passed in will be invoked on the runner's thread and any return values will be provided via the TaskT return value.

Note: Do not access UI elements from the passed in function. Instead, collect results into the returned object and use them from the return value.

CallRunnerAsync<T>(Func<IHarnessRunnerHost, RUNNER, Task<T>>)

The builder UI and the runner will not be in the same thread. Use this function to safely access the runner. The function passed in will be invoked on the runner's thread and any return values will be provided via the TaskT return value.

Note: Do not access UI elements from the passed in function. Instead, collect results into the returned object and use them from the return value.

CallRunnerAsync(Action<IHarnessRunnerHost, RUNNER>)

The builder UI and the runner will not be in the same thread. Use this function to safely access the runner. The action passed in will be invoked on the runner's thread.

Note: Do not access UI elements from the passed in action. If you need results from the runner, use the overload that returns a value. Phoenix.ComponentBuilderAPI.IHarnessBuilderUIHost1.CallRunnerAsync1(System.Func{Phoenix.ComponentAPI.IHarnessRunnerHost,`0,0})`

CallRunnerAsync(Func<IHarnessRunnerHost, RUNNER, Task>)

The builder UI and the runner will not be in the same thread. Use this function to safely access the runner. The action passed in will be invoked on the runner's thread.

Note: Do not access UI elements from the passed in action. If you need results from the runner, use the overload that returns a value. Phoenix.ComponentBuilderAPI.IHarnessBuilderUIHost1.CallRunnerAsync1(System.Func{Phoenix.ComponentAPI.IHarnessRunnerHost,`0,0})`

RaiseTestRunEvent()

Raises an event requesting that the OEM client perform a test run and does not wait for the run to complete. The test run will use the input values from the OEM, so Phoenix.ComponentBuilderAPI.IHarnessBuilderUIHost1.SaveAsync` should be called before calling this if changes are present in the builder UI.

SaveAsync()

Inform the host that the user has applied changes to the IHarness being edited. The changes will be applied to the Phoenix.ComponentBuilderAPI.IHarnessBuilderUIHost1.ExtractedPacz` object.