FavoritesListOptionalParams interface
Valfria parametrar.
- Extends
Egenskaper
can |
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 bara sammanfattningsinnehåll för favoriter. |
favorite |
Typ av favorit. Värdet kan vara antingen delat eller användare. Möjliga värden är: "delad", "användare". Standardvärde: "delad". |
source |
Källtyp som ska returneras. 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 returneras. |
Ärvda egenskaper
abort |
Den signal som kan användas för att avbryta begäranden. |
custom |
Användardefinierade anpassade begärandehuvuden som ska tillämpas innan begäran skickas. |
on |
Återanrop som utlöses vid nedladdningsframställning. |
on |
Återanrop som utlöses vid uppladdningens 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 bara 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 som ska returneras. 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 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 vid nedladdningsframställning.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Egenskapsvärde
(progress: TransferProgressEvent) => void
Ärvd från msRest.RequestOptionsBase.onDownloadProgress
onUploadProgress
Återanrop som utlöses vid uppladdningens 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
Ärvd från msRest.RequestOptionsBase.timeout