AppParametersService
@spartanfx/react / spfx / AppParametersService
Class: AppParametersService
AppParametersService provides a typed abstraction layer over a SharePoint list used for storing configurable parameters (such as strings, booleans, numbers, people fields, etc.).
This is useful in SPFx solutions where administrators need to adjust behavior without modifying code—such as toggles, thresholds, user lists, or URLs.
Constructors
Constructor
new AppParametersService(configuration): AppParametersService;
Creates a new instance of AppParametersService.
Parameters
configuration
Contains a preconfigured SPFI instance.
Returns
AppParametersService
Methods
getParameterBoolean()
getParameterBoolean(parameterName): Promise<boolean>;
Retrieves a boolean parameter.
Parameters
parameterName
string
Returns
Promise<boolean>
getParameterDate()
getParameterDate(parameterName): Promise<Date>;
Retrieves a date parameter and parses it as a JavaScript Date object.
Parameters
parameterName
string
Returns
Promise<Date>
getParameterImage()
getParameterImage(parameterName): Promise<IImageField>;
Retrieves an image field containing metadata for rendering.
Parameters
parameterName
string
Returns
Promise<IImageField>
getParameterJSON()
getParameterJSON(parameterName): Promise<Object>;
Retrieves a JSON parameter and returns it as an object.
Parameters
parameterName
string
Returns
Promise<Object>
getParameterNumber()
getParameterNumber(parameterName): Promise<Number>;
Retrieves a numeric parameter and parses it as a number.
Parameters
parameterName
string
Returns
Promise<Number>
getParameterPeopleMultiple()
getParameterPeopleMultiple(parameterName): Promise<IPeopleField[]>;
Retrieves a list of user/person values.
Parameters
parameterName
string
Returns
Promise<IPeopleField[]>
getParameterPeopleSingle()
getParameterPeopleSingle(parameterName): Promise<IPeopleField>;
Retrieves a single user/person parameter.
Parameters
parameterName
string
Returns
Promise<IPeopleField>
getParameterString()
getParameterString(parameterName): Promise<string>;
Retrieves a single string parameter.
Parameters
parameterName
string
Returns
Promise<string>
getParameterStringMultiple()
getParameterStringMultiple(parameterName): Promise<string>;
Retrieves a comma-separated or multiline string parameter.
Parameters
parameterName
string
Returns
Promise<string>
getParameterStringMultipleExtended()
getParameterStringMultipleExtended(parameterName): Promise<string>;
Retrieves an extended multiple string parameter (e.g., JSON-formatted or rich values).
Parameters
parameterName
string
Returns
Promise<string>