QueryFilter interface

Csomag:

azure-devops-extension-api

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

Tulajdonságok

criteria	A szűrőértékek határozzák meg a lekérdezésben szereplő értékek halmazát. Az alkalmazásuk a QueryFilterType alapján történik.
direction	A PagingDirection egy lapozó jogkivonatra lesz alkalmazva, ha van ilyen. Ha nem, akkor a rendszer figyelmen kívül hagyja az irányt, és az eredményhalmaz kezdetétől a Továbbítás parancsot használja. Az irányt ki kell hagyni a kérésből, kivéve, ha lapozó jogkivonatot használnak a jövőbeli problémák megelőzéséhez.
pageNumber	A felhasználó által kért oldalszám. Ha nincs megadva, alapértelmezés szerint az 1 értéket feltételezi a rendszer.
pageSize	Az oldalméret határozza meg, hogy a hívó hány találatot szeretne kapni ehhez a szűrőhöz. A szám nem haladhatja meg a teljes lekérdezésméretkorlátot.
pagingToken	A lapozó jogkivonat egy különálló szűrőtípus, a többi szűrőmezőt pedig figyelmen kívül hagyja a rendszer. A lapozó jogkivonat egy korábban végrehajtott lekérdezés folytatását jelöli. A jogkivonatba az eredmény helyével és a szűrt mezőkkel kapcsolatos információk lesznek beágyazva.
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 a növekvő, 2 a csökkenő sorrendet, máskülönben az alapértelmezett rendezést a SortBy érték alapján

Tulajdonság adatai

criteria

A szűrőértékek határozzák meg a lekérdezésben szereplő értékek halmazát. Az alkalmazásuk a QueryFilterType alapján történik.

criteria: FilterCriteria[]

Tulajdonság értéke

FilterCriteria[]

direction

A PagingDirection egy lapozó jogkivonatra lesz alkalmazva, ha van ilyen. Ha nem, akkor a rendszer figyelmen kívül hagyja az irányt, és az eredményhalmaz kezdetétől a Továbbítás parancsot használja. Az irányt ki kell hagyni a kérésből, kivéve, ha lapozó jogkivonatot használnak a jövőbeli problémák megelőzéséhez.

direction: PagingDirection

Tulajdonság értéke

PagingDirection

pageNumber

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

pageNumber: number

Tulajdonság értéke

number

pageSize

Az oldalméret határozza meg, hogy a hívó hány találatot szeretne kapni ehhez a szűrőhöz. A szám nem haladhatja meg a teljes lekérdezésméretkorlátot.

pageSize: number

Tulajdonság értéke

number

pagingToken

A lapozó jogkivonat egy különálló szűrőtípus, a többi szűrőmezőt pedig figyelmen kívül hagyja a rendszer. A lapozó jogkivonat egy korábban végrehajtott lekérdezés folytatását jelöli. A jogkivonatba az eredmény helyével és a szűrt mezőkkel kapcsolatos információk lesznek beágyazva.

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 a növekvő, 2 a csökkenő sorrendet, máskülönben az alapértelmezett rendezést a SortBy érték alapján

sortOrder: number

Tulajdonság értéke

number