| activitiesOverview | Moodle 5's activities overview of a course for one type ("resource" for every resource type): per activity, the columns its overview page shows the person (due dates, submissions, what needs grading, their own grade…). Without a type, every type in the course's state: "resource" first, which brings pages, books, files, folders and links at once, then each type still missing. |
| activityContent | Reads a page's or label's text, a book's chapters, a URL resource's target, or a file resource's or folder's files. With the realistic trail, page by page at a reader's pace, calling onProgress with the seconds read so far while it pauses. Takes an activity as the course structure gives it ({ id, type }), or its id and module. |
| activityReport | A course's activity report: per activity, how many times it was viewed, by how many people, and when last, from the logs (between from and until when given). Activities nobody viewed come with zero views. |
| activitySettings | 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. |
| addGradeCategory | Adds a grade category (at the course's top level, or inside parentId); returns it as the setup shows it. |
| addGradeItem | Adds a manual grade item (one graded in the gradebook, not by an activity): out of maxGrade (Moodle's default, 100, when left out) or on a scale (scaleId), at the course's top level or in categoryId, hidden from students when asked. Returns it as the setup shows it. |
| addQuestionsToQuiz | Adds bank questions to a quiz by id, and random questions from a bank category, at the end or on a page, as the edit page's bank actions post them. Returns the quiz's structure afterwards. A quiz already attempted can't change its questions: Moodle refuses, and so does this. |
| addQuizSection | Adds a section to a quiz starting at a slot, with its heading and whether its questions are shuffled, as the edit page's "Add a new section heading" and its heading and shuffle controls do. A section starts at a page: the slot must be the first of its page (see setQuizPages). |
| addSection | Adds a section after another one (at the end without it), named when a name is given, with a description (HTML) when summary is, and embed's local files in it (<img src="shot.png">). |
| allocateMarker | Allocates a marker (the user id of someone who can grade; several where the assignment uses several markers per submission) to participants' submissions, as the grading table's "Allocate marker" does. Moodle leaves alone submissions past marking (marking completed, in review, ready for release, released). |
| anonymizeBackup | Writes to destFile a copy of a backup file (.mbz) that names no one and no site: no browser, no session. Every user id in its XML is 0 (files' owners, questions' creators, modifiers and owners…), every author's or issuer's name empty; the original site's address and identifier hash, the course's id and names, the file's name, the site's host in question stamps, the site's address in texts and the backup's log are replaced by neutral values (ANONYMOUS). The content (texts, settings, files) stays as it was; the numeric ids of the backup's pieces too, which only matter inside it. Moodle restores the copy as a backup from another site, wherever it's restored: the questions and files are the restoring person's, and links to activities left out of the backup point to the neutral site. Returns what was cleared. destFile may be file itself. A backup with users' data is refused: Moodle's own anonymization makes those (its anonymize setting). |
| answerChoice | Answers a choice with one option (several where it allows them) by id, as "Save my choice" does; returns the choice afterwards. |
| answerLessonPage | Answers the page the person is on: a content page's button (its label or position), or a question's fields by name. Returns Moodle's feedback when it gives one, and the page that follows, going on past the feedback as its "Continue" does; reaching the end ends the attempt. With the realistic trail it first takes the time a reader needs for the page (ADR-005). |
| answerQuizQuestions | Saves answers in an attempt in progress without finishing it, and gives its questions afterwards. With the realistic trail, it first takes the time a reader needs for the questions and their options (ADR-005), calling onProgress with the seconds elapsed and the total. |
| assessWorkshopSubmission | Assesses a submission as the person, through the workshop's assessment form (its grading strategy's: accumulative, comments, number of errors or rubric), as "Assess" on the submission's page and the form do: a teacher who hasn't assessed it yet gets an assessment of their own, and one already made is changed. criteria go in the form's order; feedback is the overall feedback for the author (HTML), where the workshop has it on; fields sets any other field of the form by name (weight…). Returns a sentence of what changed, the assessment's id, and the grade it gives the submission out of the workshop's grade. Throws WorkshopError outside the assessment phase, when a criterion's grade isn't one it takes, or when the workshop has no overall feedback; FormError when Moodle refuses the form (a criterion left without a grade). |
| assignmentSubmissions | Every participant's submission to an assignment, with the group they submit for (group submissions), and, unless includeContent is false, its content, the feedback files they have, its marking workflow state and markers (all from each participant's grading panel). Those come only for participants with a submission: Moodle's grading panel creates an empty one for a participant who has none, so reading leaves them at "none", without the panel's details (confirmed empirically on the sandbox, 5.2). For a participant with a submission and no grade yet, the panel still leaves an empty grade (-1, not graded) and a "Grading form viewed" event, as Moodle's grader does. Only some participants when given their userIds; with limit, a page of them in the grader's order (see "Long lists" in the docs' concepts): Moodle's service lists every participant at once, cut to the page, and only the page's participants are read further (their dates, their panels). |
| backgroundBrowser | The browser another process keeps open on profileDir (the moodle open command's), or undefined when there's none. A .browser.json left by a process that's gone is removed. |
| backupContents | What a backup file (.mbz) holds, read on this computer without restoring it, without a browser or a session: the Moodle that made it, the original site and course, its sections and activities (the original site's ids), the plugins a site needs to restore it, whether it holds people's data, and, per activity, what it refers to that the backup doesn't hold (restrictions on activities left out, links to them in its text, its grade category), which a restore elsewhere leaves broken. BackupError when the file isn't a Moodle backup (or is a zip-format one, which isn't read). |
| backupCourse | Backs a course up to a .mbz file, through Moodle's backup wizard (initial settings, schema, confirmation), and downloads it into destDir. Without users' data unless withUsers, which needs moodle/backup:userinfo (anonymize makes their names anonymous). An asynchronous backup is waited for up to timeoutMs (ten minutes). Moodle keeps the file in the course's or the person's backup area too. |
| calendarEvent | One calendar event by its id, as upcomingEvents gives them. |
| canShowWindow | Whether a window can be shown. On Linux it needs an X or Wayland display; without one (Docker, a server) the driver refuses rather than trying, so it never reaches a display it wasn't given. |
| checkLocalFiles | Local files given to upload (a submission, an attachment, a resource): absolute, and there. |
| completionReport | A course's progress report: every participant's completion of every activity that tracks it, page by page, in one group when given, only some people's when given their userIds (the report has no filter by user: its pages are read until all of them are found). People come as user id and full name only. |
| connectBrowserManager | A browser manager on a browser another process keeps open (backgroundBrowser), for a program to share it: it connects on first use, works in the browser's own context, and close() only disconnects, leaving the browser open. With a window, the pages functions open are followed in its first tab (ADR-007); it can't add or remove a window from a browser it didn't launch. |
| conversation | A conversation's messages, oldest first, as text, and its members as conversations() gives them: everyone but the person, whether they wrote in it or not (the person alone in their own conversation). With limit, messages is a page of them (see "Long lists" in the docs' concepts) counted from the newest: the first page is the latest messages, more says there are older ones, and each page's messages still come oldest first. Moodle's service returns only the page. |
| conversations | The person's conversations, latest first, with their last message as text. With limit, a page of them (see "Long lists" in the docs' concepts), the only ones Moodle's service returns. |
| copyCourse | Copies a course into a new one, as Moodle's "Copy course" does: its content (and its people's data and enrolments, withUsers), under a new full and short name, in a category (the course's unless given), with new dates. Goes through Moodle's copy service, then waits for the copy, which Moodle makes in its scheduled tasks, up to timeoutMs (ten minutes). Needs the rights to back up, restore and create courses (moodle/backup:backupcourse, moodle/restore:restorecourse, moodle/course:create); without them, BackupError says so. |
| courseAbilities | What the person can do in a course, asked of read-only services that need the capability: the activity types they can add (none without moodle/course:manageactivities) and the grader report's users (nopermissions without gradereport/grader:view). Nothing is changed. |
| courseActivityTypes | The activity and resource types the person can add to a course: none when they can't edit it. |
| courseLogs | A course's logs, newest first, as its logs report lists them: by a user, an activity, a kind of action, and a time span, up to limit entries (100 unless given). Moodle filters by user, activity and action; the span is read page by page, stopping at the first entry older than from. Every entry's time comes as an ISO date, read back with the site language's own format. Without limit, the first 100 entries (from offset) as a list; with it, a page of them (see "Long lists" in the docs' concepts), from the report's page that holds offset on (without until; with it, from the first page, since only the driver filters by it). |
| courseRoles | A user's roles in a course, from their profile there: role links carry the role id in any language. |
| courseStructure | A course's sections and activities; with details, each activity's dates and restriction and each section's description, from the course page (slower). |
| courseUpdates | What changed in a course's activities since a date, with their names from the course's state. |
| createActivity | Creates an activity or resource of any type at the end of a section, through Moodle's own form, hidden from students unless visibility says otherwise. files are local paths uploaded to a file resource or folder (a DraftUpload puts one in a folder's subfolder); a SCORM (type: "scorm") or an H5P activity (type: "h5pactivity") takes the first as its package. |
| createBrowserManager | A browser manager that launches the browser itself, in the persistent profile of config (ADR-002), on first use: nothing opens until a function needs the browser. It tries the installed browsers and, if allowed, downloads Chromium in the background (ADR-001). Its context() throws BrowserNotFoundError when no browser can be launched, BrowserDownloadingError while Chromium downloads, and NoDisplayError for a window without a screen. The other parameters are for tests. |
| createEvent | Creates a course event, through the calendar's own form: its start, and its duration and description when given. Returns it as the calendar has it. |
| createGroup | Creates a group in a course with its group form (group/group.php). Throws FormError with Moodle's reason when it refuses (a name already used, an enrolment key another group has). |
| createGrouping | Creates a grouping in a course with its form (group/grouping.php); add its groups with setGroupingGroups. |
| createMoodle | Works one Moodle site through a browser: give the site and the browser's options (or a browser manager), and optionally the defaults its calls use; then call the driver's operations as methods. |
| createQuestion | Creates one question in a bank through its type's edit form; returns its id. Imports are the way for several; this is for one-offs. |
| deadlines | What the person has to do by a date (calendar action events: submit, attempt, grade…), from the last pastDays to days ahead, in one course or all. Teachers' grading counts come from the activities overview instead: Moodle gives them few action events. |
| deleteActivity | Deletes an activity, with its participants' data (submissions, posts, attempts); gives the course afterwards. |
| deleteEvent | Deletes a calendar event the person can manage. |
| deleteGradeCategory | Deletes a grade category. Moodle moves what it held (items and categories) into its parent and deletes the grades of its total; the course's own category can't be deleted. |
| deleteGradeItem | Deletes a manual grade item and its grades. An activity's item goes with its activity (Moodle would make it again), so it's refused. |
| deleteGroup | Deletes a group, as the groups page's "Delete selected group" does once confirmed; its members stay in the course. |
| deleteGrouping | Deletes a grouping, as its delete icon does once confirmed; its groups stay. |
| deletePost | Deletes a post and its replies through Moodle's own confirmation (post.php?delete=); a discussion's first post takes the whole discussion. Only a moderator deletes a post with replies, or someone else's. replies says how many replies went with it. Throws ForumError with Moodle's reason when it refuses. |
| deleteQuestions | Deletes questions from a bank, every version of each, as the bank's delete action does: asked, then confirmed. Moodle doesn't delete a question a quiz uses: it hides it, and hidden lists those. |
| deleteSection | Deletes a section and every activity in it, with their participants' data. |
| discussion | A discussion's posts, oldest first, with their messages as text, and whether the person is subscribed to it (subscribed, undefined where they can't subscribe or it's forced). With limit, posts is a page of them (see "Long lists" in the docs' concepts): Moodle's service has no paging, so every post is read and cut, but only the page's messages are turned into text. |
| downloadFile | Saves a file of the site into destDir with the person's session, never overwriting. Only URLs of the site's origin: the session's cookies go nowhere else (its media outside Moodle's path included). |
| duplicateActivity | Duplicates an activity as the course page's "Duplicate" does (right after it, named with "(copy)"); gives the copy's id and the course afterwards. |
| editActivity | Renames, shows or hides, or moves an activity (to a section's end, or before another one). |
| editPost | Changes a post through Moodle's own post form (post.php?edit=), as its author (within the site's editing time) or a moderator: only what's given changes. Returns the post afterwards. Throws ForumError with Moodle's reason when it refuses. |
| editQuizSlot | Changes one slot of a quiz (by its place, from 1): its maximum mark, through the slots' service, and where it is, as dragging it on the edit page does: after another slot (moveAfter, 0 for first) and on a page. Moodle lets the mark change after attempts (it regrades them), not the rest. |
| editSection | Renames, shows or hides, describes (summary, HTML, with embed's local files in it), restricts (restrictions; { conditions: [] } removes them) or moves a section after another one. |
| enrolmentMethods | A course's enrolment methods, in the order Moodle tries them: each one's type, name, whether it's enabled and how many users it enrolled, and from its form the role it gives and, for self enrolment and guest access, whether it asks for a key (never the key), self enrolment's dates and limit. Throws EnrolmentError when the person can't manage the course's enrolment methods. |
| enrolUsers | Enrols users in a course by manual enrolment, as the participants page's "Enrol users" dialog does: with roleId or the enrolment's default role, from start (now, unless given) until end (the enrolment's default duration, unless given). Users already enrolled keep their enrolment, with the new dates. Throws EnrolmentError with Moodle's reason when it refuses (a role the person can't assign, no manual enrolment). |
| exportGrades | Saves a course's grades into destDir as Moodle exports them for a teacher: a spreadsheet (xlsx, ods), comma-separated text (csv) or XML, with the items, group, display and feedback chosen as in the export form. Returns the file as downloadFile does (never overwriting one). Throws GradebookError when the site has that format's export plugin disabled (naming the ones it has), when an item isn't in the course, or when Moodle refuses the export. |
| findMoodleSite | The site's base URL for any URL of it (the site, a course, the login page), read from the M.cfg.wwwroot Moodle puts in every page; fetched without the browser or any session. Throws MoodleUrlError when it can't be reached or isn't a Moodle. |
| finishQuizAttempt | Submits an attempt for grading, and gives its review when the quiz shows it. |
| forumDiscussions | A forum's discussions, as its page lists them: who started each, replies, last post, the person's subscription. With limit, a page of them in the forum's order (see "Long lists" in the docs' concepts), read from the one page of the forum's own paging that holds it. |
| forumGrades | Everyone's whole-forum grade in a forum graded as a whole, as its grader shows them: one per person it can grade (only the active ones when the forum says so), with how it's graded. One service call per person. Throws NotAForumError for another activity, and GradingError when the forum isn't graded as a whole or uses an advanced grading method. |
| getChoice | A choice: its options, whether it can be answered or changed, and the person's answer. |
| getSurvey | A survey (questionnaire or feedback): whether it can be answered, its intro and messages, and its questions page by page. Its module is found when not given. |
| gradebookSetup | A course's gradebook setup: its categories (aggregation, weights) and grade items (category, maximum, weight). |
| gradeForumUser | Gives a person their whole-forum grade, as the forum's grader does: points (out of the forum's maximum), or a scale item by name or value; null takes the grade away. Moodle's forum grader has no feedback text. notify sends the person Moodle's notification, as the grader's checkbox does. Returns a sentence of what changed and the grade afterwards. Throws GradingError when the forum isn't graded as a whole, the grade is out of range or not on the scale, or Moodle refuses it. |
| gradeQuizQuestion | Grades one question of a finished attempt by hand, with a comment, through Moodle's comment form (the review's "Make comment or override mark"): an essay waiting for grading, or any question whose mark the teacher overrides. The mark is in the question's points (0 to its maximum in the quiz). Returns the attempt's grade afterwards when the results report shows it. |
| graderReport | Everyone's grades in a course as the grader report shows them, page by page, in one group when given, only some people's rows when given their userIds (the report has no filter by user: its pages are read until all of them are found). People come as user id and full name only. |
| gradeSubmission | Grades a participant as the grader does: a grade (simple grading), a rubric's level per criterion or a marking guide's score per criterion (by their ids, from rubric()), remarks per criterion, feedback comments (HTML), feedback files (local paths that replace the ones the participant has; [] removes them), whether to notify, and any other grading field by name. Returns the grade saved and the gradebook's grade, the total Moodle computes for a rubric or a guide, and the feedback files after saving when they were given. Throws GradingError when Moodle refuses the grade, or when files are given to an assignment without feedback files. |
| grantExtension | Grants participants an extension until a date, through the assignment's extension form (several at once as its bulk action does). Moodle refuses a date before the assignment's due date, and a person without its "grant extension" capability only on saving (the form opens for anyone, confirmed empirically on the sandbox, 5.2): both throw. |
| groupings | A course's groupings with their groups' ids, from its groupings page and each grouping's groups page. Throws MoodleError with Moodle's refusal for a person who can't manage groups. |
| groups | A course's groups the person can see, with their members' user ids. |
| h5pActivity | An H5P activity: its content type, whether attempts are tracked, and the person's attempts with their scores. |
| importActivities | Imports activities from another course into a course, as Moodle's "Import" does: every activity of fromCourseId, or only activityIds, added to toCourseId's content (with their sections), without users' data. Needs moodle/restore:restoretargetimport in the course imported into and moodle/backup:backuptargetimport in the other. Returns the activities the course has afterwards that it didn't have before, by id. |
| importQuestions | Imports questions into a bank from a GIFT or Moodle XML file (a local path) or text, through the bank's import form; returns the questions created. A file Moodle can't parse comes back as a QuestionBankError with its messages, and nothing is imported. |
| lessonPage | The lesson page the person is on (starting the lesson the first time). |
| listAssignments | The course's assignments, in the course's order, with the section each is in. |
| listCourses | The courses the person is enrolled in, as teacher or student. |
| logIn | Makes sure there's a session: the user at once if there is one; otherwise a browser window at the site's login page, waiting (calling onWait) until the person logs in there themselves. The session is saved (ADR-003), and the window closes again unless the browser is shown on demand. It waits timeoutMs, 5 minutes by default. |
| logOut | Logs the person out of Moodle through the user menu's logout link (it carries the sesskey; without one Moodle asks to confirm, and the confirmation is accepted). Returns false when nobody was logged in. Only Moodle's session ends: a single sign-on provider may keep its own. |
| markNotificationsRead | Marks all the person's notifications read, as the popover's "Mark all as read" does; doing it twice changes nothing. |
| messageParticipants | Sends one message to several participants of a course, as the participants page's "Send a message" does for the users selected: one private message each, in one call. They are userIds, or the participants participants() chooses with role, group and inactiveSince (all of them when none is given), the person left out. sentTo lists exactly who got it, refused who Moodle didn't write to and why (they blocked the person, their privacy settings); someone who may message any user (a teacher, moodle/site:messageanyuser) gets through a block, as in Moodle's own page (confirmed empirically, Moodle 5.2). Throws MessageError for an empty message or nobody to write to, NoParticipantsError when the person can't see the course's participants. |
| moduleCategories | The data a teacher reads when reading an activity of module with everything in it: course content alone for what teachers make (pages, books, files…), also others' personal data where participants leave work or responses. An unknown module (a plugin) could hold anything: any. |
| myGrades | The person's own grade report for a course. |
| notifications | The person's notifications, newest first, only the unread ones when asked. With limit, a page of them (see "Long lists" in the docs' concepts): Moodle's service gives only the page, or, for the unread ones, batches until the page is full (it has no unread filter). |
| openScorm | Opens a SCORM in Moodle's player, in normal mode, on the browser's working tab (ADR-007), for the person (or a program driving the tab) to do it there: the last attempt continues unless newAttempt, at the activity's first SCO unless scoId. Resolves once the SCO's frame has loaded. Opening the player is what starts an attempt in Moodle. |
| overrideCompletion | Sets someone's completion of an activity as a teacher does from the progress report; returns the state saved. |
| parseSiteUrl | A Moodle site's base URL, normalized: http(s), no query or fragment, a trailing slash. |
| participantFilters | The roles and groups the participants page filters by in a course (its filters' options), as the person may use them: every group, or only their own in a course with separate groups. "No roles" and "no group" left out. |
| participants | A course's participants with their roles and groups, as the participants page lists them: only those with a role (its id), in a group, or (inactiveSince) who haven't accessed the course since that date, when asked. Each role and group is a filter of its own, so ids come in any language. With limit, a page of them in the page's order, by last name (see "Long lists" in the docs' concepts): the one page of the table's own paging that holds it; the roles' and groups' members are still read whole, to tell each one's. |
| participationReport | Who took part in an activity of a course, as its participation report counts it: everyone with the role (every role the report offers, unless roleId), with how many actions they made there (views or posts only, when action; since since, when given); those who did nothing come with 0. |
| pendingActivities | What the person still has to do in a course: activities whose completion is tracked and not complete or, where completion isn't tracked, graded activities without a grade yet. |
| potentialUsers | Users the person may enrol in a course by manual enrolment, matching search anywhere in their name or the identity fields the site shows (all of them, a page of up to 100, when empty), as the "Enrol users" dialog finds them. Throws EnrolmentError when the course has no manual enrolment the person can use. |
| publicSiteInfo | What the site tells anyone about itself, through Moodle's AJAX entry point for services that need no login (service-nologin.php): readable before logging in, without the browser. Moodle shows its version only to administrators, so it isn't here. |
| questionBanks | A course's question banks: its shared ones and the activities' own, as the banks page lists them. |
| questions | A bank's categories and every question in them, category by category. With limit, questions is a page of them in that order (see "Long lists" in the docs' concepts), the categories all: the bank is read category by category until the page is full, each category whole and cut (its page counts aren't reliable enough to skip by). |
| questionsToGrade | The questions of a quiz that wait for grading by hand (essays…), as its manual grading report lists them, each with the finished attempts whose answer requires grading (from the results report). People as user id and full name. |
| quizInfo | A quiz's page as the person sees it: its description and dates, the person's attempts with their summary, and whether they can start one. |
| quizResults | A quiz's attempts as its grades report shows them: per attempt the user, state, dates, grade and the mark per question; with responses, also the answer per question from the responses report. Every page of the report; with limit, attempts is a page of them in the report's order (see "Long lists" in the docs' concepts), read from the one page of the report's own paging that holds it. |
| quizStructure | A quiz's questions as its edit page lists them: slots with their page, question, type, name and mark, and its sections. |
| rate | Rates a forum post, a glossary entry or a database record as the person, as the rating menu under it does: by a scale item's name, or its number (the points of a point scale). null takes the person's rating away. Returns a sentence of what changed and the item's aggregate afterwards (as Moodle shows it, by the activity's aggregation) with the number of ratings. Throws GradingError when the item has no rating menu for the person (ratings off, their own item, outside the rating period, or no permission) or the rating isn't on its scale. |
| readAttempt | Every question of an attempt, page by page, with the page each is on. |
| readReview | A finished attempt's review, as far as the quiz's review options let the person see it. |
| removeQuizSlot | Removes a slot (by its place, from 1) from a quiz, as the edit page's delete icon does; the question stays in its bank. |
| replyToPost | Replies to a post; returns the new post's id and its discussion's, and, when subscribe is given, the person's subscription to the discussion afterwards, read back (subscribed). |
| resetCourse | 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. |
| restoreCourse | Restores a backup file (.mbz) through Moodle's restore wizard: into a new course in a category (into: "new", with categoryId, which needs moodle/course:create there), or into an existing course (into: <course id>), its content added to the course's (mode: "merge", the default) or replacing it ("replace": the course's content is deleted first). A new course takes the backup's names unless fullName and shortName are given. Users' data is restored when withUsers and the backup has it. An asynchronous restore is waited for up to timeoutMs (ten minutes). Needs moodle/restore:restorecourse where it restores. |
| rubric | An assignment's grading method and, for a rubric or a marking guide, its criteria with the ids gradeSubmission takes: read from the grader's panel for the first participant with a submission. Where nobody has one yet, the panel is the first participant's, and Moodle creates an empty submission ("new") for them on opening it. |
| saveSubmission | Saves the submission's online text and adds files, as "Save changes" on the edit page does; gives the assignment afterwards. |
| scorm | A SCORM activity as the person sees it: its attempts (allowed and made), the grading method, the grade reported and each attempt's, and its SCOs with the person's status and score in the last attempt. Moodle doesn't show a SCORM's version on its page: openScorm tells it. |
| sendMessage | Sends a private message to a user, as the messaging drawer does; returns the message and its conversation. |
| setCompletion | Marks the person's own completion of an activity with manual completion, done or not, as its "Mark as done" button does; doing it twice changes nothing. An activity that completes on its own gives a CompletionError. |
| setDiscussionState | Pins or unpins, locks or unlocks a discussion, as the discussion list's menu does; what's already so is left alone. Returns the discussion as the forum lists it afterwards. |
| setDiscussionSubscription | Subscribes the person to a discussion or unsubscribes them, as the discussion list's toggle does (mod_forum_set_subscription_state); what's already so is left alone. Returns the discussion as the forum lists it afterwards. |
| setEnrolmentMethod | Sets an enrolment method: by id, or the course's first method of a type ({ type: "self" }), added when the course has none and the "Add method" menu offers it. Only what's given changes. enabled goes through the methods page's enable and disable icons, the rest through the method's form: what Moodle lets the person change differs by method (an editing teacher can't configure manual enrolment, enrol/manual:config, so neither switch it nor set its role). Returns the method afterwards. Throws EnrolmentError for a method the course doesn't have or can't add, and for a setting Moodle doesn't let the person change (naming it); FormError with Moodle's reason when it refuses the form (a key required by the site, an end before the start). |
| setGrade | Sets a person's grade in a grade item through the gradebook's single view report, as a teacher does there: a manual item takes the grade; an activity's or a category's is overridden (Moodle keeps the override until it's taken off with override: false). Feedback and excluding from the totals go the same way. Returns a sentence of what changed and the grade afterwards. Throws GradebookError when the item or the person isn't in the course's gradebook, the grade is locked, or Moodle refuses the value (out of range, a scale item it doesn't have). |
| setGroupingGroups | Makes a grouping's groups exactly groupIds, as its groups page adds and removes them. Groups of other courses aren't offered there and are left out, named in changed. Returns the groups afterwards. |
| setGroupMembers | Adds and removes a group's members (user ids), as its members page does. Only the course's participants can be added: ids the page doesn't offer (not enrolled, or already members) and members not in it are left as they were and named in changed. Returns the members afterwards. |
| setQuestionStatus | Sets a question ready (quizzes can use it) or draft, as the bank's status menu does, through its service. |
| setQuizOverride | Sets a user override on a quiz, through its override form: other opening and closing dates, a time limit in minutes, or a number of attempts (0 unlimited); what isn't given stays the quiz's. |
| setQuizPages | Sets a quiz's pages: perPage questions a page (0 for all on one), as the edit page's "Repaginate" does, or page breaks exactly after the given slots (and nowhere else), as its page break icons do one by one. |
| setUserRoles | Sets a user's roles in a course, as the participants page's roles column does: gives the roles in roleIds the person may assign, and takes away the others the person may assign. Roles the person can't assign that the user already holds, and those from elsewhere (a category, an enrolment that protects them), stay. Returns the user's roles afterwards, as that column shows them. Throws EnrolmentError with Moodle's reason for a role the person can't assign or a user not enrolled. |
| setWorkflowState | Sets the marking workflow state of participants' submissions, as the grading table's "Set marking workflow state" does; "released" shows them their grades, notifying them when notify is true (the form's default is not to). With several markers, it sets the submission's overall state. |
| setWorkshopPhase | Switches a workshop to a phase, as its page's phase links do, confirming Moodle's question (any phase, forwards or back; Moodle allocates nothing and calculates no grades on its own when it switches). Returns a sentence of what changed and the phase afterwards. Throws WorkshopError when the person can't switch the workshop's phases (Moodle's mod/workshop:switchphase, a teacher's) or the id isn't a workshop's. |
| siteName | The site's name, from its public settings; undefined where the mobile app support is off. |
| siteProfileDir | The browser profile folder the moodle command uses for an account on a site: sites/<host>/profiles/<as>. Without as, the site's default (the account last logged in with, named in its site.json); MoodleError with code not-found when the command hasn't logged in to the site. Pass it as profileDir to share the command's session; home is ~/.moodle-driver unless given. |
| startDiscussion | Starts a discussion in a forum; returns its id, and whether it's pinned and the person subscribed to it, as the forum lists it afterwards, so one call confirms what subscribe and fields set. |
| startQuizAttempt | Starts an attempt, or continues the one in progress, and gives its questions. |
| studentAssignment | An assignment as the student sees it: its description and files, dates, the submission's status and files, the feedback, and whether it can be edited or submitted now. |
| submitForGrading | Submits the saved submission for grading, accepting the site's statement when it asks for one (acceptStatement, once the person agrees; a bare boolean as before 0.2 too); gives the assignment afterwards. |
| submitSurvey | Fills the survey page by page with responses (field name → value) and submits it on the last page. Every name is checked against the form first, so nothing is sent with a wrong one. |
| unenrolUser | Unenrols a user from a course: removes every enrolment of theirs the person may remove (its unenrol link on the participants page), with their roles and group memberships in the course, as that link does. changed and removed say which ones (by enrolment method's name), kept those the person may not remove (a cohort sync, another teacher's method). Throws EnrolmentError when the user isn't enrolled. |
| upcomingEvents | The person's upcoming events, as the calendar's "Upcoming events" view lists them, in one course or all. |
| updateActivity | Changes an existing activity through its form: only what's given changes. A file resource's or folder's files stay as they are unless files says what to add, remove or replace. |
| updateCourse | Changes a course's full name, short name, summary (HTML) or any other setting by its form field name, through the course's settings form; returns the course as listCourses gives it. embed takes local files the summary names (<img src="shot.png">), put in it as Moodle's editor does. Moodle's refusals (a short name already taken) come back as FormError by field. |
| updateEvent | Changes a calendar event through the calendar's own form, opened on it: only what's given changes. A new start keeps the event's length unless a new one is given. Returns the event as the calendar has it afterwards. |
| updateGradeCategory | Changes a grade category: its name, its aggregation, its weight in its parent (percent, overriding Natural's automatic one), or moves it into another category. Returns the category afterwards. |
| updateGradeItem | Changes a grade item: moves it into a category, sets its weight (percent, overriding Natural's automatic one), or its maximum grade (a manual item's; an activity's is set in the activity). Returns the item afterwards. |
| updateGroup | Changes a group's name, description, ID number or enrolment key with its form; what isn't given stays. |
| updateQuestion | Changes a question of a bank through its type's edit form, with the same inputs as createQuestion and only what's given (answers replaces them all). Saving makes a new version of the question, with an id of its own: the one returned, which quizzes using the latest version get from then on. |
| userById | A user by id, or undefined when there's nobody: no such user, one the person may not see, or a deleted account. Moodle keeps a deleted account's record and its user service still gives it to an administrator, renamed, with the email replaced by an MD5 hash of the old username (delete_user, confirmed empirically on the sandbox, 5.2); the driver treats it as gone. |
| whoAmI | Who the logged-in person is; with courseId, also their roles and abilities in that course. |
| workshopInfo | A workshop's phase, and its report as the workshop's page shows it to a teacher: every submission (its author, title, and grade once calculated) and every assessment (reviewer, the submission's author, the grade it gives, its weight, the grade for assessing once calculated), all of its pages. The report is Moodle's own: it shows from the submission phase on to those who can see every submission, in the course's current group; for anyone else the lists are empty. Grades are out of the workshop's grade for submission, as Moodle shows them. Throws WorkshopError for an activity that isn't a workshop the person can view. |