Dela via


FavoritesListOptionalParams interface

Valfria parametrar.

Extends

Egenskaper

canFetchContent

Flagga som anger om det fullständiga innehållet för varje tillämplig favorit ska returneras eller inte. Om det är falskt returnerar du endast sammanfattningsinnehåll för favoriter.

favoriteType

Typ av favorit. Värdet kan vara antingen delat eller användare. Möjliga värden är: "delad", "användare". Standardvärde: "delad".

sourceType

Källtyp av favorit att returnera. När källtypen utelämnas är den som standard "annan" (finns inte i den här uppräkningen). Möjliga värden är: "retention", "notebook", "sessions", "events", "userflows", "tratt", "impact", "segmentering"

tags

Taggar som måste finnas på varje favorit som returneras.

Ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.

customHeaders

Användardefinierade anpassade begärandehuvuden som ska tillämpas innan begäran skickas.

onDownloadProgress

Återanrop som utlöses när nedladdningen förlopp.

onUploadProgress

Återanrop som utlöses när uppladdningen förlopp.

timeout

Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt.

Egenskapsinformation

canFetchContent

Flagga som anger om det fullständiga innehållet för varje tillämplig favorit ska returneras eller inte. Om det är falskt returnerar du endast sammanfattningsinnehåll för favoriter.

canFetchContent?: boolean

Egenskapsvärde

boolean

favoriteType

Typ av favorit. Värdet kan vara antingen delat eller användare. Möjliga värden är: "delad", "användare". Standardvärde: "delad".

favoriteType?: FavoriteType

Egenskapsvärde

sourceType

Källtyp av favorit att returnera. När källtypen utelämnas är den som standard "annan" (finns inte i den här uppräkningen). Möjliga värden är: "retention", "notebook", "sessions", "events", "userflows", "tratt", "impact", "segmentering"

sourceType?: FavoriteSourceType

Egenskapsvärde

tags

Taggar som måste finnas på varje favorit som returneras.

tags?: string[]

Egenskapsvärde

string[]

Information om ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.

abortSignal?: AbortSignalLike

Egenskapsvärde

ärvd från msRest.RequestOptionsBase.abortSignal

customHeaders

Användardefinierade anpassade begärandehuvuden som ska tillämpas innan begäran skickas.

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

Egenskapsvärde

{[key: string]: string}

ärvd från msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Återanrop som utlöses när nedladdningen förlopp.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

ärvd från msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Återanrop som utlöses när uppladdningen förlopp.

onUploadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

ärvd från msRest.RequestOptionsBase.onUploadProgress

timeout

Antalet millisekunder som en begäran kan ta innan den avslutas automatiskt.

timeout?: number

Egenskapsvärde

number

ärvs från msRest.RequestOptionsBase.timeout