QueryFilter interface

Paket:

azure-devops-extension-api

Ein Filter, der verwendet wird, um eine Reihe von Erweiterungen zu definieren, die während einer Abfrage zurückgegeben werden sollen.

Eigenschaften

criteria	Die Filterwerte definieren den Wertsatz in dieser Abfrage. Sie werden basierend auf dem QueryFilterType angewendet.
direction	PagingDirection wird auf ein Pagingtoken angewendet, sofern vorhanden. Andernfalls wird die Richtung ignoriert, und vom Anfang des Resultsets wird Forward verwendet. Die Richtung sollte von der Anforderung ausgeschlossen werden, es sei denn, ein Pagingtoken wird verwendet, um zukünftige Probleme zu verhindern.
pageNumber	Die vom Benutzer angeforderte Seitennummer. 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 Gesamtabfragegröße nicht überschreiten.
pagingToken	Das Pagingtoken ist ein unterschiedlicher Filtertyp, und die anderen Filterfelder werden ignoriert. Das Pagingtoken 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 den Typ der Sortierung, die auf die Ergebnisse angewendet werden soll. Der Seitenschnitt wird nur aus den sortierten Ergebnissen geschnitten.
sortOrder	Definiert die Sortierreihenfolge, 1 für Aufsteigend, 2 für Absteigend, ansonsten die Standardreihenfolge basierend auf dem SortBy-Wert.

Details zur Eigenschaft

criteria

Die Filterwerte definieren den Wertsatz in dieser Abfrage. Sie werden basierend auf dem QueryFilterType angewendet.

criteria: FilterCriteria[]

Eigenschaftswert

FilterCriteria[]

direction

PagingDirection wird auf ein Pagingtoken angewendet, sofern vorhanden. Andernfalls wird die Richtung ignoriert, und vom Anfang des Resultsets wird Forward verwendet. Die Richtung sollte von der Anforderung ausgeschlossen werden, es sei denn, ein Pagingtoken wird verwendet, um zukünftige Probleme zu verhindern.

direction: PagingDirection

Eigenschaftswert

PagingDirection

pageNumber

Die vom Benutzer angeforderte Seitennummer. 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 Gesamtabfragegröße nicht überschreiten.

pageSize: number

Eigenschaftswert

number

pagingToken

Das Pagingtoken ist ein unterschiedlicher Filtertyp, und die anderen Filterfelder werden ignoriert. Das Pagingtoken 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 den Typ der Sortierung, die auf die Ergebnisse angewendet werden soll. Der Seitenschnitt wird nur aus den sortierten Ergebnissen geschnitten.

sortBy: number

Eigenschaftswert

number

sortOrder

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

sortOrder: number

Eigenschaftswert

number