ListMessagesOptions interface
Сведения, используемые для отображения сообщений.
- Extends
Свойства
| after | Курсор для использования в разбиении на страницы. После этого является идентификатором объекта, который определяет место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка. |
| before | Курсор для использования в разбиении на страницы. прежде чем является идентификатором объекта, который определяет место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка. |
| limit | Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20. |
| order | Сортировка по created_at метке времени объектов. asc для возрастания порядка и desc для убывающего порядка. |
Унаследованные свойства
| abort |
Сигнал, который можно использовать для прерывания запросов. |
| on |
Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз. |
| request |
Параметры, используемые при создании и отправке HTTP-запросов для этой операции. |
| tracing |
Параметры, используемые при включении трассировки. |
Сведения о свойстве
after
Курсор для использования в разбиении на страницы. После этого является идентификатором объекта, который определяет место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
after?: string
Значение свойства
string
before
Курсор для использования в разбиении на страницы. прежде чем является идентификатором объекта, который определяет место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.
before?: string
Значение свойства
string
limit
Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
limit?: number
Значение свойства
number
order
Сортировка по created_at метке времени объектов. asc для возрастания порядка и desc для убывающего порядка.
order?: string
Значение свойства
string
Сведения об унаследованном свойстве
abortSignal
Сигнал, который можно использовать для прерывания запросов.
abortSignal?: AbortSignalLike
Значение свойства
Наследуется от OperationOptions.abortSignal
onResponse
Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.
onResponse?: RawResponseCallback
Значение свойства
Наследуется от OperationOptions.onResponse
requestOptions
Параметры, используемые при создании и отправке HTTP-запросов для этой операции.
requestOptions?: OperationRequestOptions
Значение свойства
Наследуется от OperationOptions.requestOptions
tracingOptions
Параметры, используемые при включении трассировки.
tracingOptions?: OperationTracingOptions
Значение свойства
Наследуется от OperationOptions.tracingOptions