Skip to main content

Module listing

Expand description

Enrolment discovery’s per-module listing: which modules a roster request covers, and what the last listing of each found.

Structs§

ModuleDiscoveryReport
One active module’s counters from its last successful discovery run, and whether the attempts since then have been failing. Point-in-time, not a windowed sum: the phase overwrites the row whole, so every surface rendering them has to say so.
ModuleListingOutcome
Outcome counters for one enrolment-discovery run over one module. Written whole, so the dashboard never mixes two runs.
ModuleToList
An active module and the facts a list-by-course request for it needs.

Functions§

get_active_discovery_reports
Every active module’s last discovery counters, for the account-linking dashboard.
get_active_modules_for_course
Every active, listable module of one course, unpaginated.
mark_listing_failed
Records a listing attempt whose roster never arrived. last_listed_at and the counters keep describing the last roster that did, because zeroing them would make a failed listing read as an empty course.
mark_listing_succeeded_without_linking
Records a listing whose roster arrived while account linking is switched off: clears the failure streak, but leaves last_listed_at and the counters describing the last run that fed linking. Sibling of record_listing_outcome.
record_listing_outcome
Records a listing whose roster arrived: overwrites every counter and clears the failure streak. Sibling of mark_listing_failed.