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