Delen via


FavoritesListOptionalParams interface

Optionele parameters.

Uitbreiding

Eigenschappen

canFetchContent

Vlag die aangeeft of de volledige inhoud voor elke toepasselijke favoriet moet worden geretourneerd. Als dit onwaar is, retourneert u alleen samenvattingsinhoud voor favorieten.

favoriteType

Het type favoriet. Waarde kan worden gedeeld of door de gebruiker. Mogelijke waarden zijn: 'gedeeld', 'gebruiker'. Standaardwaarde: 'gedeeld'.

sourceType

Brontype van favoriet dat moet worden geretourneerd. Als u dit weggelaten hebt, wordt het brontype standaard ingesteld op 'other' (niet aanwezig in deze enum). Mogelijke waarden zijn: 'retention', 'notebook', 'sessions', 'events', 'userflows', 'trechter', 'impact', 'segmentatie'

tags

Tags die aanwezig moeten zijn op elke geretourneerde favoriet.

Overgenomen eigenschappen

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

customHeaders

Door de gebruiker gedefinieerde aangepaste aanvraagheaders die worden toegepast voordat de aanvraag wordt verzonden.

onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.

onUploadProgress

Callback die wordt geactiveerd bij het uploaden.

timeout

Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beƫindigd.

Eigenschapdetails

canFetchContent

Vlag die aangeeft of de volledige inhoud voor elke toepasselijke favoriet moet worden geretourneerd. Als dit onwaar is, retourneert u alleen samenvattingsinhoud voor favorieten.

canFetchContent?: boolean

Waarde van eigenschap

boolean

favoriteType

Het type favoriet. Waarde kan worden gedeeld of door de gebruiker. Mogelijke waarden zijn: 'gedeeld', 'gebruiker'. Standaardwaarde: 'gedeeld'.

favoriteType?: FavoriteType

Waarde van eigenschap

sourceType

Brontype van favoriet dat moet worden geretourneerd. Als u dit weggelaten hebt, wordt het brontype standaard ingesteld op 'other' (niet aanwezig in deze enum). Mogelijke waarden zijn: 'retention', 'notebook', 'sessions', 'events', 'userflows', 'trechter', 'impact', 'segmentatie'

sourceType?: FavoriteSourceType

Waarde van eigenschap

tags

Tags die aanwezig moeten zijn op elke geretourneerde favoriet.

tags?: string[]

Waarde van eigenschap

string[]

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

overgenomen van msRest.RequestOptionsBase.abortSignal

customHeaders

Door de gebruiker gedefinieerde aangepaste aanvraagheaders die worden toegepast voordat de aanvraag wordt verzonden.

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

Waarde van eigenschap

{[key: string]: string}

overgenomen van msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

overgenomen van msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback die wordt geactiveerd bij het uploaden.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

overgenomen van msRest.RequestOptionsBase.onUploadProgress

timeout

Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beƫindigd.

timeout?: number

Waarde van eigenschap

number

overgenomen van msRest.RequestOptionsBase.timeout