Sdílet prostřednictvím

QueryFilter interface

  • Reference
Balíček:
azure-devops-extension-api

Filtr, který slouží k definování sady rozšíření, která se mají vrátit během dotazu.

Vlastnosti

criteria

Hodnoty filtru definují sadu hodnot v tomto dotazu. Použijí se na základě typu QueryFilterType.
direction

PagingDirection se použije na token stránkování, pokud existuje. Pokud ne, směr se ignoruje a použije se vpřed od začátku sady výsledků. Pokud se k zabránění budoucím problémům nepoužívá stránkovací token, měl by se v požadavku vynechat směr.
pageNumber

Číslo stránky požadované uživatelem Pokud není zadaný, ve výchozím nastavení se předpokládá hodnota 1.
pageSize

Velikost stránky definuje počet výsledků, které volající chce pro tento filtr. Počet nesmí překročit omezení celkové velikosti dotazu.
pagingToken

Token stránkování je odlišný typ filtru a ostatní pole filtru se ignorují. Token stránkování představuje pokračování dříve spuštěného dotazu. Informace o tom, kde ve výsledku a jaká pole se filtrují, jsou vložené do tokenu.
sortBy

Definuje typ řazení, který se použije u výsledků. Řez stránky se vyjme jenom z seřazených výsledků.
sortOrder

Definuje pořadí řazení, 1 pro Vzestupné, 2 pro Sestupné, jinak výchozí řazení na základě hodnoty SortBy

Podrobnosti vlastnosti

criteria

Hodnoty filtru definují sadu hodnot v tomto dotazu. Použijí se na základě typu QueryFilterType.

criteria: FilterCriteria[]

Hodnota vlastnosti

FilterCriteria[]

direction

PagingDirection se použije na token stránkování, pokud existuje. Pokud ne, směr se ignoruje a použije se vpřed od začátku sady výsledků. Pokud se k zabránění budoucím problémům nepoužívá stránkovací token, měl by se v požadavku vynechat směr.

direction: PagingDirection

Hodnota vlastnosti

PagingDirection

pageNumber

Číslo stránky požadované uživatelem Pokud není zadaný, ve výchozím nastavení se předpokládá hodnota 1.

pageNumber: number

Hodnota vlastnosti

number

pageSize

Velikost stránky definuje počet výsledků, které volající chce pro tento filtr. Počet nesmí překročit omezení celkové velikosti dotazu.

pageSize: number

Hodnota vlastnosti

number

pagingToken

Token stránkování je odlišný typ filtru a ostatní pole filtru se ignorují. Token stránkování představuje pokračování dříve spuštěného dotazu. Informace o tom, kde ve výsledku a jaká pole se filtrují, jsou vložené do tokenu.

pagingToken: string

Hodnota vlastnosti

string

sortBy

Definuje typ řazení, který se použije u výsledků. Řez stránky se vyjme jenom z seřazených výsledků.

sortBy: number

Hodnota vlastnosti

number

sortOrder

Definuje pořadí řazení, 1 pro Vzestupné, 2 pro Sestupné, jinak výchozí řazení na základě hodnoty SortBy

sortOrder: number

Hodnota vlastnosti

number