AgentsListOptionalParams interface
Optionale Parameter.
- Extends
Eigenschaften
| after | Ein Cursor für die Verwendung bei der Paginierung.
|
| before | Ein Cursor für die Verwendung bei der Paginierung.
|
| kind | Filtern Sie die Wirkstoffe nach Art. Wenn nicht angegeben, werden alle Agenten zurückgegeben. |
| limit | Ein Grenzwert für die Anzahl von Objekten, die zurückgegeben werden sollen. Der Grenzwert kann zwischen 1 und 100 liegen. Der Standardwert ist 20. |
| order | Sortierreihenfolge nach dem |
Geerbte Eigenschaften
| abort |
Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann. |
| on |
Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden. |
| request |
Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden. |
| tracing |
Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist. |
Details zur Eigenschaft
after
Ein Cursor für die Verwendung bei der Paginierung.
after ist eine Objekt-ID, die die Position in der Liste definiert.
Wenn Sie z. B. eine Listenanforderung senden und 100 Objekte empfangen, die mit „obj_foo“ enden, kann der nachfolgende Aufruf „after=obj_foo“ enthalten, um die nächste Seite der Liste abzurufen.
after?: string
Eigenschaftswert
string
before
Ein Cursor für die Verwendung bei der Paginierung.
before ist eine Objekt-ID, die die Position in der Liste definiert.
Wenn Sie z. B. eine Listenanforderung stellen und 100 Objekte empfangen, die mit obj_foo enden, kann Ihr nachfolgender Aufruf before=obj_foo enthalten, um die vorherige Seite der Liste abzurufen.
before?: string
Eigenschaftswert
string
kind
Filtern Sie die Wirkstoffe nach Art. Wenn nicht angegeben, werden alle Agenten zurückgegeben.
kind?: AgentKind
Eigenschaftswert
limit
Ein Grenzwert für die Anzahl von Objekten, die zurückgegeben werden sollen. Der Grenzwert kann zwischen 1 und 100 liegen. Der Standardwert ist 20.
limit?: number
Eigenschaftswert
number
order
Sortierreihenfolge nach dem created_at Zeitstempel der Objekte.
asc für aufsteigende Reihenfolge unddesc absteigende Reihenfolge.
order?: PageOrder
Eigenschaftswert
Geerbte Eigenschaftsdetails
abortSignal
Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
abortSignal?: AbortSignalLike
Eigenschaftswert
Geerbt von OperationOptions.abortSignal
onResponse
Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.
onResponse?: RawResponseCallback
Eigenschaftswert
Geerbt von OperationOptions.onResponse
requestOptions
Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
requestOptions?: OperationRequestOptions
Eigenschaftswert
Geerbt von OperationOptions.requestOptions
tracingOptions
Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.
tracingOptions?: OperationTracingOptions
Eigenschaftswert
Geerbt von OperationOptions.tracingOptions