StringParameterValue
StringParameterValue
StringParameterValue holds a text value for one query parameter, in the Contentstack.Management.Core.Queryable namespace.
When to Use This Class: Create it yourself only to replace a value through the indexer of a ParameterCollection. The matching Add overload of ParameterCollection creates it for you.
Conceptual Role: Acts as a typed value in a ParameterCollection. It extends the empty base class QueryParamValue.
Returns: StringParameterValue. A query parameter value.
Class-Level Properties
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| Value | string | Yes | Not applicable | Text value of the parameter. |
Class-Level Notes
How the SDK writes it.
- The SDK writes the value as name=<value> without URL-encoding it. Encode a value that holds &, =, #, or + with Uri.EscapeDataString first.
Method Index
| Method Name | Returns | Description |
|---|---|---|
| StringParameterValue | A new parameter value. | Creates the value object. |
Class-Level Snippet
This snippet replaces a query parameter value through the indexer, then prints the pair the SDK sends.
using System;
using System.Collections.Generic;
using System.Text.Json.Nodes;
using Contentstack.Management.Core.Queryable;
ParameterCollection collection = new ParameterCollection();
collection["<PARAMETER_NAME>"] = new StringParameterValue("<PARAMETER_VALUE>");
foreach (KeyValuePair<string, string> pair in collection.GetSortedParametersList())
{
Console.WriteLine($"{pair.Key}={pair.Value}");
}Methods
Each method of the StringParameterValue class has its own section below, with its parameters, validation rules, behavior, and examples.
StringParameterValue
StringParameterValue creates a value object that holds a text value for one query parameter.
| Name | Type | Description |
|---|---|---|
| value (required) | string | Text value of the parameter. |
Returns: StringParameterValue. A new parameter value.
Validation
- There is no client-side validation. The constructor stores value as given, and the SDK reads it when it builds the query string of a request.
- A null value raises no error. The SDK leaves the parameter out of the query string.
Behavior
- Client-side only. The constructor sends no request.
- The SDK writes the value as name=<value> without URL-encoding it. Encode a value that holds &, =, #, or + with Uri.EscapeDataString first.
- Add the object to a ParameterCollection with the Add(string key, QueryParamValue value) overload or the indexer.
Example
Basic usage: add the value to a collection
using System;
using System.Collections.Generic;
using System.Text.Json.Nodes;
using Contentstack.Management.Core.Queryable;
StringParameterValue value = new StringParameterValue("<PARAMETER_VALUE>");
ParameterCollection collection = new ParameterCollection();
collection.Add("<PARAMETER_NAME>", value);
Console.WriteLine(collection.GetSortedParametersList().Count);