QueryFilter interface
Filtro que se usa para definir un conjunto de extensiones que se van a devolver durante una consulta.
Propiedades
| criteria | Los valores de filtro definen el conjunto de valores de esta consulta. Se aplican en función de QueryFilterType. |
| direction | PagingDirection se aplica a un token de paginación si existe. Si no es así, se omite la dirección y se usa Forward desde el inicio del conjunto de resultados. La dirección debe dejarse fuera de la solicitud a menos que se use un token de paginación para ayudar a evitar problemas futuros. |
| page |
El número de página solicitado por el usuario. Si no se proporciona, se asume 1 de forma predeterminada. |
| page |
El tamaño de página define el número de resultados que la persona que llama desea para este filtro. El recuento no puede superar los límites generales de tamaño de consulta. |
| paging |
El token de paginación es un tipo distinto de filtro y se omiten los demás campos de filtro. El token de paginación representa la continuación de una consulta ejecutada anteriormente. La información sobre dónde en el resultado y qué campos se filtran se incrustan en el token. |
| sort |
Define el tipo de ordenación que se aplicará a los resultados. El segmento de página se corta solo de los resultados ordenados. |
| sort |
Define el orden de ordenación, 1 para Ascendente, 2 para Descendente, de lo contrario, el orden predeterminado basado en el valor SortBy |
Detalles de las propiedades
criteria
Los valores de filtro definen el conjunto de valores de esta consulta. Se aplican en función de QueryFilterType.
criteria: FilterCriteria[]
Valor de propiedad
direction
PagingDirection se aplica a un token de paginación si existe. Si no es así, se omite la dirección y se usa Forward desde el inicio del conjunto de resultados. La dirección debe dejarse fuera de la solicitud a menos que se use un token de paginación para ayudar a evitar problemas futuros.
direction: PagingDirection
Valor de propiedad
pageNumber
El número de página solicitado por el usuario. Si no se proporciona, se asume 1 de forma predeterminada.
pageNumber: number
Valor de propiedad
number
pageSize
El tamaño de página define el número de resultados que la persona que llama desea para este filtro. El recuento no puede superar los límites generales de tamaño de consulta.
pageSize: number
Valor de propiedad
number
pagingToken
El token de paginación es un tipo distinto de filtro y se omiten los demás campos de filtro. El token de paginación representa la continuación de una consulta ejecutada anteriormente. La información sobre dónde en el resultado y qué campos se filtran se incrustan en el token.
pagingToken: string
Valor de propiedad
string
sortBy
Define el tipo de ordenación que se aplicará a los resultados. El segmento de página se corta solo de los resultados ordenados.
sortBy: number
Valor de propiedad
number
sortOrder
Define el orden de ordenación, 1 para Ascendente, 2 para Descendente, de lo contrario, el orden predeterminado basado en el valor SortBy
sortOrder: number
Valor de propiedad
number