Compartilhar via


FavoritesListOptionalParams interface

Parâmetros opcionais.

Extends

Propriedades

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.

favoriteType

O tipo de favorito. O valor pode ser compartilhado ou usuário.

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).

tags

Marcas que devem estar presentes em cada favorito retornado.

Propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

onResponse

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para essa operação.

serializerOptions

Opções para substituir o comportamento de serialização/des serialização.

tracingOptions

Opções usadas quando o rastreamento está habilitado.

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.

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).

sourceType?: string

Valor da propriedade

string

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 coreClient.OperationOptions.abortSignal

onResponse

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor da propriedade

Herdado de coreClient.OperationOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para essa operação.

requestOptions?: OperationRequestOptions

Valor da propriedade

Herdado de coreClient.OperationOptions.requestOptions

serializerOptions

Opções para substituir o comportamento de serialização/des serialização.

serializerOptions?: SerializerOptions

Valor da propriedade

Herdado de coreClient.OperationOptions.serializerOptions

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor da propriedade

Herdado de coreClient.OperationOptions.tracingOptions