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: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
Section titled “Type Parameters”• TLanguage extends InstrumentLanguage = InstrumentLanguage
the language(s) of the instrument
Type declaration
Section titled “Type declaration”estimatedDuration?
Section titled “estimatedDuration?”
optionalestimatedDuration:number
An integer representing the estimated number of minutes for the average target subject to complete the instrument
instructions?
Section titled “instructions?”
optionalinstructions:InstrumentUIOption<TLanguage,string[]>
Brief sequential instructions for how the subject should complete the instrument.
title?
Section titled “title?”
optionaltitle:InstrumentUIOption<TLanguage,string>
The title of the instrument to show the client. If not specified, defaults to details.title