FavoritesListOptionalParams interface
Необязательные параметры.
- Extends
Свойства
can |
Флаг, указывающий, следует ли возвращать полное содержимое для каждого применимого избранного. Если значение false, возвращается только содержимое сводки для избранного. |
favorite |
Тип избранного. Значение может быть общим или пользовательским. Возможные значения включают: "shared", "user". Значение по умолчанию: shared. |
source |
Тип источника избранного для возврата. В противном случае исходный тип по умолчанию имеет значение "other" (не присутствует в этой перечислении). Возможные значения: "хранение", "записная книжка", "сеансы", "события", "потоки пользователей", "воронка", "влияние", "сегментация" |
tags | Теги, которые должны присутствовать для каждого возвращаемого избранного. |
Унаследованные свойства
abort |
Сигнал, который можно использовать для прерывания запросов. |
custom |
Пользовательские заголовки запросов, которые будут применены перед отправкой запроса. |
on |
Обратный вызов, который запускается при выполнении скачивания. |
on |
Обратный вызов, который запускается при выполнении отправки. |
timeout | Число миллисекундах запроса может приниматься перед автоматическим завершением. |
Сведения о свойстве
canFetchContent
Флаг, указывающий, следует ли возвращать полное содержимое для каждого применимого избранного. Если значение false, возвращается только содержимое сводки для избранного.
canFetchContent?: boolean
Значение свойства
boolean
favoriteType
Тип избранного. Значение может быть общим или пользовательским. Возможные значения включают: "shared", "user". Значение по умолчанию: shared.
favoriteType?: FavoriteType
Значение свойства
sourceType
Тип источника избранного для возврата. В противном случае исходный тип по умолчанию имеет значение "other" (не присутствует в этой перечислении). Возможные значения: "хранение", "записная книжка", "сеансы", "события", "потоки пользователей", "воронка", "влияние", "сегментация"
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