Hierarchy

  • ReturnsItem

Properties

category: null | number

course category id

completed: null | boolean

Whether the course is completed.

completionhascriteria: null | boolean

If completion criteria is set.

completionusertracked: null | boolean

If the user is completion tracked.

courseimage: null | string

The course image URL

displayname: null | string

course display name for lists.

enablecompletion: null | boolean

true if completion is enabled, otherwise false

enddate: null | number

Timestamp when the course end

enrolledusercount: null | number

Number of enrolled users in this course

format: null | string

course format: weeks, topics, social, site

fullname: null | string

long name of course

hidden: null | boolean

If the user hide the course from the dashboard.

id: null | number

id of course

idnumber: null | string

id number of course

isfavourite: null | boolean

If the user marked this course a favourite.

lang: null | string

forced course language

lastaccess: null | number

Last access to the course (timestamp).

marker: null | number

Course section marker.

Overview files attached to this course.

progress: null | number

Progress percentage

shortname: null | string

short name of course

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 | boolean

true if grades are shown, otherwise false

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

timemodified: null | number

Last time course settings were updated (timestamp).

visible: null | number

1 means visible, 0 means not yet visible course

Generated using TypeDoc