Udostępnij za pośrednictwem


FavoritesListOptionalParams interface

Parametry opcjonalne.

Rozszerzenie

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ć współdzielona lub użytkownikiem. Możliwe wartości to: "shared", "user". Wartość domyślna: "shared".

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). Możliwe wartości to: "retention", "notebook", "sessions", "events", "userflows", "lejek", "impact", "segmentacja"

tags

Tagi, które muszą być obecne dla każdego zwróconego ulubionego elementu.

Właściwości dziedziczone

abortSignal

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

customHeaders

Niestandardowe nagłówki żądań zdefiniowane przez użytkownika, które zostaną zastosowane przed wysłaniem żądania.

onDownloadProgress

Wywołanie zwrotne uruchamiane po postępie pobierania.

onUploadProgress

Wywołanie zwrotne uruchamiane po postępie przekazywania.

timeout

Liczba milisekund, które może przyjąć żądanie przed automatycznym zakończeniem.

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. Możliwe wartości to: "shared", "user". Wartość domyślna: "shared".

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). Możliwe wartości to: "retention", "notebook", "sessions", "events", "userflows", "lejek", "impact", "segmentacja"

sourceType?: FavoriteSourceType

Wartość właściwości

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 msRest.RequestOptionsBase.abortSignal

customHeaders

Niestandardowe nagłówki żądań zdefiniowane przez użytkownika, które zostaną zastosowane przed wysłaniem żądania.

customHeaders?: {[key: string]: string}

Wartość właściwości

{[key: string]: string}

dziedziczone z msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Wywołanie zwrotne uruchamiane po postępie pobierania.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

dziedziczone z msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Wywołanie zwrotne uruchamiane po postępie przekazywania.

onUploadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

dziedziczone z msRest.RequestOptionsBase.onUploadProgress

timeout

Liczba milisekund, które może przyjąć żądanie przed automatycznym zakończeniem.

timeout?: number

Wartość właściwości

number

dziedziczone z msRest.RequestOptionsBase.timeout