FavoritesListOptionalParams interface
Parametry opcjonalne.
- Rozszerzenie
Właściwości
| can |
Flaga wskazująca, czy zwracać pełną zawartość dla każdego odpowiedniego ulubionego. Jeśli wartość false, zwraca tylko zawartość podsumowania dla ulubionych. |
| favorite |
Typ ulubionego. Wartość może być współdzielona lub użytkownikiem. |
| source |
Typ źródła ulubionego do zwrócenia. Po pomiń typ źródła jest domyślnie "inny" (nie ma go w tym wyliczeniem). |
| tags | Tagi, które muszą być obecne dla każdego zwróconego ulubionego elementu. |
Właściwości dziedziczone
| abort |
Sygnał, który może służyć do przerwania żądań. |
| on |
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. |
| request |
Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji. |
| serializer |
Opcje zastępowania zachowania serializacji/deseralizacji. |
| tracing |
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ć współdzielona lub użytkownikiem.
favoriteType?: FavoriteType
Wartość właściwości
sourceType
Typ źródła ulubionego do zwrócenia. Po pomiń typ źródła jest domyślnie "inny" (nie ma go w tym wyliczeniem).
sourceType?: string
Wartość właściwości
string
tags
Tagi, które muszą być obecne dla każdego zwróconego ulubionego elementu.
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ępowania zachowania serializacji/deseralizacji.
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