Interface IHarnessBuilderUIClient

Namespace: Phoenix.ComponentAPI
Assembly: Phoenix.ComponentAPI.dll

This interface provides a client the ability to host builder UIs to create and edit harnesses.

This interface is thread safe and asynchronous. It uses the task-based asynchronous pattern (https://docs.microsoft.com/en-us/dotnet/standard/asynchronous-programming-patterns/task-based-asynchronous-pattern-tap )

public interface IHarnessBuilderUIClient : IHarnessRunnerClient, IDisposable

Implements

IHarnessRunnerClient, IDisposable

Extension Methods

Extensions.StartSessionForLocalExtractedOrCompressedPaczAsync(IHarnessRunnerClient, string, IRunnerSessionOptions)

Methods

CreateNewComponentAsync(Guid, IRunnerSessionOptions)

Creates a new instance of a builder using the Id of the plug-in. This creates both the Builder UI and the Runner. You must Dispose() both the returned object as well as the IHarnessBuilderUISession.Runner separately. This allows the Runner to outlive the builder UI if you so desire.

OpenBuilderUIForComponentAsync(IHarnessRunnerSession)

Creates the builder UI to edit the given instantiated IHarnessSession. No IPaczWriter local session may be open on this runner when calling this method.

OpenLocalEditSessionForComponentAsync(IHarnessRunnerSession)

Opens up the pacz for the given IHarnessRunnerSession for editing locally. Typically used to create metadata editors in the main OEM UI. No IHarnessBuilderUISession may be open on this runner when calling this method.