QueryFilter interface

Pakiet:

azure-devops-extension-api

Filtr używany do definiowania zestawu rozszerzeń, które mają być zwracane podczas zapytania.

Właściwości

criteria	Wartości filtru definiują zestaw wartości w tym zapytaniu. Są one stosowane na podstawie elementu QueryFilterType.
direction	Element PagingDirection jest stosowany do tokenu stronicowania, jeśli istnieje. Jeśli nie kierunek jest ignorowany, a opcja Prześlij dalej od początku zestawu wyników jest używana. Kierunek powinien zostać pominięty w żądaniu, chyba że token stronicowania jest używany do zapobiegania przyszłym problemom.
pageNumber	Numer strony żądany przez użytkownika. Jeśli nie podano wartości 1, przyjmuje się domyślnie.
pageSize	Rozmiar strony definiuje liczbę wyników, których obiekt wywołujący chce dla tego filtru. Liczba nie może przekroczyć ogólnych limitów rozmiaru zapytania.
pagingToken	Token stronicowania jest odrębnym typem filtru, a inne pola filtru są ignorowane. Token stronicowania reprezentuje kontynuację wcześniej wykonanego zapytania. Informacje o tym, gdzie w wyniku i jakie pola są filtrowane, są osadzone w tokenie.
sortBy	Definiuje typ sortowania do zastosowania w wynikach. Wycinek strony jest wycinany tylko posortowanych wyników.
sortOrder	Definiuje kolejność sortowania, 1 dla wartości Rosnąco, 2 dla malejącego, a w przeciwnym razie domyślną kolejność na podstawie wartości SortBy

Szczegóły właściwości

criteria

Wartości filtru definiują zestaw wartości w tym zapytaniu. Są one stosowane na podstawie elementu QueryFilterType.

criteria: FilterCriteria[]

Wartość właściwości

FilterCriteria[]

direction

Element PagingDirection jest stosowany do tokenu stronicowania, jeśli istnieje. Jeśli nie kierunek jest ignorowany, a opcja Prześlij dalej od początku zestawu wyników jest używana. Kierunek powinien zostać pominięty w żądaniu, chyba że token stronicowania jest używany do zapobiegania przyszłym problemom.

direction: PagingDirection

Wartość właściwości

PagingDirection

pageNumber

Numer strony żądany przez użytkownika. Jeśli nie podano wartości 1, przyjmuje się domyślnie.

pageNumber: number

Wartość właściwości

number

pageSize

Rozmiar strony definiuje liczbę wyników, których obiekt wywołujący chce dla tego filtru. Liczba nie może przekroczyć ogólnych limitów rozmiaru zapytania.

pageSize: number

Wartość właściwości

number

pagingToken

Token stronicowania jest odrębnym typem filtru, a inne pola filtru są ignorowane. Token stronicowania reprezentuje kontynuację wcześniej wykonanego zapytania. Informacje o tym, gdzie w wyniku i jakie pola są filtrowane, są osadzone w tokenie.

pagingToken: string

Wartość właściwości

string

sortBy

Definiuje typ sortowania do zastosowania w wynikach. Wycinek strony jest wycinany tylko posortowanych wyników.

sortBy: number

Wartość właściwości

number

sortOrder

Definiuje kolejność sortowania, 1 dla wartości Rosnąco, 2 dla malejącego, a w przeciwnym razie domyślną kolejność na podstawie wartości SortBy

sortOrder: number

Wartość właściwości

number