Поделиться через


FavoritesListOptionalParams interface

Дополнительные параметры.

Extends

Свойства

canFetchContent

Флаг, указывающий, следует ли возвращать полное содержимое для каждого применимого избранного. Если задано значение false, возвращается только сводка содержимого для избранного.

favoriteType

Тип избранного. Значение может быть общим или пользовательским.

sourceType

Возвращаемый тип источника избранного. Если этот параметр не задан, тип источника по умолчанию имеет значение other (отсутствует в этом перечислении).

tags

Теги, которые должны присутствовать в каждом возвращенном избранном.

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

abortSignal

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

onResponse

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

requestOptions

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

serializerOptions

Параметры для переопределения поведения сериализации или десериализации.

tracingOptions

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

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

canFetchContent

Флаг, указывающий, следует ли возвращать полное содержимое для каждого применимого избранного. Если задано значение false, возвращается только сводка содержимого для избранного.

canFetchContent?: boolean

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

boolean

favoriteType

Тип избранного. Значение может быть общим или пользовательским.

favoriteType?: FavoriteType

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

sourceType

Возвращаемый тип источника избранного. Если этот параметр не задан, тип источника по умолчанию имеет значение other (отсутствует в этом перечислении).

sourceType?: string

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

string

tags

Теги, которые должны присутствовать в каждом возвращенном избранном.

tags?: string[]

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

string[]

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

abortSignal

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

abortSignal?: AbortSignalLike

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

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

onResponse

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

onResponse?: RawResponseCallback

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

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

requestOptions

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

requestOptions?: OperationRequestOptions

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

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

serializerOptions

Параметры для переопределения поведения сериализации или десериализации.

serializerOptions?: SerializerOptions

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

Наследуется от coreClient.OperationOptions.serializerOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

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

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