Partager via

UrlQueryParameterCollection class

  • Référence
Paquet:
@microsoft/sp-core-library

Avertissement

Cette API est à présent déconseillée.

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

Fournit des fonctionnalités de stockage et de récupération des paramètres de requête d’URL.

Remarques

L’URL peut être relative au serveur, et il peut également s’agir d’une chaîne vide ou null. Les paramètres de requête doivent commencer par « ? » pour indiquer le premier paramètre de requête et utiliser « & » pour tous les paramètres suivants. La classe prend également en charge les fragments.

Comportement de cas edge :

La valeur vide (www.example.com/?test=) stocke la clé et la valeur vide Non égal dans queryParam (www.example.com/?test) stocke la clé et la valeur non définie QueryParam (www.example.com/ ?& debug=on) stocke la clé et la valeur non définies Paramètre de requête avec uniquement égal (www.example.com/ ?=&debug=on stocke la clé de chaîne vide et la valeur

Constructeurs

(constructor)(url)

Construit une nouvelle instance de la UrlQueryParameterCollection classe

Méthodes

getValue(param)

Renvoie la valeur du premier paramètre de requête correspondant ou « Undefined » si la touche n’existe pas.
getValues(param)

Renvoie les valeurs de tous les paramètres de requête correspondant ou « Undefined » si la touche n’existe pas.

Détails du constructeur

(constructor)(url)

Construit une nouvelle instance de la UrlQueryParameterCollection classe

constructor(url: string);

Paramètres

url

string

Détails de la méthode

getValue(param)

Renvoie la valeur du premier paramètre de requête correspondant ou « Undefined » si la touche n’existe pas.

getValue(param: string): string | undefined;

Paramètres

param

string

touche insensible à la casse pour la valeur du paramètre de requête souhaitée.

Retours

string | undefined

Remarques

Exemples :

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)

Renvoie les valeurs de tous les paramètres de requête correspondant ou « Undefined » si la touche n’existe pas.

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

Paramètres

param

string

touche insensible à la casse pour la valeur du paramètre de requête souhaitée.

Retours

(string | undefined)[] | undefined

Remarques

Exemples :

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