Interface: ParticipantOptions
Defined in: areas/participants/participants.ts:192
What participants takes: who (a role, a group, inactive since a date), and a page of them.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
group? | number | Only those in this group (its id). | - | areas/participants/participants.ts:196 |
inactiveSince? | Date | Only those who haven't accessed the course since this date. | - | areas/participants/participants.ts:198 |
limit? | number | How many items to return (1 or more): with it, the list comes as a ListPage; without it, every item, as a plain list. | PageOptions.limit | core/paging.ts:9 |
offset? | number | How many items to skip first, in the function's own order: 0 unless given. | PageOptions.offset | core/paging.ts:11 |
role? | number | Only those with this role (its id). | - | areas/participants/participants.ts:194 |