FavoritesListOptionalParams interface

Optional parameters.

Extends

Properties

canFetchContent

Flag indicating whether or not to return the full content for each applicable favorite. If false, only return summary content for favorites.

favoriteType

The type of favorite. Value can be either shared or user.

sourceType

Source type of favorite to return. When left out, the source type defaults to 'other' (not present in this enum).

tags

Tags that must be present on each favorite returned.

Inherited Properties

abortSignal

The signal which can be used to abort requests.

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

requestOptions

Options used when creating and sending HTTP requests for this operation.

serializerOptions

Options to override serialization/de-serialization behavior.

tracingOptions

Options used when tracing is enabled.

Property Details

canFetchContent

Flag indicating whether or not to return the full content for each applicable favorite. If false, only return summary content for favorites.

canFetchContent?: boolean

Property Value

boolean

favoriteType

The type of favorite. Value can be either shared or user.

favoriteType?: FavoriteType

Property Value

sourceType

Source type of favorite to return. When left out, the source type defaults to 'other' (not present in this enum).

sourceType?: string

Property Value

string

tags

Tags that must be present on each favorite returned.

tags?: string[]

Property Value

string[]

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

Inherited From coreClient.OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

Inherited From coreClient.OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

Inherited From coreClient.OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

Inherited From coreClient.OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

Inherited From coreClient.OperationOptions.tracingOptions