QueryFilter interface

Paquet:

azure-devops-extension-api

Filtre utilisé pour définir un ensemble d’extensions à retourner pendant une requête.

Propriétés

criteria	Les valeurs de filtre définissent l’ensemble de valeurs dans cette requête. Elles sont appliquées en fonction du QueryFilterType.
direction	PagingDirection est appliqué à un jeton de pagination s’il en existe un. Si la direction n’est pas ignorée, et forward from the start of the resultset is used. La direction doit être laissée hors de la requête, sauf si un jeton de pagination est utilisé pour empêcher les problèmes futurs.
pageNumber	Numéro de page demandé par l’utilisateur. Si la valeur 1 n’est pas fournie, elle est supposée par défaut.
pageSize	La taille de page définit le nombre de résultats souhaités par l’appelant pour ce filtre. Le nombre ne peut pas dépasser les limites globales de taille de requête.
pagingToken	Le jeton de pagination est un type distinct de filtre et les autres champs de filtre sont ignorés. Le jeton de pagination représente la continuation d’une requête exécutée précédemment. Les informations sur l’emplacement dans le résultat et les champs qui sont filtrés sont incorporées dans le jeton.
sortBy	Définit le type de tri à appliquer aux résultats. La tranche de page est coupée des résultats triés uniquement.
sortOrder	Définit l’ordre de tri, 1 pour Croissant, 2 pour Décroissant, sinon l’ordre par défaut basé sur la valeur SortBy

Détails de la propriété

criteria

Les valeurs de filtre définissent l’ensemble de valeurs dans cette requête. Elles sont appliquées en fonction du QueryFilterType.

criteria: FilterCriteria[]

Valeur de propriété

FilterCriteria[]

direction

PagingDirection est appliqué à un jeton de pagination s’il en existe un. Si la direction n’est pas ignorée, et forward from the start of the resultset is used. La direction doit être laissée hors de la requête, sauf si un jeton de pagination est utilisé pour empêcher les problèmes futurs.

direction: PagingDirection

Valeur de propriété

PagingDirection

pageNumber

Numéro de page demandé par l’utilisateur. Si la valeur 1 n’est pas fournie, elle est supposée par défaut.

pageNumber: number

Valeur de propriété

number

pageSize

La taille de page définit le nombre de résultats souhaités par l’appelant pour ce filtre. Le nombre ne peut pas dépasser les limites globales de taille de requête.

pageSize: number

Valeur de propriété

number

pagingToken

Le jeton de pagination est un type distinct de filtre et les autres champs de filtre sont ignorés. Le jeton de pagination représente la continuation d’une requête exécutée précédemment. Les informations sur l’emplacement dans le résultat et les champs qui sont filtrés sont incorporées dans le jeton.

pagingToken: string

Valeur de propriété

string

sortBy

Définit le type de tri à appliquer aux résultats. La tranche de page est coupée des résultats triés uniquement.

sortBy: number

Valeur de propriété

number

sortOrder

Définit l’ordre de tri, 1 pour Croissant, 2 pour Décroissant, sinon l’ordre par défaut basé sur la valeur SortBy

sortOrder: number

Valeur de propriété

number