Interface ParamsCoursesItem

Hierarchy

  • ParamsCoursesItem

Properties

categoryid completionnotify courseformatoptions customfields defaultgroupingid? enablecompletion enddate forcetheme format? fullname groupmode? groupmodeforce? hiddensections idnumber lang maxbytes? newsitems? numsections shortname showgrades? showreports? startdate summary summaryformat? visible

Properties

categoryid

categoryid: null | number

category id

completionnotify

completionnotify: null | number

1: yes 0: no

courseformatoptions

courseformatoptions: api.core.course.create_courses.ParamsCoursesItemCourseformatoptions

additional options for particular course format

customfields

customfields: api.core.course.create_courses.ParamsCoursesItemCustomfields

custom fields for the course

Optional defaultgroupingid

defaultgroupingid?: null | number

default grouping id

enablecompletion

enablecompletion: null | number

Enabled, control via completion and activity settings. Disabled, not shown in activity settings.

enddate

enddate: null | number

timestamp when the course end

forcetheme

forcetheme: null | string

name of the force theme

Optional format

format?: null | string

course format: weeks, topics, social, site,..

fullname

fullname: null | string

full name

Optional groupmode

groupmode?: null | number

no group, separate, visible

Optional groupmodeforce

groupmodeforce?: null | number

1: yes, 0: no

hiddensections

hiddensections: null | number

(deprecated, use courseformatoptions) How the hidden sections in the course are displayed to students

idnumber

idnumber: null | string

id number

lang

lang: null | string

forced course language

Optional maxbytes

maxbytes?: null | number

largest size of file that can be uploaded into the course

Optional newsitems

newsitems?: null | number

number of recent items appearing on the course page

numsections

numsections: null | number

(deprecated, use courseformatoptions) number of weeks/topics

shortname

shortname: null | string

course short name

Optional showgrades

showgrades?: null | number

1 if grades are shown, otherwise 0

Optional showreports

showreports?: null | number

are activity report shown (yes = 1, no =0)

startdate

startdate: null | number

timestamp when the course start

summary

summary: null | string

summary

Optional summaryformat

summaryformat?: null | number

summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN

visible

visible: null | number

1: available to student, 0:not available

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc