Udostępnij za pośrednictwem


FavoritesListOptionalParams interface

Parametry opcjonalne.

Extends

Właściwości

canFetchContent

Flaga wskazująca, czy zwracać pełną zawartość dla każdego odpowiedniego ulubionego. Jeśli wartość false, zwraca tylko zawartość podsumowania dla ulubionych.

favoriteType

Typ ulubionego. Wartość może być udostępniona lub użytkownik.

sourceType

Typ źródła ulubionego do zwrócenia. W przypadku pomiń typ źródłowy domyślnie ma wartość "other" (nie ma jej w tym wyliczeniem).

tags

Tagi, które muszą być obecne w każdym zwracanym faworytze.

Właściwości dziedziczone

abortSignal

Sygnał, który może służyć do przerwania żądań.

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

serializerOptions

Opcje zastąpienia zachowania serializacji/de serializacji.

tracingOptions

Opcje używane podczas śledzenia są włączone.

Szczegóły właściwości

canFetchContent

Flaga wskazująca, czy zwracać pełną zawartość dla każdego odpowiedniego ulubionego. Jeśli wartość false, zwraca tylko zawartość podsumowania dla ulubionych.

canFetchContent?: boolean

Wartość właściwości

boolean

favoriteType

Typ ulubionego. Wartość może być udostępniona lub użytkownik.

favoriteType?: FavoriteType

Wartość właściwości

sourceType

Typ źródła ulubionego do zwrócenia. W przypadku pomiń typ źródłowy domyślnie ma wartość "other" (nie ma jej w tym wyliczeniem).

sourceType?: string

Wartość właściwości

string

tags

Tagi, które muszą być obecne w każdym zwracanym faworytze.

tags?: string[]

Wartość właściwości

string[]

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

Dziedziczone z coreClient.OperationOptions.abortSignal

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

onResponse?: RawResponseCallback

Wartość właściwości

Dziedziczone z coreClient.OperationOptions.onResponse

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

requestOptions?: OperationRequestOptions

Wartość właściwości

Dziedziczone z coreClient.OperationOptions.requestOptions

serializerOptions

Opcje zastąpienia zachowania serializacji/de serializacji.

serializerOptions?: SerializerOptions

Wartość właściwości

Dziedziczone z coreClient.OperationOptions.serializerOptions

tracingOptions

Opcje używane podczas śledzenia są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

Dziedziczone z coreClient.OperationOptions.tracingOptions