Blame docs/reference/html/GDataParsable.html

Packit 4b6dd7
Packit 4b6dd7
<html>
Packit 4b6dd7
<head>
Packit 4b6dd7
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 4b6dd7
<title>GDataParsable: GData Reference Manual</title>
Packit 4b6dd7
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 4b6dd7
<link rel="home" href="index.html" title="GData Reference Manual">
Packit 4b6dd7
<link rel="up" href="ch02.html" title="Core API">
Packit 4b6dd7
<link rel="prev" href="gdata-GData-Types.html" title="GData Types">
Packit 4b6dd7
<link rel="next" href="GDataDownloadStream.html" title="GDataDownloadStream">
Packit 4b6dd7
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
Packit 4b6dd7
<link rel="stylesheet" href="style.css" type="text/css">
Packit 4b6dd7
</head>
Packit 4b6dd7
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Top  | 
Packit 4b6dd7
                  Description  | 
Packit 4b6dd7
                  Object Hierarchy  | 
Packit 4b6dd7
                  Properties
Packit 4b6dd7
Packit 4b6dd7
Home
Packit 4b6dd7
Up
Packit 4b6dd7
Prev
Packit 4b6dd7
Next
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDataParsable

Packit 4b6dd7

GDataParsable — GData parsable object

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Stability Level

Packit 4b6dd7
Packit 4b6dd7
develop applications to these interfaces, release them, and have confidence that
Packit 4b6dd7
they will run on all minor releases of the product (after the one in which the
Packit 4b6dd7
interface was introduced, and within the same major release). Even at a major
Packit 4b6dd7
release, incompatible changes are expected to be rare, and to have strong
Packit 4b6dd7
justifications.
Packit 4b6dd7
">Stable, unless otherwise indicated
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
const gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_parsable_get_content_type ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataParsable *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_parsable_new_from_xml ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_parsable_get_xml ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataParsable *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_parsable_new_from_json ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_parsable_get_json ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Properties

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
constructed-from-xml
Packit 4b6dd7
Read / Write / Construct Only
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataParsable
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataParsableClass
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Object Hierarchy

Packit 4b6dd7
    GObject
Packit 4b6dd7
    ╰── GDataParsable
Packit 4b6dd7
        ├── GDataEntry
Packit 4b6dd7
        ├── GDataAPPCategories
Packit 4b6dd7
        ├── GDataAuthor
Packit 4b6dd7
        ├── GDataFeed
Packit 4b6dd7
        ├── GDataCategory
Packit 4b6dd7
        ├── GDataDocumentsMetadata
Packit 4b6dd7
        ├── GDataGContactCalendar
Packit 4b6dd7
        ├── GDataGContactEvent
Packit 4b6dd7
        ├── GDataGContactExternalID
Packit 4b6dd7
        ├── GDataGContactJot
Packit 4b6dd7
        ├── GDataGContactLanguage
Packit 4b6dd7
        ├── GDataGContactRelation
Packit 4b6dd7
        ├── GDataGContactWebsite
Packit 4b6dd7
        ├── GDataGDEmailAddress
Packit 4b6dd7
        ├── GDataGDIMAddress
Packit 4b6dd7
        ├── GDataGDName
Packit 4b6dd7
        ├── GDataGDOrganization
Packit 4b6dd7
        ├── GDataGDPhoneNumber
Packit 4b6dd7
        ├── GDataGDPostalAddress
Packit 4b6dd7
        ├── GDataGDReminder
Packit 4b6dd7
        ├── GDataGDWhen
Packit 4b6dd7
        ├── GDataGDWhere
Packit 4b6dd7
        ├── GDataGDWho
Packit 4b6dd7
        ├── GDataGenerator
Packit 4b6dd7
        ├── GDataLink
Packit 4b6dd7
        ├── GDataMediaCategory
Packit 4b6dd7
        ├── GDataMediaContent
Packit 4b6dd7
        ├── GDataMediaCredit
Packit 4b6dd7
        ├── GDataMediaThumbnail
Packit 4b6dd7
        ╰── GDataYouTubeState
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Includes

Packit 4b6dd7
#include <gdata/gdata-parsable.h>
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Description

Packit 4b6dd7

GDataParsable is an abstract class allowing easy implementation of an extensible parser. It is primarily extended by GDataFeed and GDataEntry,

Packit 4b6dd7
both of which require XML parsing which can be extended by subclassing.

Packit 4b6dd7

It allows methods to be defined for handling the root XML node, each of its child nodes, and a method to be called after parsing is complete.

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7

