File: json-node.xml

package info (click to toggle)
json-glib 0.10.2-2squeeze1
links: PTS
area: main
in suites: squeeze
size: 3,040 kB
ctags: 1,024
sloc: sh: 10,309; ansic: 7,318; xml: 3,751; makefile: 239
file content (626 lines) | stat: -rw-r--r-- 44,611 bytes
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>

<refentry id="json-glib-JSON-Node">
<refmeta>
<refentrytitle role="top_of_page" id="json-glib-JSON-Node.top_of_page">JSON Node</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>JSON-GLIB Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>JSON Node</refname>
<refpurpose>Node in a JSON object model</refpurpose>
</refnamediv>

<refsynopsisdiv id="json-glib-JSON-Node.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
enum                <link linkend="JsonNodeType">JsonNodeType</link>;
                    <link linkend="JsonNode">JsonNode</link>;
#define             <link linkend="JSON-NODE-TYPE--CAPS">JSON_NODE_TYPE</link>                      (node)
#define             <link linkend="JSON-NODE-HOLDS--CAPS">JSON_NODE_HOLDS</link>                     (node,t)
#define             <link linkend="JSON-NODE-HOLDS-VALUE--CAPS">JSON_NODE_HOLDS_VALUE</link>               (node)
#define             <link linkend="JSON-NODE-HOLDS-OBJECT--CAPS">JSON_NODE_HOLDS_OBJECT</link>              (node)
#define             <link linkend="JSON-NODE-HOLDS-ARRAY--CAPS">JSON_NODE_HOLDS_ARRAY</link>               (node)
#define             <link linkend="JSON-NODE-HOLDS-NULL--CAPS">JSON_NODE_HOLDS_NULL</link>                (node)
<link linkend="JsonNode">JsonNode</link> *          <link linkend="json-node-new">json_node_new</link>                       (<link linkend="JsonNodeType">JsonNodeType</link> type);
<link linkend="JsonNode">JsonNode</link> *          <link linkend="json-node-copy">json_node_copy</link>                      (<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="void">void</link>                <link linkend="json-node-free">json_node_free</link>                      (<link linkend="JsonNode">JsonNode</link> *node);

<link linkend="void">void</link>                <link linkend="json-node-set-array">json_node_set_array</link>                 (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="JsonArray">JsonArray</link> *array);
<link linkend="void">void</link>                <link linkend="json-node-take-array">json_node_take_array</link>                (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="JsonArray">JsonArray</link> *array);
<link linkend="JsonArray">JsonArray</link> *         <link linkend="json-node-get-array">json_node_get_array</link>                 (<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="JsonArray">JsonArray</link> *         <link linkend="json-node-dup-array">json_node_dup_array</link>                 (<link linkend="JsonNode">JsonNode</link> *node);

<link linkend="void">void</link>                <link linkend="json-node-set-object">json_node_set_object</link>                (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="JsonObject">JsonObject</link> *object);
<link linkend="void">void</link>                <link linkend="json-node-take-object">json_node_take_object</link>               (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="JsonObject">JsonObject</link> *object);
<link linkend="JsonObject">JsonObject</link> *        <link linkend="json-node-get-object">json_node_get_object</link>                (<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="JsonObject">JsonObject</link> *        <link linkend="json-node-dup-object">json_node_dup_object</link>                (<link linkend="JsonNode">JsonNode</link> *node);

<link linkend="void">void</link>                <link linkend="json-node-set-value">json_node_set_value</link>                 (<link linkend="JsonNode">JsonNode</link> *node,
                                                         const <link linkend="GValue">GValue</link> *value);
<link linkend="void">void</link>                <link linkend="json-node-get-value">json_node_get_value</link>                 (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="GValue">GValue</link> *value);
<link linkend="void">void</link>                <link linkend="json-node-set-boolean">json_node_set_boolean</link>               (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="gboolean">gboolean</link> value);
<link linkend="gboolean">gboolean</link>            <link linkend="json-node-get-boolean">json_node_get_boolean</link>               (<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="void">void</link>                <link linkend="json-node-set-double">json_node_set_double</link>                (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="gdouble">gdouble</link> value);
<link linkend="gdouble">gdouble</link>             <link linkend="json-node-get-double">json_node_get_double</link>                (<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="void">void</link>                <link linkend="json-node-set-int">json_node_set_int</link>                   (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="gint64">gint64</link> value);
<link linkend="gint64">gint64</link>              <link linkend="json-node-get-int">json_node_get_int</link>                   (<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="void">void</link>                <link linkend="json-node-set-string">json_node_set_string</link>                (<link linkend="JsonNode">JsonNode</link> *node,
                                                         const <link linkend="gchar">gchar</link> *value);
const <link linkend="gchar">gchar</link> *       <link linkend="json-node-get-string">json_node_get_string</link>                (<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="gchar">gchar</link> *             <link linkend="json-node-dup-string">json_node_dup_string</link>                (<link linkend="JsonNode">JsonNode</link> *node);

<link linkend="void">void</link>                <link linkend="json-node-set-parent">json_node_set_parent</link>                (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="JsonNode">JsonNode</link> *parent);
<link linkend="JsonNode">JsonNode</link> *          <link linkend="json-node-get-parent">json_node_get_parent</link>                (<link linkend="JsonNode">JsonNode</link> *node);
const <link linkend="gchar">gchar</link> *       <link linkend="json-node-type-name">json_node_type_name</link>                 (<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="GType">GType</link>               <link linkend="json-node-get-value-type">json_node_get_value_type</link>            (<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="JsonNodeType">JsonNodeType</link>        <link linkend="json-node-get-node-type">json_node_get_node_type</link>             (<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="gboolean">gboolean</link>            <link linkend="json-node-is-null">json_node_is_null</link>                   (<link linkend="JsonNode">JsonNode</link> *node);
</synopsis>
</refsynopsisdiv>









<refsect1 id="json-glib-JSON-Node.description" role="desc">
<title role="desc.title">Description</title>
<para>
A <link linkend="JsonNode"><type>JsonNode</type></link> is a generic container of elements inside a JSON stream.
It can contain fundamental types (integers, booleans, floating point
numbers, strings) and complex types (arrays and objects).
</para>
<para>
When parsing a JSON data stream you extract the root node and walk
the node tree by retrieving the type of data contained inside the
node with the <link linkend="JSON-NODE-TYPE--CAPS"><literal>JSON_NODE_TYPE</literal></link> macro. If the node contains a fundamental
type you can retrieve a copy of the <link linkend="GValue"><type>GValue</type></link> holding it with the
<link linkend="json-node-get-value"><function>json_node_get_value()</function></link> function, and then use the <link linkend="GValue"><type>GValue</type></link> API to extract
the data; if the node contains a complex type you can retrieve the
<link linkend="JsonObject"><type>JsonObject</type></link> or the <link linkend="JsonArray"><type>JsonArray</type></link> using <link linkend="json-node-get-object"><function>json_node_get_object()</function></link> or
<link linkend="json-node-get-array"><function>json_node_get_array()</function></link> respectively, and then retrieve the nodes
they contain.</para>
<para>
</para>
</refsect1>

<refsect1 id="json-glib-JSON-Node.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="JsonNodeType" role="enum">
<title>enum JsonNodeType</title>
<indexterm zone="JsonNodeType"><primary sortas="NodeType">JsonNodeType</primary></indexterm><programlisting>typedef enum {
  JSON_NODE_OBJECT,
  JSON_NODE_ARRAY,
  JSON_NODE_VALUE,
  JSON_NODE_NULL
} JsonNodeType;
</programlisting>
<para>
Indicates the content of a <link linkend="JsonNode"><type>JsonNode</type></link>.</para>
<para>
</para><variablelist role="enum">
<varlistentry id="JSON-NODE-OBJECT--CAPS" role="constant">
<term><literal>JSON_NODE_OBJECT</literal></term>
<listitem><simpara> The node contains a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem>
</varlistentry>
<varlistentry id="JSON-NODE-ARRAY--CAPS" role="constant">
<term><literal>JSON_NODE_ARRAY</literal></term>
<listitem><simpara> The node contains a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem>
</varlistentry>
<varlistentry id="JSON-NODE-VALUE--CAPS" role="constant">
<term><literal>JSON_NODE_VALUE</literal></term>
<listitem><simpara> The node contains a fundamental type
</simpara></listitem>
</varlistentry>
<varlistentry id="JSON-NODE-NULL--CAPS" role="constant">
<term><literal>JSON_NODE_NULL</literal></term>
<listitem><simpara> Special type, for nodes containing null
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="JsonNode" role="struct">
<title>JsonNode</title>
<indexterm zone="JsonNode"><primary sortas="Node">JsonNode</primary></indexterm><programlisting>typedef struct _JsonNode JsonNode;</programlisting>
<para>
A generic container of JSON data types. The contents of the <link linkend="JsonNode"><type>JsonNode</type></link>
structure are private and should only be accessed via the provided
functions and never directly.</para>
<para>
</para><variablelist role="struct">
</variablelist></refsect2>
<refsect2 id="JSON-NODE-TYPE--CAPS" role="macro">
<title>JSON_NODE_TYPE()</title>
<indexterm zone="JSON-NODE-TYPE--CAPS"><primary sortas="NODE_TYPE">JSON_NODE_TYPE</primary></indexterm><programlisting>#define JSON_NODE_TYPE(node)    (json_node_get_node_type ((node)))
</programlisting>
<para>
Evaluates to the <link linkend="JsonNodeType"><type>JsonNodeType</type></link> contained by <parameter>node</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="JSON-NODE-HOLDS--CAPS" role="macro" condition="since:0.10">
<title>JSON_NODE_HOLDS()</title>
<indexterm zone="JSON-NODE-HOLDS--CAPS" role="0.10"><primary sortas="NODE_HOLDS">JSON_NODE_HOLDS</primary></indexterm><programlisting>#define JSON_NODE_HOLDS(node,t)         (json_node_get_node_type ((node)) == (t))
</programlisting>
<para>
Evaluates to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the <parameter>node</parameter> holds type <parameter>t</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>t</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNodeType"><type>JsonNodeType</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
<refsect2 id="JSON-NODE-HOLDS-VALUE--CAPS" role="macro" condition="since:0.10">
<title>JSON_NODE_HOLDS_VALUE()</title>
<indexterm zone="JSON-NODE-HOLDS-VALUE--CAPS" role="0.10"><primary sortas="NODE_HOLDS_VALUE">JSON_NODE_HOLDS_VALUE</primary></indexterm><programlisting>#define JSON_NODE_HOLDS_VALUE(node)     (JSON_NODE_HOLDS ((node), JSON_NODE_VALUE))
</programlisting>
<para>
Evaluates to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>node</parameter> holds a <link linkend="JSON-NODE-VALUE--CAPS"><literal>JSON_NODE_VALUE</literal></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
<refsect2 id="JSON-NODE-HOLDS-OBJECT--CAPS" role="macro" condition="since:0.10">
<title>JSON_NODE_HOLDS_OBJECT()</title>
<indexterm zone="JSON-NODE-HOLDS-OBJECT--CAPS" role="0.10"><primary sortas="NODE_HOLDS_OBJECT">JSON_NODE_HOLDS_OBJECT</primary></indexterm><programlisting>#define JSON_NODE_HOLDS_OBJECT(node)    (JSON_NODE_HOLDS ((node), JSON_NODE_OBJECT))
</programlisting>
<para>
Evaluates to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>node</parameter> holds a <link linkend="JSON-NODE-OBJECT--CAPS"><literal>JSON_NODE_OBJECT</literal></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
<refsect2 id="JSON-NODE-HOLDS-ARRAY--CAPS" role="macro" condition="since:0.10">
<title>JSON_NODE_HOLDS_ARRAY()</title>
<indexterm zone="JSON-NODE-HOLDS-ARRAY--CAPS" role="0.10"><primary sortas="NODE_HOLDS_ARRAY">JSON_NODE_HOLDS_ARRAY</primary></indexterm><programlisting>#define JSON_NODE_HOLDS_ARRAY(node)     (JSON_NODE_HOLDS ((node), JSON_NODE_ARRAY))
</programlisting>
<para>
Evaluates to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>node</parameter> holds a <link linkend="JSON-NODE-ARRAY--CAPS"><literal>JSON_NODE_ARRAY</literal></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
<refsect2 id="JSON-NODE-HOLDS-NULL--CAPS" role="macro" condition="since:0.10">
<title>JSON_NODE_HOLDS_NULL()</title>
<indexterm zone="JSON-NODE-HOLDS-NULL--CAPS" role="0.10"><primary sortas="NODE_HOLDS_NULL">JSON_NODE_HOLDS_NULL</primary></indexterm><programlisting>#define JSON_NODE_HOLDS_NULL(node)      (JSON_NODE_HOLDS ((node), JSON_NODE_NULL))
</programlisting>
<para>
Evaluates to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>node</parameter> holds a <link linkend="JSON-NODE-NULL--CAPS"><literal>JSON_NODE_NULL</literal></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.10</para></refsect2>
<refsect2 id="json-node-new" role="function">
<title>json_node_new ()</title>
<indexterm zone="json-node-new"><primary sortas="node_new">json_node_new</primary></indexterm><programlisting><link linkend="JsonNode">JsonNode</link> *          json_node_new                       (<link linkend="JsonNodeType">JsonNodeType</link> type);</programlisting>
<para>
Creates a new <link linkend="JsonNode"><type>JsonNode</type></link> of <parameter>type</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNodeType"><type>JsonNodeType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the newly created <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-copy" role="function">
<title>json_node_copy ()</title>
<indexterm zone="json-node-copy"><primary sortas="node_copy">json_node_copy</primary></indexterm><programlisting><link linkend="JsonNode">JsonNode</link> *          json_node_copy                      (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Copies <parameter>node</parameter>. If the node contains complex data types then the reference
count of the objects is increased.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the copied <link linkend="JsonNode"><type>JsonNode</type></link>. <acronym>transfer</acronym> full. </simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-free" role="function">
<title>json_node_free ()</title>
<indexterm zone="json-node-free"><primary sortas="node_free">json_node_free</primary></indexterm><programlisting><link linkend="void">void</link>                json_node_free                      (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Frees the resources allocated by <parameter>node</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-set-array" role="function">
<title>json_node_set_array ()</title>
<indexterm zone="json-node-set-array"><primary sortas="node_set_array">json_node_set_array</primary></indexterm><programlisting><link linkend="void">void</link>                json_node_set_array                 (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="JsonArray">JsonArray</link> *array);</programlisting>
<para>
Sets <parameter>array</parameter> inside <parameter>node</parameter> and increases the <link linkend="JsonArray"><type>JsonArray</type></link> reference count</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>array</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-take-array" role="function">
<title>json_node_take_array ()</title>
<indexterm zone="json-node-take-array"><primary sortas="node_take_array">json_node_take_array</primary></indexterm><programlisting><link linkend="void">void</link>                json_node_take_array                (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="JsonArray">JsonArray</link> *array);</programlisting>
<para>
Sets <parameter>array</parameter> into <parameter>node</parameter> without increasing the <link linkend="JsonArray"><type>JsonArray</type></link> reference count.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>array</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-get-array" role="function">
<title>json_node_get_array ()</title>
<indexterm zone="json-node-get-array"><primary sortas="node_get_array">json_node_get_array</primary></indexterm><programlisting><link linkend="JsonArray">JsonArray</link> *         json_node_get_array                 (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Retrieves the <link linkend="JsonArray"><type>JsonArray</type></link> stored inside a <link linkend="JsonNode"><type>JsonNode</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="JsonArray"><type>JsonArray</type></link>. <acronym>transfer</acronym> none. </simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-dup-array" role="function">
<title>json_node_dup_array ()</title>
<indexterm zone="json-node-dup-array"><primary sortas="node_dup_array">json_node_dup_array</primary></indexterm><programlisting><link linkend="JsonArray">JsonArray</link> *         json_node_dup_array                 (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Retrieves the <link linkend="JsonArray"><type>JsonArray</type></link> stored inside a <link linkend="JsonNode"><type>JsonNode</type></link> and returns it
with its reference count increased by one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>transfer full. <acronym>transfer</acronym> full. </simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-set-object" role="function">
<title>json_node_set_object ()</title>
<indexterm zone="json-node-set-object"><primary sortas="node_set_object">json_node_set_object</primary></indexterm><programlisting><link linkend="void">void</link>                json_node_set_object                (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="JsonObject">JsonObject</link> *object);</programlisting>
<para>
Sets <parameter>objects</parameter> inside <parameter>node</parameter>. The reference count of <parameter>object</parameter> is increased.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>object</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-take-object" role="function">
<title>json_node_take_object ()</title>
<indexterm zone="json-node-take-object"><primary sortas="node_take_object">json_node_take_object</primary></indexterm><programlisting><link linkend="void">void</link>                json_node_take_object               (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="JsonObject">JsonObject</link> *object);</programlisting>
<para>
Sets <parameter>object</parameter> inside <parameter>node</parameter>. The reference count of <parameter>object</parameter> is not increased.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>object</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-get-object" role="function">
<title>json_node_get_object ()</title>
<indexterm zone="json-node-get-object"><primary sortas="node_get_object">json_node_get_object</primary></indexterm><programlisting><link linkend="JsonObject">JsonObject</link> *        json_node_get_object                (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Retrieves the <link linkend="JsonObject"><type>JsonObject</type></link> stored inside a <link linkend="JsonNode"><type>JsonNode</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="JsonObject"><type>JsonObject</type></link>. <acronym>transfer</acronym> none. </simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-dup-object" role="function">
<title>json_node_dup_object ()</title>
<indexterm zone="json-node-dup-object"><primary sortas="node_dup_object">json_node_dup_object</primary></indexterm><programlisting><link linkend="JsonObject">JsonObject</link> *        json_node_dup_object                (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Retrieves the <link linkend="JsonObject"><type>JsonObject</type></link> inside <parameter>node</parameter>. The reference count of
the returned object is increased.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="JsonObject"><type>JsonObject</type></link>. <acronym>transfer</acronym> full. </simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-set-value" role="function">
<title>json_node_set_value ()</title>
<indexterm zone="json-node-set-value"><primary sortas="node_set_value">json_node_set_value</primary></indexterm><programlisting><link linkend="void">void</link>                json_node_set_value                 (<link linkend="JsonNode">JsonNode</link> *node,
                                                         const <link linkend="GValue">GValue</link> *value);</programlisting>
<para>
Sets <parameter>value</parameter> inside <parameter>node</parameter>. The passed <link linkend="GValue"><type>GValue</type></link> is copied into the <link linkend="JsonNode"><type>JsonNode</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&#160;:</term>
<listitem><simpara> the <link linkend="GValue"><type>GValue</type></link> to set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-get-value" role="function">
<title>json_node_get_value ()</title>
<indexterm zone="json-node-get-value"><primary sortas="node_get_value">json_node_get_value</primary></indexterm><programlisting><link linkend="void">void</link>                json_node_get_value                 (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="GValue">GValue</link> *value);</programlisting>
<para>
Retrieves a value from a <link linkend="JsonNode"><type>JsonNode</type></link> and copies into <parameter>value</parameter>. When done
using it, call <link linkend="g-value-unset"><function>g_value_unset()</function></link> on the <link linkend="GValue"><type>GValue</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&#160;:</term>
<listitem><simpara> return location for an uninitialized value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-set-boolean" role="function">
<title>json_node_set_boolean ()</title>
<indexterm zone="json-node-set-boolean"><primary sortas="node_set_boolean">json_node_set_boolean</primary></indexterm><programlisting><link linkend="void">void</link>                json_node_set_boolean               (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="gboolean">gboolean</link> value);</programlisting>
<para>
Sets <parameter>value</parameter> as the boolean content of the <parameter>node</parameter>, replacing any existing
content.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> of type <link linkend="JSON-NODE-VALUE--CAPS"><literal>JSON_NODE_VALUE</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&#160;:</term>
<listitem><simpara> a boolean value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-get-boolean" role="function">
<title>json_node_get_boolean ()</title>
<indexterm zone="json-node-get-boolean"><primary sortas="node_get_boolean">json_node_get_boolean</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            json_node_get_boolean               (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Gets the boolean value stored inside a <link linkend="JsonNode"><type>JsonNode</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> of type <link linkend="JSON-NODE-VALUE--CAPS"><literal>JSON_NODE_VALUE</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a boolean value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-set-double" role="function">
<title>json_node_set_double ()</title>
<indexterm zone="json-node-set-double"><primary sortas="node_set_double">json_node_set_double</primary></indexterm><programlisting><link linkend="void">void</link>                json_node_set_double                (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="gdouble">gdouble</link> value);</programlisting>
<para>
Sets <parameter>value</parameter> as the double content of the <parameter>node</parameter>, replacing any existing
content.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> of type <link linkend="JSON-NODE-VALUE--CAPS"><literal>JSON_NODE_VALUE</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&#160;:</term>
<listitem><simpara> a double value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-get-double" role="function">
<title>json_node_get_double ()</title>
<indexterm zone="json-node-get-double"><primary sortas="node_get_double">json_node_get_double</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             json_node_get_double                (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Gets the double value stored inside a <link linkend="JsonNode"><type>JsonNode</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> of type <link linkend="JSON-NODE-VALUE--CAPS"><literal>JSON_NODE_VALUE</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a double value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-set-int" role="function">
<title>json_node_set_int ()</title>
<indexterm zone="json-node-set-int"><primary sortas="node_set_int">json_node_set_int</primary></indexterm><programlisting><link linkend="void">void</link>                json_node_set_int                   (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="gint64">gint64</link> value);</programlisting>
<para>
Sets <parameter>value</parameter> as the integer content of the <parameter>node</parameter>, replacing any existing
content.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> of type <link linkend="JSON-NODE-VALUE--CAPS"><literal>JSON_NODE_VALUE</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&#160;:</term>
<listitem><simpara> an integer value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-get-int" role="function">
<title>json_node_get_int ()</title>
<indexterm zone="json-node-get-int"><primary sortas="node_get_int">json_node_get_int</primary></indexterm><programlisting><link linkend="gint64">gint64</link>              json_node_get_int                   (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Gets the integer value stored inside a <link linkend="JsonNode"><type>JsonNode</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> of type <link linkend="JSON-NODE-VALUE--CAPS"><literal>JSON_NODE_VALUE</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an integer value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-set-string" role="function">
<title>json_node_set_string ()</title>
<indexterm zone="json-node-set-string"><primary sortas="node_set_string">json_node_set_string</primary></indexterm><programlisting><link linkend="void">void</link>                json_node_set_string                (<link linkend="JsonNode">JsonNode</link> *node,
                                                         const <link linkend="gchar">gchar</link> *value);</programlisting>
<para>
Sets <parameter>value</parameter> as the string content of the <parameter>node</parameter>, replacing any existing
content.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> of type <link linkend="JSON-NODE-VALUE--CAPS"><literal>JSON_NODE_VALUE</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&#160;:</term>
<listitem><simpara> a string value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-get-string" role="function">
<title>json_node_get_string ()</title>
<indexterm zone="json-node-get-string"><primary sortas="node_get_string">json_node_get_string</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       json_node_get_string                (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Gets the string value stored inside a <link linkend="JsonNode"><type>JsonNode</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> of type <link linkend="JSON-NODE-VALUE--CAPS"><literal>JSON_NODE_VALUE</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a string value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-dup-string" role="function">
<title>json_node_dup_string ()</title>
<indexterm zone="json-node-dup-string"><primary sortas="node_dup_string">json_node_dup_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             json_node_dup_string                (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Gets a copy of the string value stored inside a <link linkend="JsonNode"><type>JsonNode</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> of type <link linkend="JSON-NODE-VALUE--CAPS"><literal>JSON_NODE_VALUE</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>transfer full. <acronym>transfer</acronym> full. </simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-set-parent" role="function" condition="since:0.8">
<title>json_node_set_parent ()</title>
<indexterm zone="json-node-set-parent" role="0.8"><primary sortas="node_set_parent">json_node_set_parent</primary></indexterm><programlisting><link linkend="void">void</link>                json_node_set_parent                (<link linkend="JsonNode">JsonNode</link> *node,
                                                         <link linkend="JsonNode">JsonNode</link> *parent);</programlisting>
<para>
Sets the parent <link linkend="JsonNode"><type>JsonNode</type></link> of <parameter>node</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
<listitem><simpara> the parent <link linkend="JsonNode"><type>JsonNode</type></link> of <parameter>node</parameter>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-node-get-parent" role="function">
<title>json_node_get_parent ()</title>
<indexterm zone="json-node-get-parent"><primary sortas="node_get_parent">json_node_get_parent</primary></indexterm><programlisting><link linkend="JsonNode">JsonNode</link> *          json_node_get_parent                (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Retrieves the parent <link linkend="JsonNode"><type>JsonNode</type></link> of <parameter>node</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the parent node, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>node</parameter> is the root node
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-type-name" role="function">
<title>json_node_type_name ()</title>
<indexterm zone="json-node-type-name"><primary sortas="node_type_name">json_node_type_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       json_node_type_name                 (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Retrieves the user readable name of the data type contained by <parameter>node</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a string containing the name of the type. The returned string
  is owned by the node and should never be modified or freed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-node-get-value-type" role="function" condition="since:0.4">
<title>json_node_get_value_type ()</title>
<indexterm zone="json-node-get-value-type" role="0.4"><primary sortas="node_get_value_type">json_node_get_value_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               json_node_get_value_type            (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Returns the <link linkend="GType"><type>GType</type></link> of the payload of the node.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GType"><type>GType</type></link> for the payload.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.4</para></refsect2>
<refsect2 id="json-node-get-node-type" role="function" condition="since:0.8">
<title>json_node_get_node_type ()</title>
<indexterm zone="json-node-get-node-type" role="0.8"><primary sortas="node_get_node_type">json_node_get_node_type</primary></indexterm><programlisting><link linkend="JsonNodeType">JsonNodeType</link>        json_node_get_node_type             (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Retrieves the <link linkend="JsonNodeType"><type>JsonNodeType</type></link> of <parameter>node</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the type of the node

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-node-is-null" role="function" condition="since:0.8">
<title>json_node_is_null ()</title>
<indexterm zone="json-node-is-null" role="0.8"><primary sortas="node_is_null">json_node_is_null</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            json_node_is_null                   (<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Checks whether <parameter>node</parameter> is a <link linkend="JSON-NODE-NULL--CAPS"><literal>JSON_NODE_NULL</literal></link>
</para>
<para>
<note>A null node is not the same as a <link linkend="NULL--CAPS"><literal>NULL</literal></link> <link linkend="JsonNode"><type>JsonNode</type></link></note></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the node is null

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>

</refsect1>




</refentry>