QueryFilter interface
Um filtro utilizado para definir um conjunto de extensões a devolver durante uma consulta.
Propriedades
| criteria | Os valores de filtro definem o conjunto de valores nesta consulta. São aplicados com base no QueryFilterType. |
| direction | A PagingDirection é aplicada a um token de paginação, se existir. Caso contrário, a direção é ignorada e é utilizada a opção Reencaminhar desde o início do conjunto de resultados. A direção deve ficar de fora do pedido, a menos que seja utilizado um token de paginação para ajudar a evitar problemas futuros. |
| page |
O número de página pedido pelo utilizador. Se não for fornecido 1, é assumido por predefinição. |
| page |
O tamanho da página define o número de resultados que o autor da chamada quer para este filtro. A contagem não pode exceder os limites gerais de tamanho da consulta. |
| paging |
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 o resultado e os campos que estão a ser filtrados estão incorporadas no token. |
| sort |
Define o tipo de ordenação a aplicar nos resultados. O setor de página é cortado apenas dos resultados ordenados. |
| sort |
Define a ordem de ordenação, 1 para Ascendente, 2 para Ordenação descendente, outra predefinição com base no valor SortBy |
Detalhes de Propriedade
criteria
Os valores de filtro definem o conjunto de valores nesta consulta. São aplicados com base no QueryFilterType.
criteria: FilterCriteria[]Valor de Propriedade
direction
A PagingDirection é aplicada a um token de paginação, se existir. Caso contrário, a direção é ignorada e é utilizada a opção Reencaminhar desde o início do conjunto de resultados. A direção deve ficar de fora do pedido, a menos que seja utilizado um token de paginação para ajudar a evitar problemas futuros.
direction: PagingDirectionValor de Propriedade
pageNumber
O número de página pedido pelo utilizador. Se não for fornecido 1, é assumido por predefinição.
pageNumber: numberValor de Propriedade
number
pageSize
O tamanho da página define o número de resultados que o autor da chamada quer para este filtro. A contagem não pode exceder os limites gerais de tamanho da consulta.
pageSize: numberValor de 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 o resultado e os campos que estão a ser filtrados estão incorporadas no token.
pagingToken: stringValor de Propriedade
string
sortBy
Define o tipo de ordenação a aplicar nos resultados. O setor de página é cortado apenas dos resultados ordenados.
sortBy: numberValor de Propriedade
number
sortOrder
Define a ordem de ordenação, 1 para Ascendente, 2 para Ordenação descendente, outra predefinição com base no valor SortBy
sortOrder: numberValor de Propriedade
number