FavoritesListOptionalParams interface
選擇性參數。
- Extends
屬性
can |
旗標,指出是否要傳回每個適用我的最愛的完整內容。 如果為 false,則只會傳回我的最愛摘要內容。 |
favorite |
我的最愛類型。 值可以是共用或使用者。 可能的值包括:'shared'、'user'。 預設值:'shared'。 |
source |
要傳回之我的最愛來源類型。 當離開時,來源類型預設為 'other' (在此列舉中不存在) 。 可能的值包括:'retention'、'notebook'、'sessions'、'events'、'userflows'、'漏斗圖'、'影響'、'分割' |
tags | 每個傳回的我的最愛上都必須存在的標記。 |
繼承的屬性
abort |
可用來中止要求的訊號。 |
custom |
使用者定義自訂要求標頭,會在傳送要求之前套用。 |
on |
下載進度時引發的回呼。 |
on |
上傳進度時引發的回呼。 |
timeout | 要求可能需要的毫秒數,才能自動終止。 |
屬性詳細資料
canFetchContent
旗標,指出是否要傳回每個適用我的最愛的完整內容。 如果為 false,則只會傳回我的最愛摘要內容。
canFetchContent?: boolean
屬性值
boolean
favoriteType
我的最愛類型。 值可以是共用或使用者。 可能的值包括:'shared'、'user'。 預設值:'shared'。
favoriteType?: FavoriteType
屬性值
sourceType
要傳回之我的最愛來源類型。 當離開時,來源類型預設為 'other' (在此列舉中不存在) 。 可能的值包括:'retention'、'notebook'、'sessions'、'events'、'userflows'、'漏斗圖'、'影響'、'分割'
sourceType?: FavoriteSourceType
屬性值
tags
每個傳回的我的最愛上都必須存在的標記。
tags?: string[]
屬性值
string[]
繼承的屬性詳細資料
abortSignal
可用來中止要求的訊號。
abortSignal?: AbortSignalLike
屬性值
繼承自 msRest.RequestOptionsBase.abortSignal
customHeaders
使用者定義自訂要求標頭,會在傳送要求之前套用。
customHeaders?: {[key: string]: string}
屬性值
{[key: string]: string}
繼承自 msRest.RequestOptionsBase.customHeaders
onDownloadProgress
下載進度時引發的回呼。
onDownloadProgress?: (progress: TransferProgressEvent) => void
屬性值
(progress: TransferProgressEvent) => void
繼承自 msRest.RequestOptionsBase.onDownloadProgress
onUploadProgress
上傳進度時引發的回呼。
onUploadProgress?: (progress: TransferProgressEvent) => void
屬性值
(progress: TransferProgressEvent) => void
繼承自 msRest.RequestOptionsBase.onUploadProgress
timeout
要求可能需要的毫秒數,才能自動終止。
timeout?: number
屬性值
number
繼承自 msRest.RequestOptionsBase.timeout