Delen via


ListMessagesOptions interface

De details die worden gebruikt om berichten weer te geven.

Extends

Eigenschappen

after

Een cursor voor gebruik in paginering. after is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag doet en 100 objecten ontvangt, eindigend op obj_foo, kan de volgende aanroep after=obj_foo bevatten om de volgende pagina van de lijst op te halen.

before

Een cursor voor gebruik in paginering. before is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag doet en 100 objecten ontvangt, eindigend op obj_foo, kan uw volgende aanroep before=obj_foo bevatten 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

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

onResponse

Een functie die moet worden aangeroepen telkens wanneer er een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

after

Een cursor voor gebruik in paginering. after is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag doet en 100 objecten ontvangt, eindigend op obj_foo, kan de volgende aanroep after=obj_foo bevatten om de volgende pagina van de lijst op te halen.

after?: string

Waarde van eigenschap

string

before

Een cursor voor gebruik in paginering. before is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag doet en 100 objecten ontvangt, eindigend op obj_foo, kan uw volgende aanroep before=obj_foo bevatten 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?: string

Waarde van eigenschap

string

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 moet worden aangeroepen telkens wanneer er 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