QueryFilter interface
クエリ中に返す一連の拡張機能を定義するために使用されるフィルター。
プロパティ
| criteria | フィルター値は、このクエリの値のセットを定義します。 これらは QueryFilterType に基づいて適用されます。 |
| direction | PagingDirection が存在する場合、ページング トークンに適用されます。 そうでない場合は方向が無視され、結果セットの先頭から Forward が使用されます。 今後の問題を防ぐためにページング トークンを使用しない限り、方向は要求から除外する必要があります。 |
| page |
ユーザーが要求したページ番号。 指定されていない場合、1 は既定で想定されます。 |
| page |
ページ サイズは、呼び出し元がこのフィルターに必要な結果の数を定義します。 この数は、クエリ サイズの全体的な制限を超えることはできません。 |
| paging |
ページング トークンは個別の種類のフィルターであり、他のフィルター フィールドは無視されます。 ページング トークンは、以前に実行されたクエリの継続を表します。 結果の場所とフィルター処理されるフィールドに関する情報がトークンに埋め込まれます。 |
| sort |
結果に適用する並べ替えの種類を定義します。 ページ スライスは、並べ替えられた結果のみを切り取ります。 |
| sort |
並べ替えの順序を定義します。昇順の場合は 1、降順の場合は 2、それ以外の場合は SortBy 値に基づく既定の順序を定義します |
プロパティの詳細
criteria
フィルター値は、このクエリの値のセットを定義します。 これらは QueryFilterType に基づいて適用されます。
criteria: FilterCriteria[]プロパティ値
direction
PagingDirection が存在する場合、ページング トークンに適用されます。 そうでない場合は方向が無視され、結果セットの先頭から Forward が使用されます。 今後の問題を防ぐためにページング トークンを使用しない限り、方向は要求から除外する必要があります。
direction: 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