Function: potentialUsers()

function potentialUsers(
   context, 
   siteUrl, 
   courseId, 
   search?
): Promise<PotentialUser[]>;

Defined in: areas/participants/enrolments.ts:73

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.

Parameters

Parameter	Type	Default value
context	BrowserContext	undefined
siteUrl	string	undefined
courseId	number	undefined
search	string	""

Returns

Promise<PotentialUser[]>