ClientInstrumentDetails

ClientInstrumentDetails<TLanguage>: object

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:36

An object containing the base details of any instrument to be displayed to the client. This may be augmented in specific kinds of instruments, if applicable.

Type Parameters

• TLanguage extends InstrumentLanguage = InstrumentLanguage

the language(s) of the instrument

Type declaration

estimatedDuration?

optional estimatedDuration: number

An integer representing the estimated number of minutes for the average target subject to complete the instrument

instructions?

optional instructions: InstrumentUIOption<TLanguage, string[]>

Brief sequential instructions for how the subject should complete the instrument.

title?

optional title: InstrumentUIOption<TLanguage, string>

The title of the instrument to show the client. If not specified, defaults to details.title