Interface QueryOptions

Hierarchy

Properties

datetimeFilter? filter? filterBy? 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 on which to run the filter. To know which fields are valid fields for the particular query, consult the official API reference docs for the targeted method (eg, GetCourses), or see the client documentation for the method that overrides this interface (eg, CourseQueryOptions)

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. To know which fields are valid fields for the particular query, consult the official API reference docs for the targeted method. (eg, GetRegistrations), or see the client documentation for the method that overrides this interface (eg, RegistrationQueryOptions)

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