FavoritesListOptionalParams interface
Parámetros opcionales
- Extends
Propiedades
can |
Marca que indica si se va a devolver o no el contenido completo de cada favorito aplicable. Si es false, solo devuelve contenido de resumen para favoritos. |
favorite |
Tipo de favorito. El valor puede ser compartido o usuario. Entre los valores posibles se incluyen: "shared", "user". Valor predeterminado: "shared". |
source |
Tipo de origen de favorito que se va a devolver. Cuando se deja fuera, el tipo de origen tiene como valor predeterminado "other" (no está presente en esta enumeración). Entre los valores posibles se incluyen: 'retention', 'notebook', 'sessions', 'events', 'userflows', 'embudo', 'impact', 'segmentation' |
tags | Etiquetas que deben estar presentes en cada favorito devuelto. |
Propiedades heredadas
abort |
Señal que se puede usar para anular las solicitudes. |
custom |
Encabezados de solicitud personalizados definidos por el usuario que se aplicarán antes de enviar la solicitud. |
on |
Devolución de llamada que se desencadena tras el progreso de la descarga. |
on |
Devolución de llamada que se desencadena tras el progreso de la carga. |
timeout | El número de milisegundos que puede tomar una solicitud antes de finalizarse automáticamente. |
Detalles de las propiedades
canFetchContent
Marca que indica si se va a devolver o no el contenido completo de cada favorito aplicable. Si es false, solo devuelve contenido de resumen para favoritos.
canFetchContent?: boolean
Valor de propiedad
boolean
favoriteType
Tipo de favorito. El valor puede ser compartido o usuario. Entre los valores posibles se incluyen: "shared", "user". Valor predeterminado: "shared".
favoriteType?: FavoriteType
Valor de propiedad
sourceType
Tipo de origen de favorito que se va a devolver. Cuando se deja fuera, el tipo de origen tiene como valor predeterminado "other" (no está presente en esta enumeración). Entre los valores posibles se incluyen: 'retention', 'notebook', 'sessions', 'events', 'userflows', 'embudo', 'impact', 'segmentation'
sourceType?: FavoriteSourceType
Valor de propiedad
tags
Etiquetas que deben estar presentes en cada favorito devuelto.
tags?: string[]
Valor de propiedad
string[]
Detalles de las propiedades heredadas
abortSignal
Señal que se puede usar para anular las solicitudes.
abortSignal?: AbortSignalLike
Valor de propiedad
Heredado de msRest.RequestOptionsBase.abortSignal
customHeaders
Encabezados de solicitud personalizados definidos por el usuario que se aplicarán antes de enviar la solicitud.
customHeaders?: {[key: string]: string}
Valor de propiedad
{[key: string]: string}
Heredado de msRest.RequestOptionsBase.customHeaders
onDownloadProgress
Devolución de llamada que se desencadena tras el progreso de la descarga.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Valor de propiedad
(progress: TransferProgressEvent) => void
Heredado de msRest.RequestOptionsBase.onDownloadProgress
onUploadProgress
Devolución de llamada que se desencadena tras el progreso de la carga.
onUploadProgress?: (progress: TransferProgressEvent) => void
Valor de propiedad
(progress: TransferProgressEvent) => void
Heredado de msRest.RequestOptionsBase.onUploadProgress
timeout
El número de milisegundos que puede tomar una solicitud antes de finalizarse automáticamente.
timeout?: number
Valor de propiedad
number
Heredado de msRest.RequestOptionsBase.timeout