Function: participants()

Call Signature

function participants(
   context, 
   siteUrl, 
   courseId, 
   options
): Promise<ListPage<Participant>>;

Defined in: areas/participants/participants.ts:161

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.

Parameters

Parameter	Type
context	BrowserContext
siteUrl	string
courseId	number
options	WithLimit<ParticipantOptions>

Returns

Promise<ListPage<Participant>>

Call Signature

function participants(
   context, 
   siteUrl, 
   courseId, 
   options?
): Promise<Participant[]>;

Defined in: areas/participants/participants.ts:162

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.

Parameters

Parameter	Type
context	BrowserContext
siteUrl	string
courseId	number
options?	WithoutLimit<ParticipantOptions>

Returns

Promise<Participant[]>

Call Signature

function participants(
   context, 
   siteUrl, 
   courseId, 
   options?
): Promise<
  | ListPage<Participant>
| Participant[]>;

Defined in: areas/participants/participants.ts:163

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.

Parameters

Parameter	Type
context	BrowserContext
siteUrl	string
courseId	number
options?	ParticipantOptions

Returns

Promise< | ListPage<Participant> | Participant[]>