gdata_parsable_get_content_type ()

Packit 4b6dd7
const gchar *
Packit 4b6dd7
gdata_parsable_get_content_type (GDataParsable *self);
Packit 4b6dd7

Returns the content type upon which the GDataParsable is built. For example, application/atom+xml or application/json.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataParsable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the parsable's content type

Packit 4b6dd7
Packit 4b6dd7

Since: 0.17.7

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_parsable_new_from_xml ()

Packit 4b6dd7
GDataParsable *
Packit 4b6dd7
gdata_parsable_new_from_xml (GType parsable_type,
Packit 4b6dd7
                             const gchar *xml,
Packit 4b6dd7
                             gint length,
Packit 4b6dd7
                             GError **error);
Packit 4b6dd7

Creates a new GDataParsable subclass (of the given parsable_type

Packit 4b6dd7
) from the given xml
Packit 4b6dd7
.

Packit 4b6dd7

An object of the given parsable_type

Packit 4b6dd7
 is created, and its pre_parse_xml, parse_xml and
Packit 4b6dd7
post_parse_xml class functions called on the XML tree obtained from xml
Packit 4b6dd7
. pre_parse_xml and
Packit 4b6dd7
post_parse_xml are called once each on the root node of the tree, while parse_xml is called for
Packit 4b6dd7
each of the child nodes of the root node.

Packit 4b6dd7

If length

Packit 4b6dd7
 is -1, xml
Packit 4b6dd7
 will be assumed to be null-terminated.

Packit 4b6dd7

If an error occurs during parsing, a suitable error from GDataParserError will be returned.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

parsable_type

Packit 4b6dd7

the type of the class represented by the XML

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

xml

Packit 4b6dd7

the XML for just the parsable object, with full namespace declarations

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

length

Packit 4b6dd7

the length of xml

Packit 4b6dd7
, or -1

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a new GDataParsable, or NULL; unref with g_object_unref()

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_parsable_get_xml ()

Packit 4b6dd7
gchar *
Packit 4b6dd7
gdata_parsable_get_xml (GDataParsable *self);
Packit 4b6dd7

Builds an XML representation of the GDataParsable in its current state, such that it could be inserted on the server. The XML is guaranteed

Packit 4b6dd7
to have all its namespaces declared properly in a self-contained fashion, and is valid for stand-alone use.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataParsable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the object's XML; free with g_free()

Packit 4b6dd7
Packit 4b6dd7

Since: 0.4.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_parsable_new_from_json ()

Packit 4b6dd7
GDataParsable *
Packit 4b6dd7
gdata_parsable_new_from_json (GType parsable_type,
Packit 4b6dd7
                              const gchar *json,
Packit 4b6dd7
                              gint length,
Packit 4b6dd7
                              GError **error);
Packit 4b6dd7

Creates a new GDataParsable subclass (of the given parsable_type

Packit 4b6dd7
) from the given json
Packit 4b6dd7
.

Packit 4b6dd7

An object of the given parsable_type

Packit 4b6dd7
 is created, and its parse_json and
Packit 4b6dd7
post_parse_json class functions called on the JSON node obtained from json
Packit 4b6dd7
.
Packit 4b6dd7
post_parse_json is called once on the root node, while parse_json is called for
Packit 4b6dd7
each of the node's members.

Packit 4b6dd7

If length

Packit 4b6dd7
 is -1, json
Packit 4b6dd7
 will be assumed to be nul-terminated.

Packit 4b6dd7

If an error occurs during parsing, a suitable error from GDataParserError will be returned.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

parsable_type

Packit 4b6dd7

the type of the class represented by the JSON

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

json

Packit 4b6dd7

the JSON for just the parsable object

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

length

Packit 4b6dd7

the length of json

Packit 4b6dd7
, or -1

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a new GDataParsable, or NULL; unref with g_object_unref()

Packit 4b6dd7
Packit 4b6dd7

Since: 0.15.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_parsable_get_json ()

Packit 4b6dd7
gchar *
Packit 4b6dd7
gdata_parsable_get_json (GDataParsable *self);
Packit 4b6dd7

Builds a JSON representation of the GDataParsable in its current state, such that it could be inserted on the server. The JSON

Packit 4b6dd7
is valid for stand-alone use.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataParsable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the object's JSON; free with g_free()

Packit 4b6dd7
Packit 4b6dd7

Since: 0.15.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7

GDataParsable

Packit 4b6dd7
typedef struct _GDataParsable GDataParsable;
Packit 4b6dd7

