Freigeben über


FavoritesListOptionalParams interface

Optionale Parameter.

Extends

Eigenschaften

canFetchContent

Flag, das angibt, ob der vollständige Inhalt für jeden anwendbaren Favoriten zurückgegeben werden soll. Wenn false, wird nur Zusammenfassungsinhalt für Favoriten zurückgegeben.

favoriteType

Der Typ des Favoriten. Der Wert kann entweder freigegeben oder benutzerseitig sein. Mögliche Werte sind: "shared", "user". Standardwert: "shared".

sourceType

Quelltyp des zurückzugebenden Favoriten. Wenn er weggelassen wird, wird der Quelltyp standardmäßig auf "other" (in dieser Enumeration nicht vorhanden) festgelegt. Mögliche Werte: "retention", "notebook", "sessions", "events", "userflows", "funnel", "impact", "segmentation"

tags

Tags, die für jeden zurückgegebenen Favoriten vorhanden sein müssen.

Geerbte Eigenschaften

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

customHeaders

Benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onUploadProgress

Rückruf, der beim Uploadvorgang ausgelöst wird.

timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

Details zur Eigenschaft

canFetchContent

Flag, das angibt, ob der vollständige Inhalt für jeden anwendbaren Favoriten zurückgegeben werden soll. Wenn false, wird nur Zusammenfassungsinhalt für Favoriten zurückgegeben.

canFetchContent?: boolean

Eigenschaftswert

boolean

favoriteType

Der Typ des Favoriten. Der Wert kann entweder freigegeben oder benutzerseitig sein. Mögliche Werte sind: "shared", "user". Standardwert: "shared".

favoriteType?: FavoriteType

Eigenschaftswert

sourceType

Quelltyp des zurückzugebenden Favoriten. Wenn er weggelassen wird, wird der Quelltyp standardmäßig auf "other" (in dieser Enumeration nicht vorhanden) festgelegt. Mögliche Werte: "retention", "notebook", "sessions", "events", "userflows", "funnel", "impact", "segmentation"

sourceType?: FavoriteSourceType

Eigenschaftswert

tags

Tags, die für jeden zurückgegebenen Favoriten vorhanden sein müssen.

tags?: string[]

Eigenschaftswert

string[]

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

Geerbt von msRest.RequestOptionsBase.abortSignal

customHeaders

Benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.

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

Eigenschaftswert

{[key: string]: string}

Geerbt von msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Rückruf, der beim Uploadvorgang ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von msRest.RequestOptionsBase.onUploadProgress

timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

timeout?: number

Eigenschaftswert

number

Geerbt von msRest.RequestOptionsBase.timeout