Compartir a través de

UrlQueryParameterCollection class

  • Referencia
Paquete:
@microsoft/sp-core-library

Advertencia

Esta API ya está en desuso.

Use the URLSearchParams browser API instead. The SharePoint Framework includes a polyfill for older browsers.

Proporciona características para almacenar y recuperar parámetros de consulta de direcciones URL.

Comentarios

La dirección URL puede ser relativa al servidor y también puede ser una cadena vacía o nula. Los parámetros de consulta deben empezar por "?" para indicar el primer parámetro de consulta y usar "&" para todos los parámetros posteriores. La clase también admite fragmentos.

Comportamiento de casos perimetrales:

El valor vacío (www.example.com/?test=) almacena la clave y el valor vacío No es igual en queryParam (www.example.com/?test) almacena la clave y el valor indefinido QueryParam vacío (www.example.com/?&debug=on) almacena la clave sin definir y el valor Parámetro de consulta con solo igual (www.example.com/?=&debug=on almacena la clave de cadena vacía y el valor

Constructores

(constructor)(url)

Construye una nueva instancia de la UrlQueryParameterCollection clase

Métodos

getValue(param)

Devuelve el valor del primer parámetro de consulta que coincide o undefined si la clave no existe.
getValues(param)

Devuelve los valores de todos los parámetros de consulta que coinciden o undefined si la clave no existe.

Detalles del constructor

(constructor)(url)

Construye una nueva instancia de la UrlQueryParameterCollection clase

constructor(url: string);

Parámetros

url

string

Detalles del método

getValue(param)

Devuelve el valor del primer parámetro de consulta que coincide o undefined si la clave no existe.

getValue(param: string): string | undefined;

Parámetros

param

string

Clave que no distingue mayúsculas de minúsculas para el valor del parámetro de consulta deseado.

Devoluciones

string | undefined

Comentarios

Ejemplos:

this._queryParameterList = [
{key: TEST, value: done},
{key: DEBUG, value: false},
{key: TEST, value: notdone}]
  getValue('TEST') ---> 'done'
  getValue('debug')  ---> 'false'
  getValue('lost')  ---> undefined

getValues(param)

Devuelve los valores de todos los parámetros de consulta que coinciden o undefined si la clave no existe.

getValues(param: string): (string | undefined)[] | undefined;

Parámetros

param

string

Clave que no distingue mayúsculas de minúsculas para el valor del parámetro de consulta deseado.

Devoluciones

(string | undefined)[] | undefined

Comentarios

Ejemplos:

this._queryParameterList = [
{key: TEST, value: done},
{key: DEBUG, value: false},
{key: TEST, value: notdone}]
  getValues('TEST') ---> ['done', 'notdone']
  getValues('debug')  ---> ['false']
  getValues('lost')  ---> undefined