Interface CourseQueryOptions

Hierarchy

Properties

datetimeFilter? filter? filterBy? includeCourseMetadata? includeRegistrationCount? more? orderBy? scope? since? tags? until?

Properties

Optional datetimeFilter

datetimeFilter?: DateFilterField

Specifies field that since and until parameters (see DateFilter) are applied to

Optional filter

filter?: string

Optional string which filters results by a specified field, described by filterBy

Optional filterBy

filterBy?: string

Optional parameter for specifying the field and order by which to sort the results. Valid values are :

  • tags
  • title
  • course_id

Optional includeCourseMetadata

includeCourseMetadata?: boolean

Include course metadata in the results. If the course has no metadata, adding this parameter has no effect. Default value : false

Optional includeRegistrationCount

includeRegistrationCount?: boolean

Include the registration count in the results. Default value : false

Optional more

more?: string

A pagination token that was returned on the more property of paginated requests. If there are more results to be collected, the token can be provided here to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.

Optional orderBy

orderBy?: string

Optional parameter for specifying the field and order by which to sort the results. Valid values are :

  • created_asc
  • created_desc
  • updated_asc
  • updated_desc
  • title_asc
  • title_desc

Optional scope

scope?: string

The auth scope to use for the given method invocation

Optional since

since?: string

Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

Optional tags

tags?: string[]

Filter items matching ANY tag provided (not ALL)

Optional until

until?: string

Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

Settings

Member Visibility

Theme

Generated using TypeDoc