Skip to main content

Class: SimpleToolWrapper

A simple class wrapper to inherit in your tool which contains the initialization and storage of the simple tool component utility. See one of the Simple samples to see how to use this class and the wrapper framework

Implements

Constructors

new SimpleToolWrapper()

new SimpleToolWrapper(): SimpleToolWrapper

Returns

SimpleToolWrapper

Accessors

session

get session(): IPlayerUISession<Record<string, never>>

Returns

IPlayerUISession<Record<string, never>>


simpleTool

get simpleTool(): ISimpleTool

Returns

ISimpleTool

Methods

setupSimpleTool()

setupSimpleTool(session, options): void

Parameters

ParameterType
sessionIPlayerUISession<Record<string, never>>
optionsISimpleToolOptions

Returns

void


teardown()

teardown(): void

Returns

void

Implementation of

IDisposable . teardown

Remarks

Initiates the teardown and cleanup of this disposable item.