Bagikan melalui


AgentsListOptionalParams interface

Parameter opsional.

Memperluas

Properti

after

Kursor untuk digunakan dalam paginasi. after adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, berakhir dengan obj_foo, panggilan berikutnya dapat menyertakan after=obj_foo untuk mengambil halaman berikutnya dari daftar.

before

Kursor untuk digunakan dalam paginasi. before adalah ID objek yang menentukan tempat Anda dalam daftar. Sebagai contoh, jika Anda membuat permintaan untuk daftar dan menerima 100 objek yang diakhiri dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo agar dapat mengambil halaman sebelumnya dari daftar tersebut.

kind

Filter agen berdasarkan jenisnya. Jika tidak disediakan, semua agen dikembalikan.

limit

Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.

order

Urutkan urutan menurut created_at tanda waktu objek. asc untuk urutan naik dandesc untuk urutan turun.

Properti yang Diwariskan

abortSignal

Sinyal yang dapat digunakan untuk membatalkan permintaan.

onResponse

Fungsi yang akan dipanggil setiap kali respons diterima dari server saat melakukan operasi yang diminta. Dapat dipanggil beberapa kali.

requestOptions

Opsi yang digunakan saat membuat dan mengirim permintaan HTTP untuk operasi ini.

tracingOptions

Opsi yang digunakan saat pelacakan diaktifkan.

Detail Properti

after

Kursor untuk digunakan dalam paginasi. after adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, berakhir dengan obj_foo, panggilan berikutnya dapat menyertakan after=obj_foo untuk mengambil halaman berikutnya dari daftar.

after?: string

Nilai Properti

string

before

Kursor untuk digunakan dalam paginasi. before adalah ID objek yang menentukan tempat Anda dalam daftar. Sebagai contoh, jika Anda membuat permintaan untuk daftar dan menerima 100 objek yang diakhiri dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo agar dapat mengambil halaman sebelumnya dari daftar tersebut.

before?: string

Nilai Properti

string

kind

Filter agen berdasarkan jenisnya. Jika tidak disediakan, semua agen dikembalikan.

kind?: AgentKind

Nilai Properti

limit

Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.

limit?: number

Nilai Properti

number

order

Urutkan urutan menurut created_at tanda waktu objek. asc untuk urutan naik dandesc untuk urutan turun.

order?: PageOrder

Nilai Properti

Detail Properti yang Diwariskan

abortSignal

Sinyal yang dapat digunakan untuk membatalkan permintaan.

abortSignal?: AbortSignalLike

Nilai Properti

Diwariskan Dari OperationOptions.abortSignal

onResponse

Fungsi yang akan dipanggil setiap kali respons diterima dari server saat melakukan operasi yang diminta. Dapat dipanggil beberapa kali.

onResponse?: RawResponseCallback

Nilai Properti

Diwariskan Dari OperationOptions.onResponse

requestOptions

Opsi yang digunakan saat membuat dan mengirim permintaan HTTP untuk operasi ini.

requestOptions?: OperationRequestOptions

Nilai Properti

Diwariskan Dari OperationOptions.requestOptions

tracingOptions

Opsi yang digunakan saat pelacakan diaktifkan.

tracingOptions?: OperationTracingOptions

Nilai Properti

Diwariskan Dari OperationOptions.tracingOptions