JObjectParameterValue

View as Markdown

JObjectParameterValue

JObjectParameterValue holds a JSON 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: JObjectParameterValue. A query parameter value.

Class-Level Properties

NameTypeRequiredDefaultDescription
ValueJsonNodeYesNot applicableJSON value of the parameter.

Class-Level Notes

How the SDK writes it.

  • The SDK writes the value as name=<JSON text> without URL-encoding it. For the query filter, use the AddQuery method of ParameterCollection, which encodes the JSON.
  • ParameterCollection has no typed Add overload for a JsonNode. Add this object with Add(string key, QueryParamValue value) or the indexer.

Method Index

Method NameReturnsDescription
JObjectParameterValueA 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 JObjectParameterValue(new JsonObject { ["title"] = "Blog Post" });

foreach (KeyValuePair<string, string> pair in collection.GetSortedParametersList())
{
    Console.WriteLine($"{pair.Key}={pair.Value}");
}

Methods

Each method of the JObjectParameterValue class has its own section below, with its parameters, validation rules, behavior, and examples.

JObjectParameterValue

JObjectParameterValue creates a value object that holds a JSON value for one query parameter.

NameTypeDescription
values (required)JsonNode

JSON value of the parameter.

Default: Not applicable

Returns: JObjectParameterValue. A new parameter value.

Validation

  • There is no client-side validation. The constructor stores values as given, and the SDK reads it when it builds the query string of a request.
  • Throws NullReferenceException when the SDK writes the query string, if values is null.

Behavior

  • Client-side only. The constructor sends no request.
  • The SDK writes the value as name=<JSON text> without URL-encoding it. For the query filter, use the AddQuery method of ParameterCollection, which encodes the JSON.
  • 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;

JObjectParameterValue value = new JObjectParameterValue(new JsonObject { ["title"] = "Blog Post" });

ParameterCollection collection = new ParameterCollection();
collection.Add("<PARAMETER_NAME>", value);

Console.WriteLine(collection.GetSortedParametersList().Count);