Blame gdata/services/documents/gdata-documents-folder.c

Packit 4b6dd7
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
Packit 4b6dd7
/*
Packit 4b6dd7
 * GData Client
Packit 4b6dd7
 * Copyright (C) Thibault Saunier 2009 <saunierthibault@gmail.com>
Packit 4b6dd7
 * Copyright (C) Philip Withnall 2010 <philip@tecnocode.co.uk>
Packit 4b6dd7
 * Copyright (C) Red Hat, Inc. 2015, 2016
Packit 4b6dd7
 *
Packit 4b6dd7
 * GData Client is free software; you can redistribute it and/or
Packit 4b6dd7
 * modify it under the terms of the GNU Lesser General Public
Packit 4b6dd7
 * License as published by the Free Software Foundation; either
Packit 4b6dd7
 * version 2.1 of the License, or (at your option) any later version.
Packit 4b6dd7
 *
Packit 4b6dd7
 * GData Client is distributed in the hope that it will be useful,
Packit 4b6dd7
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 4b6dd7
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 4b6dd7
 * Lesser General Public License for more details.
Packit 4b6dd7
 *
Packit 4b6dd7
 * You should have received a copy of the GNU Lesser General Public
Packit 4b6dd7
 * License along with GData Client.  If not, see <http://www.gnu.org/licenses/>.
Packit 4b6dd7
 */
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * SECTION:gdata-documents-folder
Packit 4b6dd7
 * @short_description: GData documents folder object
Packit 4b6dd7
 * @stability: Stable
Packit 4b6dd7
 * @include: gdata/services/documents/gdata-documents-folder.h
Packit 4b6dd7
 *
Packit 4b6dd7
 * #GDataDocumentsFolder is a subclass of #GDataDocumentsEntry to represent a folder from Google Documents.
Packit 4b6dd7
 *
Packit 4b6dd7
 * For more details of Google Drive's GData API, see the
Packit 4b6dd7
 * <ulink type="http" url="https://developers.google.com/drive/v2/web/about-sdk">online documentation</ulink>.
Packit 4b6dd7
 *
Packit 4b6dd7
 * <example>
Packit 4b6dd7
 * 	<title>Adding a Folder</title>
Packit 4b6dd7
 * 	<programlisting>
Packit 4b6dd7
 * 	GDataAuthorizationDomain *domain;
Packit 4b6dd7
 *	GDataDocumentsService *service;
Packit 4b6dd7
 *	GDataDocumentsFolder *folder, *new_folder, *parent_folder;
Packit 4b6dd7
 *	GError *error = NULL;
Packit 4b6dd7
 *
Packit 4b6dd7
 *	domain = gdata_documents_service_get_primary_authorization_domain ();
Packit 4b6dd7
 *
Packit 4b6dd7
 *	/* Create a service */
Packit 4b6dd7
 *	service = create_documents_service ();
Packit 4b6dd7
 *
Packit 4b6dd7
 *	parent_folder = GDATA_DOCUMENTS_FOLDER (gdata_service_query_single_entry (GDATA_SERVICE (service), domain, "root", NULL,
Packit 4b6dd7
 *	                                                                          GDATA_TYPE_DOCUMENTS_FOLDER, NULL, &error));
Packit 4b6dd7
 *	if (error != NULL) {
Packit 4b6dd7
 *		g_error ("Error getting root folder");
Packit 4b6dd7
 *		g_error_free (error);
Packit 4b6dd7
 *		return;
Packit 4b6dd7
 *	}
Packit 4b6dd7
 *
Packit 4b6dd7
 *	/* Create the new folder */
Packit 4b6dd7
 *	folder = gdata_documents_folder_new (NULL);
Packit 4b6dd7
 *	gdata_entry_set_title (GDATA_ENTRY (folder), "Folder Name");
Packit 4b6dd7
 *
Packit 4b6dd7
 *	/* Insert the folder */
Packit 4b6dd7
 *	new_folder = GDATA_DOCUMENTS_FOLDER (gdata_documents_service_add_entry_to_folder (GDATA_SERVICE (service), GDATA_DOCUMENTS_ENTRY (folder),
Packit 4b6dd7
 *	parent_folder, NULL, &error));
