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. In caso contrario, la direzione viene ignorata e viene utilizzato Avanti dall'inizio del set di risultati. La direzione deve essere esclusa dalla richiesta, a meno che non venga utilizzato un token di paging per evitare problemi futuri.
pageNumber	Il numero di pagina richiesto dall'utente. Se non viene specificato, per impostazione predefinita si presuppone che 1.
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 del filtro vengono ignorati. Il token di paging rappresenta la continuazione di una query eseguita in precedenza. Le informazioni sulla posizione del risultato e sui campi filtrati sono incorporate nel token.
sortBy	Definisce il tipo di ordinamento da applicare ai risultati. La sezione di pagina viene tagliata solo dai risultati ordinati.
sortOrder	Definisce l'ordine di ordinamento, 1 per Crescente, 2 per Decrescente, altrimenti l'ordinamento predefinito si basa sul 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. In caso contrario, la direzione viene ignorata e viene utilizzato Avanti dall'inizio del set di risultati. La direzione deve essere esclusa dalla richiesta, a meno che non venga utilizzato un token di paging per evitare problemi futuri.

direction: PagingDirection

Valore della proprietà

PagingDirection

pageNumber

Il numero di pagina richiesto dall'utente. Se non viene specificato, per impostazione predefinita si presuppone che 1.

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 del filtro vengono ignorati. Il token di paging rappresenta la continuazione di una query eseguita in precedenza. Le informazioni sulla posizione del risultato e sui campi filtrati sono 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 dai risultati ordinati.

sortBy: number

Valore della proprietà

number

sortOrder

Definisce l'ordine di ordinamento, 1 per Crescente, 2 per Decrescente, altrimenti l'ordinamento predefinito si basa sul valore SortBy

sortOrder: number

Valore della proprietà

number