Udostępnij za pośrednictwem


FavoritesListOptionalParams interface

Parametry opcjonalne.

Extends

Właściwości

canFetchContent

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

favoriteType

Typ ulubionego. Wartość może być współdzielona lub użytkownik. Możliwe wartości to: "shared", "user". Wartość domyślna: "shared".

sourceType

Typ źródła ulubionego do zwrócenia. Po lewej stronie typ źródła domyślnie ma wartość "other" (nie występuje w tym wyliczenie). Możliwe wartości to: "retention", "notebook", "sessions", "events", "userflows", "funnel", "impact", "segmentation"

tags

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

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 będą stosowane 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 żądanie może potrwać przed automatycznym zakończeniem.

Szczegóły właściwości

canFetchContent

Flaga wskazująca, czy ma być zwracana pełna zawartość dla każdego odpowiedniego elementu 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żytkownik. 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 lewej stronie typ źródła domyślnie ma wartość "other" (nie występuje w tym wyliczenie). Możliwe wartości to: "retention", "notebook", "sessions", "events", "userflows", "funnel", "impact", "segmentation"

sourceType?: FavoriteSourceType

Wartość właściwości

tags

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

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 będą stosowane 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 żądanie może potrwać przed automatycznym zakończeniem.

timeout?: number

Wartość właściwości

number

Dziedziczone z msRest.RequestOptionsBase.timeout