Skip to content
Open Data Capture

ClientInstrumentDetails

ClientInstrumentDetails<TLanguage> = object

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

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

TLanguage extends InstrumentLanguage = InstrumentLanguage

the language(s) of the instrument

Properties

estimatedDuration?

optional estimatedDuration?: number

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

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

instructions?

optional instructions?: InstrumentUIOption<TLanguage, string[]>

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

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

title?

optional title?: InstrumentUIOption<TLanguage, string>

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

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