QueryFilter interface

Csomag:

azure-devops-extension-api

A lekérdezés során visszaadandó bővítmények készletének meghatározására használt szűrő.

Tulajdonságok

criteria	A szűrőértékek határozzák meg a lekérdezés értékkészletét. A QueryFilterType alapján vannak alkalmazva.
direction	A PagingDirection egy lapozó jogkivonatra lesz alkalmazva, ha létezik ilyen. Ha nem, a rendszer figyelmen kívül hagyja az irányt, és az eredményhalmaz elejétől előre lesz használva. Az irányt ki kell hagyni a kérésből, kivéve, ha lapozó jogkivonatot használ a jövőbeli problémák megelőzésére.
pageNumber	A felhasználó által kért oldalszám. Ha nincs megadva, a rendszer alapértelmezés szerint 1-et feltételez.
pageSize	Az oldalméret határozza meg, hogy a hívó hány eredményt szeretne ehhez a szűrőhöz. A szám nem haladhatja meg a lekérdezés teljes méretkorlátját.
pagingToken	A lapozási jogkivonat egy külön típusú szűrő, és a többi szűrőmezőt figyelmen kívül hagyja. A lapozó jogkivonat egy korábban végrehajtott lekérdezés folytatását jelöli. Az eredmény helyére és a szűrt mezőkre vonatkozó információk be vannak ágyazva a jogkivonatba.
sortBy	Meghatározza az eredményekre alkalmazandó rendezés típusát. Az oldalszelet csak a rendezett eredményekből lesz kivágva.
sortOrder	Meghatározza a rendezés sorrendjét, 1 növekvő, 2 csökkenő, egyébként alapértelmezett sorrend a SortBy érték alapján

Tulajdonság adatai

criteria

A szűrőértékek határozzák meg a lekérdezés értékkészletét. A QueryFilterType alapján vannak alkalmazva.

criteria: FilterCriteria[]

Tulajdonság értéke

FilterCriteria[]

direction

A PagingDirection egy lapozó jogkivonatra lesz alkalmazva, ha létezik ilyen. Ha nem, a rendszer figyelmen kívül hagyja az irányt, és az eredményhalmaz elejétől előre lesz használva. Az irányt ki kell hagyni a kérésből, kivéve, ha lapozó jogkivonatot használ a jövőbeli problémák megelőzésére.

direction: PagingDirection

Tulajdonság értéke

PagingDirection

pageNumber

A felhasználó által kért oldalszám. Ha nincs megadva, a rendszer alapértelmezés szerint 1-et feltételez.

pageNumber: number

Tulajdonság értéke

number

pageSize

Az oldalméret határozza meg, hogy a hívó hány eredményt szeretne ehhez a szűrőhöz. A szám nem haladhatja meg a lekérdezés teljes méretkorlátját.

pageSize: number

Tulajdonság értéke

number

pagingToken

A lapozási jogkivonat egy külön típusú szűrő, és a többi szűrőmezőt figyelmen kívül hagyja. A lapozó jogkivonat egy korábban végrehajtott lekérdezés folytatását jelöli. Az eredmény helyére és a szűrt mezőkre vonatkozó információk be vannak ágyazva a jogkivonatba.

pagingToken: string

Tulajdonság értéke

string

sortBy

Meghatározza az eredményekre alkalmazandó rendezés típusát. Az oldalszelet csak a rendezett eredményekből lesz kivágva.

sortBy: number

Tulajdonság értéke

number

sortOrder

Meghatározza a rendezés sorrendjét, 1 növekvő, 2 csökkenő, egyébként alapértelmezett sorrend a SortBy érték alapján

sortOrder: number

Tulajdonság értéke

number