1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
|
<?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-Object">
<refmeta>
<refentrytitle role="top_of_page" id="json-glib-JSON-Object.top_of_page">JSON Object</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>JSON-GLIB Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>JSON Object</refname>
<refpurpose>a JSON object representation</refpurpose>
</refnamediv>
<refsynopsisdiv id="json-glib-JSON-Object.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="JsonObject">JsonObject</link>;
<link linkend="JsonObject">JsonObject</link> * <link linkend="json-object-new">json_object_new</link> (void);
<link linkend="JsonObject">JsonObject</link> * <link linkend="json-object-ref">json_object_ref</link> (<link linkend="JsonObject">JsonObject</link> *object);
<link linkend="void">void</link> <link linkend="json-object-unref">json_object_unref</link> (<link linkend="JsonObject">JsonObject</link> *object);
<link linkend="void">void</link> <link linkend="json-object-add-member">json_object_add_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="void">void</link> <link linkend="json-object-set-member">json_object_set_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="gboolean">gboolean</link> <link linkend="json-object-has-member">json_object_has_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);
<link linkend="JsonNode">JsonNode</link> * <link linkend="json-object-get-member">json_object_get_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);
<link linkend="JsonNode">JsonNode</link> * <link linkend="json-object-dup-member">json_object_dup_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);
<link linkend="GList">GList</link> * <link linkend="json-object-get-members">json_object_get_members</link> (<link linkend="JsonObject">JsonObject</link> *object);
<link linkend="GList">GList</link> * <link linkend="json-object-get-values">json_object_get_values</link> (<link linkend="JsonObject">JsonObject</link> *object);
<link linkend="guint">guint</link> <link linkend="json-object-get-size">json_object_get_size</link> (<link linkend="JsonObject">JsonObject</link> *object);
<link linkend="void">void</link> <link linkend="json-object-remove-member">json_object_remove_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);
<link linkend="void">void</link> (<link linkend="JsonObjectForeach">*JsonObjectForeach</link>) (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="JsonNode">JsonNode</link> *member_node,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> <link linkend="json-object-foreach-member">json_object_foreach_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
<link linkend="JsonObjectForeach">JsonObjectForeach</link> func,
<link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link> <link linkend="json-object-set-array-member">json_object_set_array_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="JsonArray">JsonArray</link> *value);
<link linkend="JsonArray">JsonArray</link> * <link linkend="json-object-get-array-member">json_object_get_array_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);
<link linkend="void">void</link> <link linkend="json-object-set-boolean-member">json_object_set_boolean_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="gboolean">gboolean</link> value);
<link linkend="gboolean">gboolean</link> <link linkend="json-object-get-boolean-member">json_object_get_boolean_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);
<link linkend="void">void</link> <link linkend="json-object-set-double-member">json_object_set_double_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="gdouble">gdouble</link> value);
<link linkend="gdouble">gdouble</link> <link linkend="json-object-get-double-member">json_object_get_double_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);
<link linkend="void">void</link> <link linkend="json-object-set-int-member">json_object_set_int_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="gint64">gint64</link> value);
<link linkend="gint64">gint64</link> <link linkend="json-object-get-int-member">json_object_get_int_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);
<link linkend="void">void</link> <link linkend="json-object-set-null-member">json_object_set_null_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);
<link linkend="gboolean">gboolean</link> <link linkend="json-object-get-null-member">json_object_get_null_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);
<link linkend="void">void</link> <link linkend="json-object-set-object-member">json_object_set_object_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="JsonObject">JsonObject</link> *value);
<link linkend="JsonObject">JsonObject</link> * <link linkend="json-object-get-object-member">json_object_get_object_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);
<link linkend="void">void</link> <link linkend="json-object-set-string-member">json_object_set_string_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
const <link linkend="gchar">gchar</link> *value);
const <link linkend="gchar">gchar</link> * <link linkend="json-object-get-string-member">json_object_get_string_member</link> (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);
</synopsis>
</refsynopsisdiv>
<refsect1 id="json-glib-JSON-Object.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="JsonArray"><type>JsonArray</type></link> is the representation of the object type inside JSON. It contains
<link linkend="JsonNode"><type>JsonNode</type></link><!-- -->s, which may contain fundamental types, arrays or other
objects. Each member of an object is accessed using its name.
</para>
<para>
Since objects can be expensive, they are reference counted. You can control
the lifetime of a <link linkend="JsonObject"><type>JsonObject</type></link> using <link linkend="json-object-ref"><function>json_object_ref()</function></link> and <link linkend="json-object-unref"><function>json_object_unref()</function></link>.
</para>
<para>
To add or overwrite a member with a given name, use <link linkend="json-object-set-member"><function>json_object_set_member()</function></link>.
To extract a member with a given name, use <link linkend="json-object-get-member"><function>json_object_get_member()</function></link>.
To retrieve the list of members, use <link linkend="json-object-get-members"><function>json_object_get_members()</function></link>.
To retrieve the size of the object (that is, the number of members it has),
use <link linkend="json-object-get-size"><function>json_object_get_size()</function></link>.</para>
<para>
</para>
</refsect1>
<refsect1 id="json-glib-JSON-Object.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="JsonObject" role="struct">
<title>JsonObject</title>
<indexterm zone="JsonObject"><primary sortas="Object">JsonObject</primary></indexterm><programlisting>typedef struct _JsonObject JsonObject;</programlisting>
<para>
A JSON object type. The contents of the <link linkend="JsonObject"><type>JsonObject</type></link> structure are private
and should only be accessed by the provided API</para>
<para>
</para></refsect2>
<refsect2 id="json-object-new" role="function">
<title>json_object_new ()</title>
<indexterm zone="json-object-new"><primary sortas="object_new">json_object_new</primary></indexterm><programlisting><link linkend="JsonObject">JsonObject</link> * json_object_new (void);</programlisting>
<para>
Creates a new <link linkend="JsonObject"><type>JsonObject</type></link>, an JSON object type representation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-object-ref" role="function">
<title>json_object_ref ()</title>
<indexterm zone="json-object-ref"><primary sortas="object_ref">json_object_ref</primary></indexterm><programlisting><link linkend="JsonObject">JsonObject</link> * json_object_ref (<link linkend="JsonObject">JsonObject</link> *object);</programlisting>
<para>
Increase by one the reference count of a <link linkend="JsonObject"><type>JsonObject</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the passed <link linkend="JsonObject"><type>JsonObject</type></link>, with the reference count
increased by one.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-object-unref" role="function">
<title>json_object_unref ()</title>
<indexterm zone="json-object-unref"><primary sortas="object_unref">json_object_unref</primary></indexterm><programlisting><link linkend="void">void</link> json_object_unref (<link linkend="JsonObject">JsonObject</link> *object);</programlisting>
<para>
Decreases by one the reference count of a <link linkend="JsonObject"><type>JsonObject</type></link>. If the
reference count reaches zero, the object is destroyed and all
its allocated resources are freed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-object-add-member" role="function" condition="deprecated:0.8: Use json_object_set_member() instead">
<title>json_object_add_member ()</title>
<indexterm zone="json-object-add-member" role="deprecated"><primary sortas="object_add_member">json_object_add_member</primary></indexterm><programlisting><link linkend="void">void</link> json_object_add_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<warning><para><literal>json_object_add_member</literal> has been deprecated since version 0.8 and should not be used in newly-written code. Use <link linkend="json-object-set-member"><function>json_object_set_member()</function></link> instead</para></warning>
<para>
Adds a member named <parameter>member_name</parameter> and containing <parameter>node</parameter> into a <link linkend="JsonObject"><type>JsonObject</type></link>.
The object will take ownership of the <link linkend="JsonNode"><type>JsonNode</type></link>.
</para>
<para>
This function will return if the <parameter>object</parameter> already contains a member
<parameter>member_name</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> the value of the member
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-object-set-member" role="function" condition="since:0.8">
<title>json_object_set_member ()</title>
<indexterm zone="json-object-set-member" role="0.8"><primary sortas="object_set_member">json_object_set_member</primary></indexterm><programlisting><link linkend="void">void</link> json_object_set_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Sets <parameter>node</parameter> as the value of <parameter>member_name</parameter> inside <parameter>object</parameter>.
</para>
<para>
If <parameter>object</parameter> already contains a member called <parameter>member_name</parameter> then
the member's current value is overwritten. Otherwise, a new
member is added to <parameter>object</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> the value of the member
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-has-member" role="function">
<title>json_object_has_member ()</title>
<indexterm zone="json-object-has-member"><primary sortas="object_has_member">json_object_has_member</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> json_object_has_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);</programlisting>
<para>
Checks whether <parameter>object</parameter> has a member named <parameter>member_name</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of a JSON object member
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the JSON object has the requested member
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-object-get-member" role="function">
<title>json_object_get_member ()</title>
<indexterm zone="json-object-get-member"><primary sortas="object_get_member">json_object_get_member</primary></indexterm><programlisting><link linkend="JsonNode">JsonNode</link> * json_object_get_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);</programlisting>
<para>
Retrieves the <link linkend="JsonNode"><type>JsonNode</type></link> containing the value of <parameter>member_name</parameter> inside
a <link linkend="JsonObject"><type>JsonObject</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the JSON object member to access
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a pointer to the node for the requested object
member, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-object-dup-member" role="function" condition="since:0.6">
<title>json_object_dup_member ()</title>
<indexterm zone="json-object-dup-member" role="0.6"><primary sortas="object_dup_member">json_object_dup_member</primary></indexterm><programlisting><link linkend="JsonNode">JsonNode</link> * json_object_dup_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);</programlisting>
<para>
Retrieves a copy of the <link linkend="JsonNode"><type>JsonNode</type></link> containing the value of <parameter>member_name</parameter>
inside a <link linkend="JsonObject"><type>JsonObject</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the JSON object member to access
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> (transfer full) a copy of the node for the requested
object member or <link linkend="NULL--CAPS"><literal>NULL</literal></link>. Use <link linkend="json-node-free"><function>json_node_free()</function></link> when done.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.6</para></refsect2>
<refsect2 id="json-object-get-members" role="function">
<title>json_object_get_members ()</title>
<indexterm zone="json-object-get-members"><primary sortas="object_get_members">json_object_get_members</primary></indexterm><programlisting><link linkend="GList">GList</link> * json_object_get_members (<link linkend="JsonObject">JsonObject</link> *object);</programlisting>
<para>
Retrieves all the names of the members of a <link linkend="JsonObject"><type>JsonObject</type></link>. You can
obtain the value for each member using <link linkend="json-object-get-member"><function>json_object_get_member()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>element-type utf8) (transfer container. <acronym>element-type</acronym> utf8. <acronym>transfer</acronym> container. </simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-object-get-values" role="function">
<title>json_object_get_values ()</title>
<indexterm zone="json-object-get-values"><primary sortas="object_get_values">json_object_get_values</primary></indexterm><programlisting><link linkend="GList">GList</link> * json_object_get_values (<link linkend="JsonObject">JsonObject</link> *object);</programlisting>
<para>
Retrieves all the values of the members of a <link linkend="JsonObject"><type>JsonObject</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>element-type JsonNode) (transfer container. <acronym>element-type</acronym> JsonNode. <acronym>transfer</acronym> container. </simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-object-get-size" role="function">
<title>json_object_get_size ()</title>
<indexterm zone="json-object-get-size"><primary sortas="object_get_size">json_object_get_size</primary></indexterm><programlisting><link linkend="guint">guint</link> json_object_get_size (<link linkend="JsonObject">JsonObject</link> *object);</programlisting>
<para>
Retrieves the number of members of a <link linkend="JsonObject"><type>JsonObject</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of members
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-object-remove-member" role="function">
<title>json_object_remove_member ()</title>
<indexterm zone="json-object-remove-member"><primary sortas="object_remove_member">json_object_remove_member</primary></indexterm><programlisting><link linkend="void">void</link> json_object_remove_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);</programlisting>
<para>
Removes <parameter>member_name</parameter> from <parameter>object</parameter>, freeing its allocated resources.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member to remove
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="JsonObjectForeach" role="function" condition="since:0.8">
<title>JsonObjectForeach ()</title>
<indexterm zone="JsonObjectForeach" role="0.8"><primary sortas="ObjectForeach">JsonObjectForeach</primary></indexterm><programlisting><link linkend="void">void</link> (*JsonObjectForeach) (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="JsonNode">JsonNode</link> *member_node,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
The function to be passed to <link linkend="json-object-foreach-member"><function>json_object_foreach_member()</function></link>. You
should not add or remove members to and from <parameter>object</parameter> within
this function. It is safe to change the value of <parameter>member_node</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> the iterated <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_node</parameter> :</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> containing the <parameter>member_name</parameter> value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> data passed to the function
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-foreach-member" role="function" condition="since:0.8">
<title>json_object_foreach_member ()</title>
<indexterm zone="json-object-foreach-member" role="0.8"><primary sortas="object_foreach_member">json_object_foreach_member</primary></indexterm><programlisting><link linkend="void">void</link> json_object_foreach_member (<link linkend="JsonObject">JsonObject</link> *object,
<link linkend="JsonObjectForeach">JsonObjectForeach</link> func,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Iterates over all members of <parameter>object</parameter> and calls <parameter>func</parameter> on
each one of them.
</para>
<para>
It is safe to change the value of a <link linkend="JsonNode"><type>JsonNode</type></link> of the <parameter>object</parameter>
from within the iterator <parameter>func</parameter>, but it is not safe to add or
remove members from the <parameter>object</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>func</parameter> :</term>
<listitem><simpara> the function to be called on each member
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> data to be passed to the function
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-set-array-member" role="function" condition="since:0.8">
<title>json_object_set_array_member ()</title>
<indexterm zone="json-object-set-array-member" role="0.8"><primary sortas="object_set_array_member">json_object_set_array_member</primary></indexterm><programlisting><link linkend="void">void</link> json_object_set_array_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="JsonArray">JsonArray</link> *value);</programlisting>
<para>
Convenience function for setting an array <parameter>value</parameter> of
<parameter>member_name</parameter> inside <parameter>object</parameter>.
</para>
<para>
The <parameter>object</parameter> will take ownership of the passed <link linkend="JsonArray"><type>JsonArray</type></link>
</para>
<para>
See also: <link linkend="json-object-set-member"><function>json_object_set_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> the value of the member
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-get-array-member" role="function" condition="since:0.8">
<title>json_object_get_array_member ()</title>
<indexterm zone="json-object-get-array-member" role="0.8"><primary sortas="object_get_array_member">json_object_get_array_member</primary></indexterm><programlisting><link linkend="JsonArray">JsonArray</link> * json_object_get_array_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);</programlisting>
<para>
Convenience function that retrieves the array
stored in <parameter>member_name</parameter> of <parameter>object</parameter>
</para>
<para>
See also: <link linkend="json-object-get-member"><function>json_object_get_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the array inside the object's member. <acronym>transfer</acronym> none. </simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-set-boolean-member" role="function" condition="since:0.8">
<title>json_object_set_boolean_member ()</title>
<indexterm zone="json-object-set-boolean-member" role="0.8"><primary sortas="object_set_boolean_member">json_object_set_boolean_member</primary></indexterm><programlisting><link linkend="void">void</link> json_object_set_boolean_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="gboolean">gboolean</link> value);</programlisting>
<para>
Convenience function for setting a boolean <parameter>value</parameter> of
<parameter>member_name</parameter> inside <parameter>object</parameter>.
</para>
<para>
See also: <link linkend="json-object-set-member"><function>json_object_set_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> the value of the member
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-get-boolean-member" role="function" condition="since:0.8">
<title>json_object_get_boolean_member ()</title>
<indexterm zone="json-object-get-boolean-member" role="0.8"><primary sortas="object_get_boolean_member">json_object_get_boolean_member</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> json_object_get_boolean_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);</programlisting>
<para>
Convenience function that retrieves the boolean value
stored in <parameter>member_name</parameter> of <parameter>object</parameter>
</para>
<para>
See also: <link linkend="json-object-get-member"><function>json_object_get_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the boolean value of the object's member
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-set-double-member" role="function" condition="since:0.8">
<title>json_object_set_double_member ()</title>
<indexterm zone="json-object-set-double-member" role="0.8"><primary sortas="object_set_double_member">json_object_set_double_member</primary></indexterm><programlisting><link linkend="void">void</link> json_object_set_double_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="gdouble">gdouble</link> value);</programlisting>
<para>
Convenience function for setting a floating point <parameter>value</parameter>
of <parameter>member_name</parameter> inside <parameter>object</parameter>.
</para>
<para>
See also: <link linkend="json-object-set-member"><function>json_object_set_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> the value of the member
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-get-double-member" role="function" condition="since:0.8">
<title>json_object_get_double_member ()</title>
<indexterm zone="json-object-get-double-member" role="0.8"><primary sortas="object_get_double_member">json_object_get_double_member</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> json_object_get_double_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);</programlisting>
<para>
Convenience function that retrieves the floating point value
stored in <parameter>member_name</parameter> of <parameter>object</parameter>
</para>
<para>
See also: <link linkend="json-object-get-member"><function>json_object_get_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the floating point value of the object's member
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-set-int-member" role="function" condition="since:0.8">
<title>json_object_set_int_member ()</title>
<indexterm zone="json-object-set-int-member" role="0.8"><primary sortas="object_set_int_member">json_object_set_int_member</primary></indexterm><programlisting><link linkend="void">void</link> json_object_set_int_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="gint64">gint64</link> value);</programlisting>
<para>
Convenience function for setting an integer <parameter>value</parameter> of
<parameter>member_name</parameter> inside <parameter>object</parameter>.
</para>
<para>
See also: <link linkend="json-object-set-member"><function>json_object_set_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> the value of the member
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-get-int-member" role="function" condition="since:0.8">
<title>json_object_get_int_member ()</title>
<indexterm zone="json-object-get-int-member" role="0.8"><primary sortas="object_get_int_member">json_object_get_int_member</primary></indexterm><programlisting><link linkend="gint64">gint64</link> json_object_get_int_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);</programlisting>
<para>
Convenience function that retrieves the integer value
stored in <parameter>member_name</parameter> of <parameter>object</parameter>
</para>
<para>
See also: <link linkend="json-object-get-member"><function>json_object_get_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the integer value of the object's member
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-set-null-member" role="function" condition="since:0.8">
<title>json_object_set_null_member ()</title>
<indexterm zone="json-object-set-null-member" role="0.8"><primary sortas="object_set_null_member">json_object_set_null_member</primary></indexterm><programlisting><link linkend="void">void</link> json_object_set_null_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);</programlisting>
<para>
Convenience function for setting a null <parameter>value</parameter> of
<parameter>member_name</parameter> inside <parameter>object</parameter>.
</para>
<para>
See also: <link linkend="json-object-set-member"><function>json_object_set_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-get-null-member" role="function" condition="since:0.8">
<title>json_object_get_null_member ()</title>
<indexterm zone="json-object-get-null-member" role="0.8"><primary sortas="object_get_null_member">json_object_get_null_member</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> json_object_get_null_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);</programlisting>
<para>
Convenience function that checks whether the value
stored in <parameter>member_name</parameter> of <parameter>object</parameter> is null
</para>
<para>
See also: <link linkend="json-object-get-member"><function>json_object_get_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the value is null
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-set-object-member" role="function" condition="since:0.8">
<title>json_object_set_object_member ()</title>
<indexterm zone="json-object-set-object-member" role="0.8"><primary sortas="object_set_object_member">json_object_set_object_member</primary></indexterm><programlisting><link linkend="void">void</link> json_object_set_object_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
<link linkend="JsonObject">JsonObject</link> *value);</programlisting>
<para>
Convenience function for setting an object <parameter>value</parameter> of
<parameter>member_name</parameter> inside <parameter>object</parameter>.
</para>
<para>
The <parameter>object</parameter> will take ownership of the passed <link linkend="JsonObject"><type>JsonObject</type></link>
</para>
<para>
See also: <link linkend="json-object-set-member"><function>json_object_set_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> the value of the member
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-get-object-member" role="function" condition="since:0.8">
<title>json_object_get_object_member ()</title>
<indexterm zone="json-object-get-object-member" role="0.8"><primary sortas="object_get_object_member">json_object_get_object_member</primary></indexterm><programlisting><link linkend="JsonObject">JsonObject</link> * json_object_get_object_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);</programlisting>
<para>
Convenience function that retrieves the object
stored in <parameter>member_name</parameter> of <parameter>object</parameter>
</para>
<para>
See also: <link linkend="json-object-get-member"><function>json_object_get_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the object inside the object's member. <acronym>transfer</acronym> none. </simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-set-string-member" role="function" condition="since:0.8">
<title>json_object_set_string_member ()</title>
<indexterm zone="json-object-set-string-member" role="0.8"><primary sortas="object_set_string_member">json_object_set_string_member</primary></indexterm><programlisting><link linkend="void">void</link> json_object_set_string_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name,
const <link linkend="gchar">gchar</link> *value);</programlisting>
<para>
Convenience function for setting a string <parameter>value</parameter> of
<parameter>member_name</parameter> inside <parameter>object</parameter>.
</para>
<para>
See also: <link linkend="json-object-set-member"><function>json_object_set_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> the value of the member
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-object-get-string-member" role="function" condition="since:0.8">
<title>json_object_get_string_member ()</title>
<indexterm zone="json-object-get-string-member" role="0.8"><primary sortas="object_get_string_member">json_object_get_string_member</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> * json_object_get_string_member (<link linkend="JsonObject">JsonObject</link> *object,
const <link linkend="gchar">gchar</link> *member_name);</programlisting>
<para>
Convenience function that retrieves the string value
stored in <parameter>member_name</parameter> of <parameter>object</parameter>
</para>
<para>
See also: <link linkend="json-object-get-member"><function>json_object_get_member()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member_name</parameter> :</term>
<listitem><simpara> the name of the member
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the string value of the object's member
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
</refsect1>
</refentry>
|
