FavoritesListOptionalParams interface
可选参数。
属性
| 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