QueryFilter interface

Paket:

azure-devops-extension-api

Ein Filter, der zum Definieren einer Reihe von Erweiterungen verwendet wird, die während einer Abfrage zurückgegeben werden sollen.

Eigenschaften

criteria	Die Filterwerte definieren die Menge der Werte in dieser Abfrage. Sie werden basierend auf QueryFilterType angewendet.
direction	PagingDirection wird auf ein Auslagerungstoken angewendet, sofern eines vorhanden ist. Ist dies nicht der Fall, wird die Richtung ignoriert, und es wird die Option Vorwärts vom Anfang des Resultsets verwendet. Die Richtung sollte in der Anforderung weggelassen werden, es sei denn, es wird ein Auslagerungstoken verwendet, um zukünftige Probleme zu vermeiden.
pageNumber	Die vom Benutzer angeforderte Seitenzahl. Wenn nicht angegeben, wird standardmäßig 1 angenommen.
pageSize	Die Seitengröße definiert die Anzahl der Ergebnisse, die der Aufrufer für diesen Filter wünscht. Die Anzahl darf die Grenzwerte für die Gesamtgröße der Abfrage nicht überschreiten.
pagingToken	Das Auslagerungstoken ist ein eigenständiger Filtertyp, und die anderen Filterfelder werden ignoriert. Das Auslagerungstoken stellt die Fortsetzung einer zuvor ausgeführten Abfrage dar. Die Informationen darüber, wo im Ergebnis und welche Felder gefiltert werden, sind in das Token eingebettet.
sortBy	Definiert die Art der Sortierung, die auf die Ergebnisse angewendet werden soll. Das Seitenblatt wird nur von den sortierten Ergebnissen abgeschnitten.
sortOrder	Definiert die Sortierreihenfolge, 1 für Aufsteigend, 2 für Absteigend, andernfalls die Standardreihenfolge basierend auf dem SortBy-Wert

Details zur Eigenschaft

criteria

Die Filterwerte definieren die Menge der Werte in dieser Abfrage. Sie werden basierend auf QueryFilterType angewendet.

criteria: FilterCriteria[]

Eigenschaftswert

FilterCriteria[]

direction

PagingDirection wird auf ein Auslagerungstoken angewendet, sofern eines vorhanden ist. Ist dies nicht der Fall, wird die Richtung ignoriert, und es wird die Option Vorwärts vom Anfang des Resultsets verwendet. Die Richtung sollte in der Anforderung weggelassen werden, es sei denn, es wird ein Auslagerungstoken verwendet, um zukünftige Probleme zu vermeiden.

direction: PagingDirection

Eigenschaftswert

PagingDirection

pageNumber

Die vom Benutzer angeforderte Seitenzahl. Wenn nicht angegeben, wird standardmäßig 1 angenommen.

pageNumber: number

Eigenschaftswert

number

pageSize

Die Seitengröße definiert die Anzahl der Ergebnisse, die der Aufrufer für diesen Filter wünscht. Die Anzahl darf die Grenzwerte für die Gesamtgröße der Abfrage nicht überschreiten.

pageSize: number

Eigenschaftswert

number

pagingToken

Das Auslagerungstoken ist ein eigenständiger Filtertyp, und die anderen Filterfelder werden ignoriert. Das Auslagerungstoken stellt die Fortsetzung einer zuvor ausgeführten Abfrage dar. Die Informationen darüber, wo im Ergebnis und welche Felder gefiltert werden, sind in das Token eingebettet.

pagingToken: string

Eigenschaftswert

string

sortBy

Definiert die Art der Sortierung, die auf die Ergebnisse angewendet werden soll. Das Seitenblatt wird nur von den sortierten Ergebnissen abgeschnitten.

sortBy: number

Eigenschaftswert

number

sortOrder

Definiert die Sortierreihenfolge, 1 für Aufsteigend, 2 für Absteigend, andernfalls die Standardreihenfolge basierend auf dem SortBy-Wert

sortOrder: number

Eigenschaftswert

number