QueryFilter interface

  • Reference
Package:
azure-devops-extension-api

A filter used to define a set of extensions to return during a query.

Properties

criteria

The filter values define the set of values in this query. They are applied based on the QueryFilterType.
direction

The PagingDirection is applied to a paging token if one exists. If not the direction is ignored, and Forward from the start of the resultset is used. Direction should be left out of the request unless a paging token is used to help prevent future issues.
pageNumber

The page number requested by the user. If not provided 1 is assumed by default.
pageSize

The page size defines the number of results the caller wants for this filter. The count can't exceed the overall query size limits.
pagingToken

The paging token is a distinct type of filter and the other filter fields are ignored. The paging token represents the continuation of a previously executed query. The information about where in the result and what fields are being filtered are embedded in the token.
sortBy

Defines the type of sorting to be applied on the results. The page slice is cut of the sorted results only.
sortOrder

Defines the order of sorting, 1 for Ascending, 2 for Descending, else default ordering based on the SortBy value

Property Details

criteria

The filter values define the set of values in this query. They are applied based on the QueryFilterType.

criteria: FilterCriteria[]

Property Value

FilterCriteria[]

direction

The PagingDirection is applied to a paging token if one exists. If not the direction is ignored, and Forward from the start of the resultset is used. Direction should be left out of the request unless a paging token is used to help prevent future issues.

direction: PagingDirection

Property Value

PagingDirection

pageNumber

The page number requested by the user. If not provided 1 is assumed by default.

pageNumber: number

Property Value

number

pageSize

The page size defines the number of results the caller wants for this filter. The count can't exceed the overall query size limits.

pageSize: number

Property Value

number

pagingToken

The paging token is a distinct type of filter and the other filter fields are ignored. The paging token represents the continuation of a previously executed query. The information about where in the result and what fields are being filtered are embedded in the token.

pagingToken: string

Property Value

string

sortBy

Defines the type of sorting to be applied on the results. The page slice is cut of the sorted results only.

sortBy: number

Property Value

number

sortOrder

Defines the order of sorting, 1 for Ascending, 2 for Descending, else default ordering based on the SortBy value

sortOrder: number

Property Value

number