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	De PagingDirection wordt toegepast op een paging-token als deze bestaat. Zo niet, dan wordt de richting genegeerd en Wordt Vooruit vanaf het begin van de resultatenset gebruikt. De richting moet worden weggelaten in de aanvraag, tenzij een paging-token wordt gebruikt om toekomstige problemen te voorkomen.
pageNumber	Het paginanummer dat door de gebruiker is aangevraagd. Als dit niet is opgegeven, wordt standaard uitgegaan van 1.
pageSize	Het paginaformaat bepaalt het aantal resultaten dat de aanroeper voor dit filter wil. Het aantal mag de limieten voor de totale querygrootte niet overschrijden.
pagingToken	Het pagingstoken is een uniek type filter en de andere filtervelden worden genegeerd. Het wisseltoken vertegenwoordigt het vervolg van een eerder uitgevoerde query. De informatie over waar in het resultaat en welke velden worden gefilterd, wordt ingesloten in het token.
sortBy	Definieert het type sortering dat moet worden toegepast op de resultaten. Het paginasegment wordt alleen van de gesorteerde resultaten geknipt.
sortOrder	Definieert de sorteervolgorde, 1 voor Oplopend, 2 voor Aflopend, anders de standaardvolgorde op basis van de waarde Sorteren Op

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

De PagingDirection wordt toegepast op een paging-token als deze bestaat. Zo niet, dan wordt de richting genegeerd en Wordt Vooruit vanaf het begin van de resultatenset gebruikt. De richting moet worden weggelaten in de aanvraag, tenzij een paging-token wordt gebruikt om toekomstige problemen te voorkomen.

direction: PagingDirection

Waarde van eigenschap

PagingDirection

pageNumber

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

pageNumber: number

Waarde van eigenschap

number

pageSize

Het paginaformaat bepaalt het aantal resultaten dat de aanroeper voor dit filter wil. Het aantal mag de limieten voor de totale querygrootte niet overschrijden.

pageSize: number

Waarde van eigenschap

number

pagingToken

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

pagingToken: string

Waarde van eigenschap

string

sortBy

Definieert 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 sorteervolgorde, 1 voor Oplopend, 2 voor Aflopend, anders de standaardvolgorde op basis van de waarde Sorteren Op

sortOrder: number

Waarde van eigenschap

number