ListAgentsOptionalParams interface
Optionele parameters.
- Uitbreiding
Eigenschappen
after | Een cursor voor gebruik in paginering. na is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep na=obj_foo worden opgenomen om de volgende pagina van de lijst op te halen. |
before | Een cursor voor gebruik in paginering. vóór is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep vóór=obj_foo worden opgenomen om de vorige pagina van de lijst op te halen. |
limit | Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de standaardwaarde is 20. |
order | Sorteervolgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde en desc voor aflopende volgorde. |
Overgenomen eigenschappen
abort |
Het signaal dat kan worden gebruikt om aanvragen af te breken. |
on |
Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen. |
request |
Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking. |
tracing |
Opties die worden gebruikt wanneer tracering is ingeschakeld. |
Eigenschapdetails
after
Een cursor voor gebruik in paginering. na is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep na=obj_foo worden opgenomen om de volgende pagina van de lijst op te halen.
after?: string
Waarde van eigenschap
string
before
Een cursor voor gebruik in paginering. vóór is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep vóór=obj_foo worden opgenomen om de vorige pagina van de lijst op te halen.
before?: string
Waarde van eigenschap
string
limit
Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de standaardwaarde is 20.
limit?: number
Waarde van eigenschap
number
order
Sorteervolgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde en desc voor aflopende volgorde.
order?: ListSortOrder
Waarde van eigenschap
Details van overgenomen eigenschap
abortSignal
Het signaal dat kan worden gebruikt om aanvragen af te breken.
abortSignal?: AbortSignalLike
Waarde van eigenschap
Overgenomen van OperationOptions.abortSignal
onResponse
Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
onResponse?: RawResponseCallback
Waarde van eigenschap
Overgenomen van OperationOptions.onResponse
requestOptions
Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
requestOptions?: OperationRequestOptions
Waarde van eigenschap
Overgenomen van OperationOptions.requestOptions
tracingOptions
Opties die worden gebruikt wanneer tracering is ingeschakeld.
tracingOptions?: OperationTracingOptions
Waarde van eigenschap
Overgenomen van OperationOptions.tracingOptions