Packit 4b6dd7
 *
Packit 4b6dd7
 *	g_object_unref (folder);
Packit 4b6dd7
 *	g_object_unref (parent_folder);
Packit 4b6dd7
 *	g_object_unref (service);
Packit 4b6dd7
 *
Packit 4b6dd7
 *	if (error != NULL) {
Packit 4b6dd7
 *		g_error ("Error inserting new folder: %s", error->message);
Packit 4b6dd7
 *		g_error_free (error);
Packit 4b6dd7
 *		return;
Packit 4b6dd7
 *	}
Packit 4b6dd7
 *
Packit 4b6dd7
 *	/* Do something with the new folder, such as store its ID for future use */
Packit 4b6dd7
 *
Packit 4b6dd7
 *	g_object_unref (new_folder);
Packit 4b6dd7
 * 	</programlisting>
Packit 4b6dd7
 * </example>
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.4.0
Packit 4b6dd7
 */
Packit 4b6dd7
Packit 4b6dd7
#include <config.h>
Packit 4b6dd7
#include <glib.h>
Packit 4b6dd7
#include <glib/gi18n-lib.h>
Packit 4b6dd7
#include <libxml/parser.h>
Packit 4b6dd7
#include <string.h>
Packit 4b6dd7
Packit 4b6dd7
#include "gdata-documents-folder.h"
Packit 4b6dd7
#include "gdata-documents-utils.h"
Packit 4b6dd7
#include "gdata-parser.h"
Packit 4b6dd7
#include "gdata-types.h"
Packit 4b6dd7
#include "gdata-private.h"
Packit 4b6dd7
Packit 4b6dd7
static void gdata_documents_folder_constructed (GObject *object);
Packit 4b6dd7
Packit 4b6dd7
G_DEFINE_TYPE (GDataDocumentsFolder, gdata_documents_folder, GDATA_TYPE_DOCUMENTS_ENTRY)
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
gdata_documents_folder_class_init (GDataDocumentsFolderClass *klass)
Packit 4b6dd7
{
Packit 4b6dd7
	GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
Packit 4b6dd7
	GDataEntryClass *entry_class = GDATA_ENTRY_CLASS (klass);
Packit 4b6dd7
Packit 4b6dd7
	gobject_class->constructed = gdata_documents_folder_constructed;
Packit 4b6dd7
	entry_class->kind_term = "http://schemas.google.com/docs/2007#folder";
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
gdata_documents_folder_init (GDataDocumentsFolder *self)
Packit 4b6dd7
{
Packit 4b6dd7
	/* Why am I writing it? */
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
gdata_documents_folder_constructed (GObject *object)
Packit 4b6dd7
{
Packit 4b6dd7
	G_OBJECT_CLASS (gdata_documents_folder_parent_class)->constructed (object);
Packit 4b6dd7
Packit 4b6dd7
	if (!_gdata_parsable_is_constructed_from_xml (GDATA_PARSABLE (object)))
Packit 4b6dd7
		gdata_documents_utils_add_content_type (GDATA_DOCUMENTS_ENTRY (object), "application/vnd.google-apps.folder");
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
/**
Packit 4b6dd7
 * gdata_documents_folder_new:
Packit 4b6dd7
 * @id: (allow-none): the entry's ID (not the document ID of the folder), or %NULL
Packit 4b6dd7
 *
Packit 4b6dd7
 * Creates a new #GDataDocumentsFolder with the given entry ID (#GDataEntry:id).
Packit 4b6dd7
 *
Packit 4b6dd7
 * Return value: a new #GDataDocumentsFolder, or %NULL; unref with g_object_unref()
Packit 4b6dd7
 *
Packit 4b6dd7
 * Since: 0.4.0
Packit 4b6dd7
 */
Packit 4b6dd7
GDataDocumentsFolder *
Packit 4b6dd7
gdata_documents_folder_new (const gchar *id)
Packit 4b6dd7
{
Packit 4b6dd7
	return GDATA_DOCUMENTS_FOLDER (g_object_new (GDATA_TYPE_DOCUMENTS_FOLDER, "id", id, NULL));
Packit 4b6dd7
}