Interface PearsonContextTemplate

A retrieved context template.

interface PearsonContextTemplate {
    assistants: PearsonAssistantConfigSummary[];
    assistantsEnabled?: boolean;
    bookId: string;
    contextId: string;
    courseAssistantsEnabled?: boolean;
    coursePasteLimit?: PasteLimit;
    defaultAssistantsEnabled: boolean;
    defaultPasteLimit: PasteLimit;
    effectiveAssistantsEnabled: boolean;
    effectivePasteLimit: PasteLimit;
    name: string;
    numberOfAttempts: NumberOfAttempts;
    pasteLimit?: PasteLimit;
    questions: PearsonContextTemplateQuestionSummary[];
    requiresPasteLimit: boolean;
    templateAssistantsEnabled: boolean;
    templateId: string;
    tenantId: string;
}

Properties

assistants assistantsEnabled? bookId contextId courseAssistantsEnabled? coursePasteLimit? defaultAssistantsEnabled defaultPasteLimit effectiveAssistantsEnabled effectivePasteLimit name numberOfAttempts pasteLimit? questions requiresPasteLimit templateAssistantsEnabled templateId tenantId

Properties

assistants

assistants: PearsonAssistantConfigSummary[]

The assistants provisioned on this template.

OptionalassistantsEnabled

assistantsEnabled?: boolean

This template's own assistant availability in this course. Absent when the template inherits.

bookId

bookId: string

The book of this template.

contextId

contextId: string

The context in which this template lives.

OptionalcourseAssistantsEnabled

courseAssistantsEnabled?: boolean

The course-wide assistant availability. Absent when the course inherits.

OptionalcoursePasteLimit

coursePasteLimit?: PasteLimit

The course-wide paste limit. Absent when the course inherits.

defaultAssistantsEnabled

defaultAssistantsEnabled: boolean

What this template resolves to when its own level is cleared: the course value when set, otherwise the admin default.

defaultPasteLimit

defaultPasteLimit: PasteLimit

What this template resolves to when its own level is cleared: the course value when set, otherwise the admin default.

effectiveAssistantsEnabled

effectiveAssistantsEnabled: boolean

Whether students in this course get this template's assistants.

effectivePasteLimit

effectivePasteLimit: PasteLimit

The paste limit students get for this template.

name

name: string

The name of this template.

numberOfAttempts

numberOfAttempts: NumberOfAttempts

The amount of attempts a student may do.

OptionalpasteLimit

pasteLimit?: PasteLimit

This template's own paste limit in this course. Absent when the template inherits.

questions

questions: PearsonContextTemplateQuestionSummary[]

The questions of this template.

requiresPasteLimit

requiresPasteLimit: boolean

Whether this template has a free-text question for which a paste limit applies.

templateAssistantsEnabled

templateAssistantsEnabled: boolean

The admin default for this template, before either teacher level applies.

templateId

templateId: string

The id of the template from which this context template was created.

tenantId

tenantId: string

The id of the tenant that owns this context template.

Settings

Member Visibility

On This Page

Properties