QueryFilter interface

Paquete:

azure-devops-extension-api

Filtro usado para definir un conjunto de extensiones que se devolverán 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 uno. Si no se omite la dirección y se usa Forward desde el principio 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.
pageNumber	Número de página solicitado por el usuario. Si no se proporciona 1 se supone de forma predeterminada.
pageSize	El tamaño de página define el número de resultados que el autor de la llamada desea para este filtro. El recuento no puede superar los límites generales de tamaño de consulta.
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 está en el resultado y qué campos se filtran se insertan en el token.
sortBy	Define el tipo de ordenación que se va a aplicar en los resultados. El segmento de página solo se corta de los resultados ordenados.
sortOrder	Define el orden de ordenación, 1 para ascendente, 2 para Descendente; de lo contrario, el orden predeterminado se basa 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

FilterCriteria[]

direction

PagingDirection se aplica a un token de paginación si existe uno. Si no se omite la dirección y se usa Forward desde el principio 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

PagingDirection

pageNumber

Número de página solicitado por el usuario. Si no se proporciona 1 se supone de forma predeterminada.

pageNumber: number

Valor de propiedad

number

pageSize

El tamaño de página define el número de resultados que el autor de la llamada 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 está en el resultado y qué campos se filtran se insertan en el token.

pagingToken: string

Valor de propiedad

string

sortBy

Define el tipo de ordenación que se va a aplicar en los resultados. El segmento de página solo se corta 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 se basa en el valor SortBy.

sortOrder: number

Valor de propiedad

number