Compartilhar via


QueryFilter interface

Um filtro usado para definir um conjunto de extensões a serem retornadas durante uma consulta.

Propriedades

criteria

Os valores de filtro definem o conjunto de valores nesta consulta. Eles são aplicados com base no QueryFilterType.

direction

O PagingDirection será aplicado a um token de paginação, se houver. Se não for, a direção será ignorada e Avançar desde o início do conjunto de resultados será usado. A direção deve ser deixada de fora da solicitação, a menos que um token de paginação seja usado para ajudar a evitar problemas futuros.

pageNumber

O número de página solicitado pelo usuário. Se não for fornecido, 1 será assumido por padrão.

pageSize

O tamanho da página define o número de resultados desejados pelo chamador para esse filtro. A contagem não pode exceder os limites gerais de tamanho de consulta.

pagingToken

O token de paginação é um tipo distinto de filtro e os outros campos de filtro são ignorados. O token de paginação representa a continuação de uma consulta executada anteriormente. As informações sobre onde no resultado e quais campos estão sendo filtrados são inseridas no token.

sortBy

Define o tipo de classificação a ser aplicado nos resultados. A fatia de página é cortada somente dos resultados classificados.

sortOrder

Define a ordem de classificação, 1 para Crescente, 2 para Decrescente, caso contrário, ordenação padrão com base no valor SortBy

Detalhes da propriedade

criteria

Os valores de filtro definem o conjunto de valores nesta consulta. Eles são aplicados com base no QueryFilterType.

criteria: FilterCriteria[]

Valor da propriedade

direction

O PagingDirection será aplicado a um token de paginação, se houver. Se não for, a direção será ignorada e Avançar desde o início do conjunto de resultados será usado. A direção deve ser deixada de fora da solicitação, a menos que um token de paginação seja usado para ajudar a evitar problemas futuros.

direction: PagingDirection

Valor da propriedade

pageNumber

O número de página solicitado pelo usuário. Se não for fornecido, 1 será assumido por padrão.

pageNumber: number

Valor da propriedade

number

pageSize

O tamanho da página define o número de resultados desejados pelo chamador para esse filtro. A contagem não pode exceder os limites gerais de tamanho de consulta.

pageSize: number

Valor da propriedade

number

pagingToken

O token de paginação é um tipo distinto de filtro e os outros campos de filtro são ignorados. O token de paginação representa a continuação de uma consulta executada anteriormente. As informações sobre onde no resultado e quais campos estão sendo filtrados são inseridas no token.

pagingToken: string

Valor da propriedade

string

sortBy

Define o tipo de classificação a ser aplicado nos resultados. A fatia de página é cortada somente dos resultados classificados.

sortBy: number

Valor da propriedade

number

sortOrder

Define a ordem de classificação, 1 para Crescente, 2 para Decrescente, caso contrário, ordenação padrão com base no valor SortBy

sortOrder: number

Valor da propriedade

number