Partager via


FavoritesListOptionalParams interface

Paramètres facultatifs.

Extends

Propriétés

canFetchContent

Indicateur indiquant s’il faut retourner ou non le contenu complet de chaque favori applicable. Si la valeur est false, renvoyez uniquement le contenu récapitulatif des favoris.

favoriteType

Type de favori. La valeur peut être partagée ou utilisateur. Les valeurs possibles sont les suivantes : « shared », « user ». Valeur par défaut : 'shared'.

sourceType

Type de source du favori à retourner. Lorsqu’il est omis, le type source est défini par défaut sur « other » (non présent dans cette énumération). Les valeurs possibles sont les suivantes : « retention », « notebook », « sessions », « events », « userflows », « funnel », « impact », « segmentation »

tags

Balises qui doivent être présentes sur chaque favori retourné.

Propriétés héritées

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

customHeaders

En-têtes de requête personnalisés définis par l’utilisateur qui seront appliqués avant l’envoi de la demande.

onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.

onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.

timeout

Nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement.

Détails de la propriété

canFetchContent

Indicateur indiquant s’il faut retourner ou non le contenu complet de chaque favori applicable. Si la valeur est false, renvoyez uniquement le contenu récapitulatif des favoris.

canFetchContent?: boolean

Valeur de propriété

boolean

favoriteType

Type de favori. La valeur peut être partagée ou utilisateur. Les valeurs possibles sont les suivantes : « shared », « user ». Valeur par défaut : 'shared'.

favoriteType?: FavoriteType

Valeur de propriété

sourceType

Type de source du favori à retourner. Lorsqu’il est omis, le type source est défini par défaut sur « other » (non présent dans cette énumération). Les valeurs possibles sont les suivantes : « retention », « notebook », « sessions », « events », « userflows », « funnel », « impact », « segmentation »

sourceType?: FavoriteSourceType

Valeur de propriété

tags

Balises qui doivent être présentes sur chaque favori retourné.

tags?: string[]

Valeur de propriété

string[]

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

Hérité de msRest.RequestOptionsBase.abortSignal

customHeaders

En-têtes de requête personnalisés définis par l’utilisateur qui seront appliqués avant l’envoi de la demande.

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

Valeur de propriété

{[key: string]: string}

Hérité de msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

Hérité de msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

Hérité de msRest.RequestOptionsBase.onUploadProgress

timeout

Nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement.

timeout?: number

Valeur de propriété

number

Hérité de msRest.RequestOptionsBase.timeout