ToolboxesListOptionalParams interface

Необязательные параметры.

Extends

Свойства

after

Курсор для использования в разбиении на страницы. after — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.

before

Курсор для использования в разбиении на страницы. before — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, список заканчивается на obj_foo, ваш последующий вызов может содержать before=obj_foo, чтобы получить предыдущую страницу списка.

limit

Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.

order

Сортировка объектов по их метке времени created_at. asc для возрастания порядка иdesc для убывания.

Унаследованные свойства

abortSignal

Сигнал, который можно использовать для прерывания запросов.

onResponse

Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.

requestOptions

Параметры, используемые при создании и отправке HTTP-запросов для этой операции.

tracingOptions

Параметры, используемые при включении трассировки.

Сведения о свойстве

after

Курсор для использования в разбиении на страницы. after — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.

after?: string

Значение свойства

string

before

Курсор для использования в разбиении на страницы. before — это идентификатор объекта, определяющий место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, список заканчивается на obj_foo, ваш последующий вызов может содержать before=obj_foo, чтобы получить предыдущую страницу списка.

before?: string

Значение свойства

string

limit

Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.

limit?: number

Значение свойства

number

order

Сортировка объектов по их метке времени created_at. asc для возрастания порядка иdesc для убывания.

order?: PageOrder

Значение свойства

Сведения об унаследованном свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

наследуется от OperationOptions.abortSignal

onResponse

Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.

onResponse?: RawResponseCallback

Значение свойства

наследуется от OperationOptions.onResponse

requestOptions

Параметры, используемые при создании и отправке HTTP-запросов для этой операции.

requestOptions?: OperationRequestOptions

Значение свойства

наследуется от OperationOptions.requestOptions

tracingOptions

Параметры, используемые при включении трассировки.

tracingOptions?: OperationTracingOptions

Значение свойства

наследуется от OperationOptions.tracingOptions