BoolParameterValue

View as Markdown

BoolParameterValue

BoolParameterValue holds a true or false 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: BoolParameterValue. A query parameter value.

Class-Level Properties

NameTypeRequiredDefaultDescription
ValueboolYesNot applicableFlag value of the parameter.

Class-Level Notes

How the SDK writes it.

  • The SDK writes the value as name=true or name=false, in lowercase.

Method Index

Method NameReturnsDescription
BoolParameterValueA 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 BoolParameterValue(true);

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

Methods

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

BoolParameterValue

BoolParameterValue creates a value object that holds a true or false value for one query parameter.

NameTypeDescription
value (required)bool

Flag value of the parameter.

Default: Not applicable

Returns: BoolParameterValue. 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 bool cannot be null, so every value produces one pair.

Behavior

  • Client-side only. The constructor sends no request.
  • The SDK writes the value as name=true or name=false, in lowercase.
  • 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;

BoolParameterValue value = new BoolParameterValue(true);

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

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