QueryFilter interface

Пакет:

azure-devops-extension-api

Фильтр, используемый для определения набора расширений, возвращаемых во время запроса.

Свойства

criteria	Значения фильтра определяют набор значений в этом запросе. Они применяются на основе QueryFilterType.
direction	PagingDirection применяется к маркеру разбиения по страницам, если он существует. Если направление не игнорируется, и используется переадресация с начала набора результатов. Направление должно быть оставлено вне запроса, если маркер разбиения по страницам не используется для предотвращения будущих проблем.
pageNumber	Номер страницы, запрошенный пользователем. Если значение не указано 1, предполагается по умолчанию.
pageSize	Размер страницы определяет количество результатов, которые вызывающий объект хочет для этого фильтра. Число не может превышать общие ограничения размера запроса.
pagingToken	Маркер разбиения по страницам — это отдельный тип фильтра, а другие поля фильтров игнорируются. Маркер разбиения по страницам представляет продолжение ранее выполненного запроса. Сведения о том, где в результате и какие поля фильтруются, внедрены в маркер.
sortBy	Определяет тип сортировки, применяемый к результатам. Срез страницы вырезает только отсортированные результаты.
sortOrder	Определяет порядок сортировки, 1 для возрастания, 2 для убывания, а также порядок по умолчанию на основе значения SortBy

Сведения о свойстве

criteria

Значения фильтра определяют набор значений в этом запросе. Они применяются на основе QueryFilterType.

criteria: FilterCriteria[]

Значение свойства

FilterCriteria[]

direction

PagingDirection применяется к маркеру разбиения по страницам, если он существует. Если направление не игнорируется, и используется переадресация с начала набора результатов. Направление должно быть оставлено вне запроса, если маркер разбиения по страницам не используется для предотвращения будущих проблем.

direction: PagingDirection

Значение свойства

PagingDirection

pageNumber

Номер страницы, запрошенный пользователем. Если значение не указано 1, предполагается по умолчанию.

pageNumber: number

Значение свойства

number

pageSize

Размер страницы определяет количество результатов, которые вызывающий объект хочет для этого фильтра. Число не может превышать общие ограничения размера запроса.

pageSize: number

Значение свойства

number

pagingToken

Маркер разбиения по страницам — это отдельный тип фильтра, а другие поля фильтров игнорируются. Маркер разбиения по страницам представляет продолжение ранее выполненного запроса. Сведения о том, где в результате и какие поля фильтруются, внедрены в маркер.

pagingToken: string

Значение свойства

string

sortBy

Определяет тип сортировки, применяемый к результатам. Срез страницы вырезает только отсортированные результаты.

sortBy: number

Значение свойства

number

sortOrder

Определяет порядок сортировки, 1 для возрастания, 2 для убывания, а также порядок по умолчанию на основе значения SortBy

sortOrder: number

Значение свойства

number