Skip to main content

Interface: EnrolmentMethodSettings

Defined in: areas/participants/methods.ts:33

What setEnrolmentMethod may change; what isn't given stays.

Properties​

PropertyTypeDescriptionDefined in
enabled?boolean-areas/participants/methods.ts:34
end?Date | null-areas/participants/methods.ts:39
key?stringSelf enrolment and guest access: the key to ask for; "" removes it.areas/participants/methods.ts:36
maxUsers?numberSelf enrolment: the most users it enrols; 0 for no limit.areas/participants/methods.ts:43
roleId?numberThe role it gives (manual and self enrolment).areas/participants/methods.ts:41
start?Date | nullSelf enrolment: from when and until when students may enrol; null removes the limit.areas/participants/methods.ts:38
welcome?string | falseManual and self enrolment: the welcome message to send (from the course contact unless another sender is set); false sends none.areas/participants/methods.ts:45