QueryFilter interface

Pacchetto:

azure-devops-extension-api

Filtro utilizzato per definire un set di estensioni da restituire durante una query.

Proprietà

criteria	I valori del filtro definiscono il set di valori in questa query. Vengono applicati in base a QueryFilterType.
direction	PagingDirection viene applicato a un token di paging, se presente. Se non viene ignorata la direzione, viene utilizzato Forward dall'inizio del set di risultati. La direzione deve essere lasciata fuori dalla richiesta, a meno che non venga usato un token di paging per evitare problemi futuri.
pageNumber	Numero di pagina richiesto dall'utente. Se non specificato 1, viene utilizzato per impostazione predefinita.
pageSize	La dimensione della pagina definisce il numero di risultati desiderati dal chiamante per questo filtro. Il conteggio non può superare i limiti complessivi delle dimensioni delle query.
pagingToken	Il token di paging è un tipo distinto di filtro e gli altri campi filtro vengono ignorati. Il token di paging rappresenta la continuazione di una query eseguita in precedenza. Le informazioni sulla posizione nel risultato e sui campi filtrati vengono incorporate nel token.
sortBy	Definisce il tipo di ordinamento da applicare ai risultati. La sezione di pagina viene tagliata solo dei risultati ordinati.
sortOrder	Definisce l'ordine di ordinamento, 1 per Ascending, 2 per Descending, altrimenti ordinamento predefinito in base al valore SortBy

Dettagli proprietà

criteria

I valori del filtro definiscono il set di valori in questa query. Vengono applicati in base a QueryFilterType.

criteria: FilterCriteria[]

Valore della proprietà

FilterCriteria[]

direction

PagingDirection viene applicato a un token di paging, se presente. Se non viene ignorata la direzione, viene utilizzato Forward dall'inizio del set di risultati. La direzione deve essere lasciata fuori dalla richiesta, a meno che non venga usato un token di paging per evitare problemi futuri.

direction: PagingDirection

Valore della proprietà

PagingDirection

pageNumber

Numero di pagina richiesto dall'utente. Se non specificato 1, viene utilizzato per impostazione predefinita.

pageNumber: number

Valore della proprietà

number

pageSize

La dimensione della pagina definisce il numero di risultati desiderati dal chiamante per questo filtro. Il conteggio non può superare i limiti complessivi delle dimensioni delle query.

pageSize: number

Valore della proprietà

number

pagingToken

Il token di paging è un tipo distinto di filtro e gli altri campi filtro vengono ignorati. Il token di paging rappresenta la continuazione di una query eseguita in precedenza. Le informazioni sulla posizione nel risultato e sui campi filtrati vengono incorporate nel token.

pagingToken: string

Valore della proprietà

string

sortBy

Definisce il tipo di ordinamento da applicare ai risultati. La sezione di pagina viene tagliata solo dei risultati ordinati.

sortBy: number

Valore della proprietà

number

sortOrder

Definisce l'ordine di ordinamento, 1 per Ascending, 2 per Descending, altrimenti ordinamento predefinito in base al valore SortBy

sortOrder: number

Valore della proprietà

number