Compartir a través de


ListMessagesOptions interface

Los detalles usados para enumerar los mensajes.

Extends

Propiedades

after

Cursor para su uso en la paginación. después de es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos que terminan con obj_foo, la llamada posterior puede incluir after=obj_foo para capturar la página siguiente de la lista.

before

Cursor para su uso en la paginación. antes es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos, finalizando con obj_foo, la llamada posterior puede incluir before=obj_foo para capturar la página anterior de la lista.

limit

Límite del número de objetos que se van a devolver. El límite puede oscilar entre 1 y 100 y el valor predeterminado es 20.

order

Ordene por la marca de tiempo created_at de los objetos. asc para orden ascendente y desc para orden descendente.

Propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

onResponse

Una función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

requestOptions

Opciones usadas al crear y enviar solicitudes HTTP para esta operación.

tracingOptions

Opciones que se usan al habilitar el seguimiento.

Detalles de las propiedades

after

Cursor para su uso en la paginación. después de es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos que terminan con obj_foo, la llamada posterior puede incluir after=obj_foo para capturar la página siguiente de la lista.

after?: string

Valor de propiedad

string

before

Cursor para su uso en la paginación. antes es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos, finalizando con obj_foo, la llamada posterior puede incluir before=obj_foo para capturar la página anterior de la lista.

before?: string

Valor de propiedad

string

limit

Límite del número de objetos que se van a devolver. El límite puede oscilar entre 1 y 100 y el valor predeterminado es 20.

limit?: number

Valor de propiedad

number

order

Ordene por la marca de tiempo created_at de los objetos. asc para orden ascendente y desc para orden descendente.

order?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

Heredado de OperationOptions.abortSignal

onResponse

Una función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

onResponse?: RawResponseCallback

Valor de propiedad

Heredado de OperationOptions.onResponse

requestOptions

Opciones usadas al crear y enviar solicitudes HTTP para esta operación.

requestOptions?: OperationRequestOptions

Valor de propiedad

Heredado de OperationOptions.requestOptions

tracingOptions

Opciones que se usan al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

Heredado de OperationOptions.tracingOptionsOptions