QueryFilter interface

Paket:

azure-devops-extension-api

Filter yang digunakan untuk menentukan sekumpulan ekstensi yang akan dikembalikan selama kueri.

Properti

criteria	Nilai filter menentukan kumpulan nilai dalam kueri ini. Mereka diterapkan berdasarkan QueryFilterType.
direction	PagingDirection diterapkan ke token paging jika ada. Jika tidak, arah diabaikan, dan Maju dari awal kumpulan hasil digunakan. Arah harus ditinggalkan dari permintaan kecuali token paging digunakan untuk membantu mencegah masalah di masa mendatang.
pageNumber	Nomor halaman yang diminta oleh pengguna. Jika tidak disediakan, 1 diasumsikan secara default.
pageSize	Ukuran halaman menentukan jumlah hasil yang diinginkan pemanggil untuk filter ini. Jumlah tidak boleh melebihi batas ukuran kueri keseluruhan.
pagingToken	Token paging adalah jenis filter yang berbeda dan bidang filter lainnya diabaikan. Token paging mewakili kelanjutan dari kueri yang dijalankan sebelumnya. Informasi tentang di mana dalam hasil dan bidang apa yang difilter disematkan dalam token.
sortBy	Menentukan jenis pengurutan yang akan diterapkan pada hasil. Irisan halaman hanya dipotong dari hasil yang diurutkan.
sortOrder	Menentukan urutan pengurutan, 1 untuk Ascending, 2 untuk Descending, urutan default lainnya berdasarkan nilai SortBy

Detail Properti

criteria

Nilai filter menentukan kumpulan nilai dalam kueri ini. Mereka diterapkan berdasarkan QueryFilterType.

criteria: FilterCriteria[]

Nilai Properti

FilterCriteria[]

direction

PagingDirection diterapkan ke token paging jika ada. Jika tidak, arah diabaikan, dan Maju dari awal kumpulan hasil digunakan. Arah harus ditinggalkan dari permintaan kecuali token paging digunakan untuk membantu mencegah masalah di masa mendatang.

direction: PagingDirection

Nilai Properti

PagingDirection

pageNumber

Nomor halaman yang diminta oleh pengguna. Jika tidak disediakan, 1 diasumsikan secara default.

pageNumber: number

Nilai Properti

number

pageSize

Ukuran halaman menentukan jumlah hasil yang diinginkan pemanggil untuk filter ini. Jumlah tidak boleh melebihi batas ukuran kueri keseluruhan.

pageSize: number

Nilai Properti

number

pagingToken

Token paging adalah jenis filter yang berbeda dan bidang filter lainnya diabaikan. Token paging mewakili kelanjutan dari kueri yang dijalankan sebelumnya. Informasi tentang di mana dalam hasil dan bidang apa yang difilter disematkan dalam token.

pagingToken: string

Nilai Properti

string

sortBy

Menentukan jenis pengurutan yang akan diterapkan pada hasil. Irisan halaman hanya dipotong dari hasil yang diurutkan.

sortBy: number

Nilai Properti

number

sortOrder

Menentukan urutan pengurutan, 1 untuk Ascending, 2 untuk Descending, urutan default lainnya berdasarkan nilai SortBy

sortOrder: number

Nilai Properti

number