QueryFilter interface

Pakket:

azure-devops-extension-api

Een filter dat wordt gebruikt om een set extensies te definiëren die tijdens een query moeten worden geretourneerd.

Eigenschappen

criteria	De filterwaarden definiëren de set waarden in deze query. Ze worden toegepast op basis van het QueryFilterType.
direction	PagingDirection wordt toegepast op een pagingstoken als er een bestaat. Als de richting niet wordt genegeerd en vanaf het begin van de resultatenset doorsturen wordt gebruikt. De richting moet uit de aanvraag worden weggelaten, tenzij er een wisseltoken wordt gebruikt om toekomstige problemen te voorkomen.
pageNumber	Het paginanummer dat door de gebruiker is aangevraagd. Als 1 niet is opgegeven, wordt standaard uitgegaan van 1.
pageSize	Het paginaformaat definieert het aantal resultaten dat de beller wil voor dit filter. Het aantal kan niet groter zijn dan de totale limieten voor de querygrootte.
pagingToken	Het wisseltoken is een uniek type filter en de andere filtervelden worden genegeerd. Het wisseltoken vertegenwoordigt de voortzetting van een eerder uitgevoerde query. De informatie over waar in het resultaat en welke velden worden gefilterd, worden in het token ingesloten.
sortBy	Hiermee definieert u het type sortering dat moet worden toegepast op de resultaten. Het paginasegment wordt alleen van de gesorteerde resultaten geknipt.
sortOrder	Definieert de volgorde van sorteren, 1 voor oplopend, 2 voor Aflopend, anders de standaardvolgorde op basis van de waarde SortBy

Eigenschapdetails

criteria

De filterwaarden definiëren de set waarden in deze query. Ze worden toegepast op basis van het QueryFilterType.

criteria: FilterCriteria[]

Waarde van eigenschap

FilterCriteria[]

direction

PagingDirection wordt toegepast op een pagingstoken als er een bestaat. Als de richting niet wordt genegeerd en vanaf het begin van de resultatenset doorsturen wordt gebruikt. De richting moet uit de aanvraag worden weggelaten, tenzij er een wisseltoken wordt gebruikt om toekomstige problemen te voorkomen.

direction: PagingDirection

Waarde van eigenschap

PagingDirection

pageNumber

Het paginanummer dat door de gebruiker is aangevraagd. Als 1 niet is opgegeven, wordt standaard uitgegaan van 1.

pageNumber: number

Waarde van eigenschap

number

pageSize

Het paginaformaat definieert het aantal resultaten dat de beller wil voor dit filter. Het aantal kan niet groter zijn dan de totale limieten voor de querygrootte.

pageSize: number

Waarde van eigenschap

number

pagingToken

Het wisseltoken is een uniek type filter en de andere filtervelden worden genegeerd. Het wisseltoken vertegenwoordigt de voortzetting van een eerder uitgevoerde query. De informatie over waar in het resultaat en welke velden worden gefilterd, worden in het token ingesloten.

pagingToken: string

Waarde van eigenschap

string

sortBy

Hiermee definieert u het type sortering dat moet worden toegepast op de resultaten. Het paginasegment wordt alleen van de gesorteerde resultaten geknipt.

sortBy: number

Waarde van eigenschap

number

sortOrder

Definieert de volgorde van sorteren, 1 voor oplopend, 2 voor Aflopend, anders de standaardvolgorde op basis van de waarde SortBy

sortOrder: number

Waarde van eigenschap

number