ClientInstrumentDetails
Ce contenu n’est pas encore disponible dans votre langue.
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?
optionalestimatedDuration?: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?
optionalinstructions?: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?
optionaltitle?: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