Поделиться через

QueryFilter interface

  • Ссылка
Пакет:
azure-devops-extension-api

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

Свойства

criteria

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

Объект PagingDirection применяется к токену разбиения по страницам, если он существует. В противном случае направление игнорируется, и используется параметр Forward с начала набора результатов. Направление следует исключить из запроса, если маркер разбиения по страницам не используется для предотвращения будущих проблем.
pageNumber

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

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

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

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

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

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

criteria

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

criteria: FilterCriteria[]

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

FilterCriteria[]

direction

Объект PagingDirection применяется к токену разбиения по страницам, если он существует. В противном случае направление игнорируется, и используется параметр Forward с начала набора результатов. Направление следует исключить из запроса, если маркер разбиения по страницам не используется для предотвращения будущих проблем.

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