QueryFilter interface

Paket:

azure-devops-extension-api

Ett filter som används för att definiera en uppsättning tillägg som ska returneras under en fråga.

Egenskaper

criteria	Filtervärdena definierar uppsättningen med värden i den här frågan. De tillämpas baserat på QueryFilterType.
direction	Växlingsdirigering tillämpas på en växlingstoken om det finns en sådan. Om inte ignoreras riktningen och Vidarebefordra från början av resultatuppsättningen används. Riktningen bör utelämnas från begäran om inte en växlingstoken används för att förhindra framtida problem.
pageNumber	Det sidnummer som användaren har begärt. Om det inte anges antas 1 som standard.
pageSize	Sidstorleken definierar det antal resultat som anroparen vill ha för det här filtret. Antalet får inte överskrida de totala frågestorleksgränserna.
pagingToken	Växlingstoken är en distinkt typ av filter och de andra filterfälten ignoreras. Växlingstoken representerar fortsättningen på en fråga som körts tidigare. Informationen om var i resultatet och vilka fält som filtreras bäddas in i token.
sortBy	Definierar vilken typ av sortering som ska tillämpas på resultaten. Sidsegmentet klipps endast av de sorterade resultaten.
sortOrder	Definierar sorteringsordningen, 1 för stigande, 2 för fallande, annars standardordning baserat på SortBy-värdet

Egenskapsinformation

criteria

Filtervärdena definierar uppsättningen med värden i den här frågan. De tillämpas baserat på QueryFilterType.

criteria: FilterCriteria[]

Egenskapsvärde

FilterCriteria[]

direction

Växlingsdirigering tillämpas på en växlingstoken om det finns en sådan. Om inte ignoreras riktningen och Vidarebefordra från början av resultatuppsättningen används. Riktningen bör utelämnas från begäran om inte en växlingstoken används för att förhindra framtida problem.

direction: PagingDirection

Egenskapsvärde

PagingDirection

pageNumber

Det sidnummer som användaren har begärt. Om det inte anges antas 1 som standard.

pageNumber: number

Egenskapsvärde

number

pageSize

Sidstorleken definierar det antal resultat som anroparen vill ha för det här filtret. Antalet får inte överskrida de totala frågestorleksgränserna.

pageSize: number

Egenskapsvärde

number

pagingToken

Växlingstoken är en distinkt typ av filter och de andra filterfälten ignoreras. Växlingstoken representerar fortsättningen på en fråga som körts tidigare. Informationen om var i resultatet och vilka fält som filtreras bäddas in i token.

pagingToken: string

Egenskapsvärde

string

sortBy

Definierar vilken typ av sortering som ska tillämpas på resultaten. Sidsegmentet klipps endast av de sorterade resultaten.

sortBy: number

Egenskapsvärde

number

sortOrder

Definierar sorteringsordningen, 1 för stigande, 2 för fallande, annars standardordning baserat på SortBy-värdet

sortOrder: number

Egenskapsvärde

number