All the fields in the GDataParsable structure are private and should never be accessed directly.

Packit 4b6dd7

Since: 0.3.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDataParsableClass

Packit 4b6dd7
typedef struct {
Packit 4b6dd7
	GObjectClass parent;
Packit 4b6dd7
Packit 4b6dd7
	gboolean (*pre_parse_xml) (GDataParsable *parsable, xmlDoc *doc, xmlNode *root_node, gpointer user_data, GError **error);
Packit 4b6dd7
	gboolean (*parse_xml) (GDataParsable *parsable, xmlDoc *doc, xmlNode *node, gpointer user_data, GError **error);
Packit 4b6dd7
	gboolean (*post_parse_xml) (GDataParsable *parsable, gpointer user_data, GError **error);
Packit 4b6dd7
Packit 4b6dd7
	void (*pre_get_xml) (GDataParsable *parsable, GString *xml_string);
Packit 4b6dd7
	void (*get_xml) (GDataParsable *parsable, GString *xml_string);
Packit 4b6dd7
	void (*get_namespaces) (GDataParsable *parsable, GHashTable *namespaces);
Packit 4b6dd7
Packit 4b6dd7
	gboolean (*parse_json) (GDataParsable *parsable, JsonReader *reader, gpointer user_data, GError **error);
Packit 4b6dd7
	gboolean (*post_parse_json) (GDataParsable *parsable, gpointer user_data, GError **error);
Packit 4b6dd7
	void (*get_json) (GDataParsable *parsable, JsonBuilder *builder);
Packit 4b6dd7
Packit 4b6dd7
	const gchar *(*get_content_type) (void);
Packit 4b6dd7
Packit 4b6dd7
	const gchar *element_name;
Packit 4b6dd7
	const gchar *element_namespace;
Packit 4b6dd7
} GDataParsableClass;
Packit 4b6dd7
Packit 4b6dd7

The class structure for the GDataParsable class. Note that JSON and XML functions are mutually exclusive:

Packit 4b6dd7
a given implementation of GDataParsable is represented as exactly one of JSON and XML.

Packit 4b6dd7
Packit 4b6dd7

Members

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GObjectClass parent;

Packit 4b6dd7

the parent class

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

pre_parse_xml ()

Packit 4b6dd7

a function called before parsing of an XML tree is started, which allows properties from the root node to be extracted

Packit 4b6dd7
and used in parsable
Packit 4b6dd7

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

parse_xml ()

Packit 4b6dd7

a function to parse an XML representation of the GDataParsable to set the properties of the parsable

Packit 4b6dd7

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

post_parse_xml ()

Packit 4b6dd7

a function called after parsing an XML tree, to allow the parsable

Packit 4b6dd7
to validate the parsed properties

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

pre_get_xml ()

Packit 4b6dd7

a function called before building the XML representation of the children of the GDataParsable, which allows attributes of the root

Packit 4b6dd7
XML node to be added to xml_string
Packit 4b6dd7

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

get_xml ()

Packit 4b6dd7

a function to build an XML representation of the GDataParsable in its current state, appending it to the provided GString

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

get_namespaces ()

Packit 4b6dd7

a function to return a string containing the namespace declarations used by the parsable

Packit 4b6dd7
when represented in XML form

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

parse_json ()

Packit 4b6dd7

a function to parse a JSON representation of the GDataParsable to set the properties of the parsable

Packit 4b6dd7

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

post_parse_json ()

Packit 4b6dd7

a function called after parsing a JSON object, to allow the parsable

Packit 4b6dd7
to validate the parsed properties

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

get_json ()

Packit 4b6dd7

a function to build a JSON representation of the GDataParsable in its current state, appending it to the provided JsonBuilder

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

get_content_type ()

Packit 4b6dd7

a function which returns content type upon which is GDataParsable built

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

const gchar *element_name;

Packit 4b6dd7

the name of the XML element which represents this parsable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

const gchar *element_namespace;

Packit 4b6dd7

the prefix of the XML namespace used for the parsable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.3.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Property Details

Packit 4b6dd7
Packit 4b6dd7

The “constructed-from-xml” property

Packit 4b6dd7
  “constructed-from-xml”     gboolean
Packit 4b6dd7

Specifies whether the object was constructed by parsing XML or manually.

Packit 4b6dd7

Flags: Read / Write / Construct Only

Packit 4b6dd7

Default value: FALSE

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Generated by GTK-Doc V1.26.1
Packit 4b6dd7
</body>
Packit 4b6dd7
</html>