Function: activitySettings()

function activitySettings(
   context, 
   siteUrl, 
   activityId
): Promise<{
  completion: Completion | undefined;
  courseId: number;
  description: string;
  fields: FormField[];
  files: DraftFile[] | undefined;
  id: number;
  module: string;
  name: string;
  restrictions: Restrictions | undefined;
}>;

Defined in: areas/activities/build.ts:455

An activity's settings as its form holds them, without submitting it: its module, name and description, every field by the name updateActivity takes in settings, the files of a resource, folder or SCORM, and its restrictions and completion in plain terms. Teachers only.

Parameters

Parameter	Type
context	BrowserContext
siteUrl	string
activityId	number

Returns

Promise<{ completion: Completion | undefined; courseId: number; description: string; fields: FormField[]; files: DraftFile[] | undefined; id: number; module: string; name: string; restrictions: Restrictions | undefined; }>