Saltar al contenido principal

Function: resetCourse()

function resetCourse(
   context, 
   siteUrl, 
   courseId, 
   __namedParameters
): Promise<{
  changed: string;
  report: ResetStatus[];
}>;

Defined in: areas/courses/reset.ts:106

Resets a course for a new year, as Moodle's reset form does: deletes only what's named in delete (in every module of the course that has it), unenrols the people with unenrolRoles (role ids), moves the course's start date to start (and its activities' dates with it), and sets any other of the form's fields by name (fields). Nothing is deleted unless asked: the form's own defaults are unticked first. It can't be undone. Returns Moodle's report: per component, what it did and its errors. Needs moodle/course:reset.

Parameters​

ParameterType
contextBrowserContext
siteUrlstring
courseIdnumber
__namedParameters{ delete?: ResetDeletions; fields?: Record<string, FieldValue>; start?: Date; unenrolRoles?: number[]; }
__namedParameters.delete?ResetDeletions
__namedParameters.fields?Record<string, FieldValue>
__namedParameters.start?Date
__namedParameters.unenrolRoles?number[]

Returns​

Promise<{ changed: string; report: ResetStatus[]; }>