AgentsListSessionFilesOptionalParams interface

選擇性參數。

Extends

屬性

after

一個用於分頁的游標。 after 是一個定義你在清單中位置的物件 ID。 例如,如果您提出清單要求並收到 100 個物件 (結尾為 obj_foo),則後續呼叫可以包含 after=obj_foo 來擷取清單的下一頁。

before

一個用於分頁的游標。 before 是一個定義你在清單中位置的物件 ID。 例如,如果您提出清單請求並收到 100 個以 obj_foo 結尾的物件,則後續呼叫可以包含 before=obj_foo 以取得清單的上一頁。

limit

限制可歸還的物品數量。 限制範圍在1到100之間,預設為20。

order

created_at 物件的時間戳排序順序。 asc 用於升序和desc 用於降序。

path

相對於會話主目錄的目錄路徑。 如果沒有提供,則會預設為主目錄。

繼承的屬性

abortSignal

可用來中止要求的訊號。

onResponse

每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

tracingOptions

啟用追蹤時所使用的選項。

屬性詳細資料

after

一個用於分頁的游標。 after 是一個定義你在清單中位置的物件 ID。 例如,如果您提出清單要求並收到 100 個物件 (結尾為 obj_foo),則後續呼叫可以包含 after=obj_foo 來擷取清單的下一頁。

after?: string

屬性值

string

before

一個用於分頁的游標。 before 是一個定義你在清單中位置的物件 ID。 例如,如果您提出清單請求並收到 100 個以 obj_foo 結尾的物件,則後續呼叫可以包含 before=obj_foo 以取得清單的上一頁。

before?: string

屬性值

string

limit

限制可歸還的物品數量。 限制範圍在1到100之間,預設為20。

limit?: number

屬性值

number

order

created_at 物件的時間戳排序順序。 asc 用於升序和desc 用於降序。

order?: PageOrder

屬性值

path

相對於會話主目錄的目錄路徑。 如果沒有提供,則會預設為主目錄。

path?: string

屬性值

string

繼承的屬性詳細資料

abortSignal

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

繼承自 OperationOptions.abortSignal

onResponse

每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。

onResponse?: RawResponseCallback

屬性值

繼承自 OperationOptions.onResponse

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

requestOptions?: OperationRequestOptions

屬性值

繼承自 OperationOptions.requestOptions

tracingOptions

啟用追蹤時所使用的選項。

tracingOptions?: OperationTracingOptions

屬性值

繼承自 OperationOptions.tracingOptions