QueryFilter interface

套件:

azure-devops-extension-api

用來定義一組要在查詢期間傳回的延伸模組的篩選器。

屬性

criteria	篩選值會定義此查詢中的值集。 它們會根據 QueryFilterType 套用。
direction	如果分頁權杖存在，則會將 PagingDirection 套用至分頁權杖。 如果沒有，則會忽略方向，並使用從結果集開頭開始的 Forward。 除非使用分頁權杖來協助防止未來發生問題，否則應該將方向排除在要求之外。
pageNumber	使用者要求的頁碼。 如果未提供，預設會假設為 1。
pageSize	頁面大小會定義呼叫端想要此篩選的結果數目。 計數不能超過整體查詢大小限制。
pagingToken	分頁記號是不同類型的過濾器，會忽略其他過濾器欄位。 分頁記號代表先前執行的查詢的延續。 有關結果中的位置和正在過濾的欄位的資訊會嵌入在權杖中。
sortBy	定義要套用至結果的排序類型。 頁面切片只會從排序結果中剪下。
sortOrder	定義排序順序，1 表示遞增，2 表示遞減，否則預設順序是根據 SortBy 值

屬性詳細資料

criteria

篩選值會定義此查詢中的值集。 它們會根據 QueryFilterType 套用。

criteria: FilterCriteria[]

屬性值

FilterCriteria[]

direction

如果分頁權杖存在，則會將 PagingDirection 套用至分頁權杖。 如果沒有，則會忽略方向，並使用從結果集開頭開始的 Forward。 除非使用分頁權杖來協助防止未來發生問題，否則應該將方向排除在要求之外。

direction: PagingDirection

屬性值

PagingDirection

pageNumber

使用者要求的頁碼。 如果未提供，預設會假設為 1。

pageNumber: number

屬性值

number

pageSize

頁面大小會定義呼叫端想要此篩選的結果數目。 計數不能超過整體查詢大小限制。

pageSize: number

屬性值

number

pagingToken

分頁記號是不同類型的過濾器，會忽略其他過濾器欄位。 分頁記號代表先前執行的查詢的延續。 有關結果中的位置和正在過濾的欄位的資訊會嵌入在權杖中。

pagingToken: string

屬性值

string

sortBy

定義要套用至結果的排序類型。 頁面切片只會從排序結果中剪下。

sortBy: number

屬性值

number

sortOrder

定義排序順序，1 表示遞增，2 表示遞減，否則預設順序是根據 SortBy 值

sortOrder: number

屬性值

number