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;
    effectiveDefaultPanel?: EditorDefaultPanel;
    effectivePasteLimit: PasteLimit;
    name: string;
    numberOfAttempts: NumberOfAttempts;
    pasteLimit?: PasteLimit;
    questions: PearsonContextTemplateQuestionSummary[];
    requiresPasteLimit: boolean;
    templateAssistantsEnabled: boolean;
    templateId: string;
    tenantId: string;
}

Properties

The assistants provisioned on this template.

assistantsEnabled?: boolean

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

bookId: string

The book of this template.

contextId: string

The context in which this template lives.

courseAssistantsEnabled?: boolean

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

coursePasteLimit?: PasteLimit

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

defaultAssistantsEnabled: boolean

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

defaultPasteLimit: PasteLimit

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

effectiveAssistantsEnabled: boolean

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

effectiveDefaultPanel?: EditorDefaultPanel

The panel the code editor opens on for an assignment launched from this template. Absent when the template names no panel, which leaves the assignment on the tenant default.

effectivePasteLimit: PasteLimit

The paste limit students get for this template.

name: string

The name of this template.

numberOfAttempts: NumberOfAttempts

The amount of attempts a student may do.

pasteLimit?: PasteLimit

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

The questions of this template.

requiresPasteLimit: boolean

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

templateAssistantsEnabled: boolean

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

templateId: string

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

tenantId: string

The id of the tenant that owns this context template.