Interface: EnrolmentMethod
Defined in: areas/participants/methods.ts:12
One of a course's enrolment methods, as its methods page and its form show it.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
enabled | boolean | - | areas/participants/methods.ts:18 |
end? | string | - | areas/participants/methods.ts:27 |
hasKey? | boolean | Self enrolment and guest access: whether it asks for a key (the key itself isn't returned). | areas/participants/methods.ts:24 |
id | number | - | areas/participants/methods.ts:13 |
maxUsers? | number | Self enrolment: the most users it enrols. | areas/participants/methods.ts:29 |
name | string | Its name on the methods page, in the site's language ("Self enrolment (Student)"). | areas/participants/methods.ts:17 |
roleId? | number | The role it gives (manual: the default role; self: the role students get). | areas/participants/methods.ts:22 |
start? | string | Self enrolment: when students may enrol from and until (ISO dates). | areas/participants/methods.ts:26 |
type | string | The enrolment plugin: "manual", "self", "guest", "cohort"… | areas/participants/methods.ts:15 |
users | number | Users enrolled by it. | areas/participants/methods.ts:20 |