QueryFilter interface

パッケージ:

azure-devops-extension-api

クエリ中に返される一連の拡張機能を定義するために使用されるフィルター。

プロパティ

criteria	フィルター値は、このクエリの値のセットを定義します。 これらは QueryFilterType に基づいて適用されます。
direction	PagingDirection は、ページング トークンが存在する場合は、ページング トークンに適用されます。 そうでない場合、方向は無視され、結果セットの先頭から [進む] が使用されます。 将来の問題を防ぐためにページング トークンが使用されない限り、指示は要求から除外する必要があります。
pageNumber	ユーザーが要求したページ番号。 指定しない場合、デフォルトでは 1 が想定されます。
pageSize	ページ サイズは、呼び出し元がこのフィルターに必要な結果の数を定義します。 カウントは、全体的なクエリ サイズの制限を超えることはできません。
pagingToken	ページング・トークンは個別のタイプのフィルターであり、他のフィルター・フィールドは無視されます。 ページング トークンは、以前に実行されたクエリの継続を表します。 結果のどこに、どのフィールドがフィルタリングされているかに関する情報がトークンに埋め込まれます。
sortBy	結果に適用する並べ替えのタイプを定義します。 ページスライスは、ソートされた結果のみから切り取られます。
sortOrder	並べ替えの順序を定義し、1 は昇順、2 は降順、それ以外の場合は SortBy 値に基づく既定の順序を定義します。

プロパティの詳細

criteria

フィルター値は、このクエリの値のセットを定義します。 これらは QueryFilterType に基づいて適用されます。

criteria: FilterCriteria[]

プロパティ値

FilterCriteria[]

direction

PagingDirection は、ページング トークンが存在する場合は、ページング トークンに適用されます。 そうでない場合、方向は無視され、結果セットの先頭から [進む] が使用されます。 将来の問題を防ぐためにページング トークンが使用されない限り、指示は要求から除外する必要があります。

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