AgentsListOptionalParams interface
Valfria parametrar.
- Extends
Egenskaper
| after | En markör för användning i sidnumrering.
|
| before | En markör för användning i sidnumrering.
|
| kind | Filtrera agenter efter typ. Om det inte anges returneras alla agenter. |
| limit | En gräns för hur många objekt som ska returneras. Gränsen kan vara mellan 1 och 100 och standardvärdet är 20. |
| order | Sortera ordning efter |
Ärvda egenskaper
| abort |
Den signal som kan användas för att avbryta begäranden. |
| on |
En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger. |
| request |
Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden. |
| tracing |
Alternativ som används när spårning är aktiverat. |
Egenskapsinformation
after
En markör för användning i sidnumrering.
after är ett objekt-ID som definierar din plats i listan.
Om du till exempel gör en listbegäran och tar emot 100 objekt, som slutar med obj_foo, kan ditt efterföljande anrop inkludera after=obj_foo för att hämta nästa sida i listan.
after?: string
Egenskapsvärde
string
before
En markör för användning i sidnumrering.
before är ett objekt-ID som definierar din plats i listan.
Om du till exempel gör en listbegäran och tar emot 100 objekt som avslutas med obj_foo, kan du i ditt nästa anrop inkludera 'före=obj_foo' för att hämta den föregående sidan i listan.
before?: string
Egenskapsvärde
string
kind
Filtrera agenter efter typ. Om det inte anges returneras alla agenter.
kind?: AgentKind
Egenskapsvärde
limit
En gräns för hur många objekt som ska returneras. Gränsen kan vara mellan 1 och 100 och standardvärdet är 20.
limit?: number
Egenskapsvärde
number
order
Sortera ordning efter created_at tidsstämpeln för objekten.
asc för stigande ordning ochdesc för fallande ordning.
order?: PageOrder
Egenskapsvärde
Information om ärvda egenskaper
abortSignal
Den signal som kan användas för att avbryta begäranden.
abortSignal?: AbortSignalLike
Egenskapsvärde
ärvd från OperationOptions.abortSignal
onResponse
En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.
onResponse?: RawResponseCallback
Egenskapsvärde
ärvd från OperationOptions.onResponse
requestOptions
Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
requestOptions?: OperationRequestOptions
Egenskapsvärde
ärvd från OperationOptions.requestOptions
tracingOptions
Alternativ som används när spårning är aktiverat.
tracingOptions?: OperationTracingOptions
Egenskapsvärde
ärvd från OperationOptions.tracingOptions