course

Hierarchy

  • ReturnsItem

Properties

categoryid: null | number

category id

categorysortorder: null | number

sort order into the category

completionnotify: null | number

1: yes 0: no

courseformatoptions: ReturnsItemCourseformatoptions

additional options for particular course format

Custom fields and associated values

defaultgroupingid: null | number

default grouping id

displayname: null | string

course display name

enablecompletion: null | number

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

enddate: null | number

timestamp when the course end

forcetheme: null | string

name of the force theme

format: null | string

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

fullname: null | string

full name

groupmode: null | number

no group, separate, visible

groupmodeforce: null | number

1: yes, 0: no

hiddensections: null | number

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

id: null | number

course id

idnumber: null | string

id number

lang: null | string

forced course language

maxbytes: null | number

largest size of file that can be uploaded into the course

newsitems: null | number

number of recent items appearing on the course page

numsections: null | number

(deprecated, use courseformatoptions) number of weeks/topics

shortname: null | string

course short name

showactivitydates: null | boolean

Whether the activity dates are shown or not

showcompletionconditions: null | boolean

Whether the activity completion conditions are shown or not

showgrades: null | number

1 if grades are shown, otherwise 0

showreports: null | number

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

startdate: null | number

timestamp when the course start

summary: null | string

summary

summaryformat: null | number

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

timecreated: null | number

timestamp when the course have been created

timemodified: null | number

timestamp when the course have been modified

visible: null | number

1: available to student, 0:not available

Generated using TypeDoc