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 QueryFilterType.
direction	Właściwość PagingDirection jest stosowana do tokenu stronicowania, jeśli taki istnieje. Jeśli nie, kierunek jest ignorowany i używany jest Naprzód od początku zestawu wyników. Kierunek powinien zostać pominięty w żądaniu, chyba że token stronicowania jest używany w celu zapobiegania przyszłym problemom.
pageNumber	Numer strony żądany przez użytkownika. Jeśli nie zostanie podany, domyślnie przyjmowana jest wartość 1.
pageSize	Rozmiar strony określa liczbę wyników, które obiekt wywołujący chce uzyskać 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	Określa typ sortowania, który ma być stosowany do wyników. Wycinek strony jest wycinany tylko z posortowanych wyników.
sortOrder	Definiuje kolejność sortowania, 1 dla rosnącej, 2 dla malejącej, w przeciwnym razie domyślna kolejność oparta na 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 QueryFilterType.

criteria: FilterCriteria[]

Wartość właściwości

FilterCriteria[]

direction

Właściwość PagingDirection jest stosowana do tokenu stronicowania, jeśli taki istnieje. Jeśli nie, kierunek jest ignorowany i używany jest Naprzód od początku zestawu wyników. Kierunek powinien zostać pominięty w żądaniu, chyba że token stronicowania jest używany w celu zapobiegania przyszłym problemom.

direction: PagingDirection

Wartość właściwości

PagingDirection

pageNumber

Numer strony żądany przez użytkownika. Jeśli nie zostanie podany, domyślnie przyjmowana jest wartość 1.

pageNumber: number

Wartość właściwości

number

pageSize

Rozmiar strony określa liczbę wyników, które obiekt wywołujący chce uzyskać 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

Określa typ sortowania, który ma być stosowany do wyników. Wycinek strony jest wycinany tylko z posortowanych wyników.

sortBy: number

Wartość właściwości

number

sortOrder

Definiuje kolejność sortowania, 1 dla rosnącej, 2 dla malejącej, w przeciwnym razie domyślna kolejność oparta na wartości SortBy

sortOrder: number

Wartość właściwości

number