FavoritesListOptionalParams interface
Parâmetros opcionais.
- Extends
Propriedades
can |
Sinalizador que indica se o conteúdo completo deve ou não ser retornado para cada favorito aplicável. Se for falso, retorne apenas o conteúdo de resumo para favoritos. |
favorite |
O tipo de favorito. O valor pode ser compartilhado ou usuário. Os valores possíveis incluem: 'shared', 'user'. Valor padrão: 'compartilhado'. |
source |
Tipo de origem do favorito a ser retornado. Quando deixado de fora, o tipo de origem usa como padrão 'other' (não está presente nesta enumeração). Os valores possíveis incluem: 'retention', 'notebook', 'sessions', 'events', 'userflows', 'funnel', 'impact', 'segmentation' |
tags | Marcas que devem estar presentes em cada favorito retornado. |
Propriedades herdadas
abort |
O sinal que pode ser usado para anular solicitações. |
custom |
Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação. |
on |
Retorno de chamada que é acionado após o progresso do download. |
on |
Retorno de chamada que é acionado após o progresso do upload. |
timeout | O número de milissegundos que uma solicitação pode fazer antes de ser encerrada automaticamente. |
Detalhes da propriedade
canFetchContent
Sinalizador que indica se o conteúdo completo deve ou não ser retornado para cada favorito aplicável. Se for falso, retorne apenas o conteúdo de resumo para favoritos.
canFetchContent?: boolean
Valor da propriedade
boolean
favoriteType
O tipo de favorito. O valor pode ser compartilhado ou usuário. Os valores possíveis incluem: 'shared', 'user'. Valor padrão: 'compartilhado'.
favoriteType?: FavoriteType
Valor da propriedade
sourceType
Tipo de origem do favorito a ser retornado. Quando deixado de fora, o tipo de origem usa como padrão 'other' (não está presente nesta enumeração). Os valores possíveis incluem: 'retention', 'notebook', 'sessions', 'events', 'userflows', 'funnel', 'impact', 'segmentation'
sourceType?: FavoriteSourceType
Valor da propriedade
tags
Marcas que devem estar presentes em cada favorito retornado.
tags?: string[]
Valor da propriedade
string[]
Detalhes das propriedades herdadas
abortSignal
O sinal que pode ser usado para anular solicitações.
abortSignal?: AbortSignalLike
Valor da propriedade
Herdado de msRest.RequestOptionsBase.abortSignal
customHeaders
Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.
customHeaders?: {[key: string]: string}
Valor da propriedade
{[key: string]: string}
Herdado de msRest.RequestOptionsBase.customHeaders
onDownloadProgress
Retorno de chamada que é acionado após o progresso do download.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Valor da propriedade
(progress: TransferProgressEvent) => void
Herdado de msRest.RequestOptionsBase.onDownloadProgress
onUploadProgress
Retorno de chamada que é acionado após o progresso do upload.
onUploadProgress?: (progress: TransferProgressEvent) => void
Valor da propriedade
(progress: TransferProgressEvent) => void
herdado de msRest.RequestOptionsBase.onUploadProgress
timeout
O número de milissegundos que uma solicitação pode fazer antes de ser encerrada automaticamente.
timeout?: number
Valor da propriedade
number
Herdado de msRest.RequestOptionsBase.timeout