Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GDataDocumentsMetadata: GData Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch16.html" title="Google Documents/Drive API">
<link rel="prev" href="GDataDocumentsText.html" title="GDataDocumentsText">
<link rel="next" href="GDataDocumentsAccessRule.html" title="GDataDocumentsAccessRule">
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GDataDocumentsMetadata.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GDataDocumentsMetadata.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GDataDocumentsMetadata.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch16.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataDocumentsText.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataDocumentsAccessRule.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataDocumentsMetadata"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataDocumentsMetadata.top_of_page"></a>GDataDocumentsMetadata</span></h2>
<p>GDataDocumentsMetadata — GData document service metadata class</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataDocumentsMetadata.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GDataDocumentsMetadata.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#goffset"><span class="returnvalue">goffset</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataDocumentsMetadata.html#gdata-documents-metadata-get-quota-total" title="gdata_documents_metadata_get_quota_total ()">gdata_documents_metadata_get_quota_total</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#goffset"><span class="returnvalue">goffset</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataDocumentsMetadata.html#gdata-documents-metadata-get-quota-used" title="gdata_documents_metadata_get_quota_used ()">gdata_documents_metadata_get_quota_used</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataDocumentsMetadata.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td>
<td class="property_name"><a class="link" href="GDataDocumentsMetadata.html#GDataDocumentsMetadata--quota-total" title="The “quota-total” property">quota-total</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td>
<td class="property_name"><a class="link" href="GDataDocumentsMetadata.html#GDataDocumentsMetadata--quota-used" title="The “quota-used” property">quota-used</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataDocumentsMetadata.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataDocumentsMetadata.html#GDataDocumentsMetadata-struct" title="GDataDocumentsMetadata">GDataDocumentsMetadata</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataDocumentsMetadata.html#GDataDocumentsMetadataClass" title="GDataDocumentsMetadataClass">GDataDocumentsMetadataClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataDocumentsMetadata.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a class="link" href="GDataParsable.html" title="GDataParsable">GDataParsable</a>
        <span class="lineart">╰──</span> GDataDocumentsMetadata
</pre>
</div>
<div class="refsect1">
<a name="GDataDocumentsMetadata.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gdata/services/documents/gdata-documents-metadata.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GDataDocumentsMetadata.description"></a><h2>Description</h2>
<p><a class="link" href="GDataDocumentsMetadata.html" title="GDataDocumentsMetadata"><span class="type">GDataDocumentsMetadata</span></a> is a subclass of <a class="link" href="GDataParsable.html" title="GDataParsable"><span class="type">GDataParsable</span></a> to represent Google Drive service metadata.</p>
<p>For more details of Google Documents' GData API, see the</p>
<a class="ulink" href="https://developers.google.com/drive/v2/web/about-sdk" target="_top">online documentation</a>.

</div>
<div class="refsect1">
<a name="GDataDocumentsMetadata.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-documents-metadata-get-quota-total"></a><h3>gdata_documents_metadata_get_quota_total ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#goffset"><span class="returnvalue">goffset</span></a>
gdata_documents_metadata_get_quota_total
                               (<em class="parameter"><code><a class="link" href="GDataDocumentsMetadata.html" title="GDataDocumentsMetadata"><span class="type">GDataDocumentsMetadata</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataDocumentsMetadata.html#GDataDocumentsMetadata--quota-total" title="The “quota-total” property"><span class="type">“quota-total”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-documents-metadata-get-quota-total.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataDocumentsMetadata.html" title="GDataDocumentsMetadata"><span class="type">GDataDocumentsMetadata</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-documents-metadata-get-quota-total.returns"></a><h4>Returns</h4>
<p> the number of quota bytes available in total. Returns -1 if
there is no quota limit.</p>
</div>
<p class="since">Since: <a class="link" href="ix25.html#api-index-0.17.9">0.17.9</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-documents-metadata-get-quota-used"></a><h3>gdata_documents_metadata_get_quota_used ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#goffset"><span class="returnvalue">goffset</span></a>
gdata_documents_metadata_get_quota_used
                               (<em class="parameter"><code><a class="link" href="GDataDocumentsMetadata.html" title="GDataDocumentsMetadata"><span class="type">GDataDocumentsMetadata</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataDocumentsMetadata.html#GDataDocumentsMetadata--quota-used" title="The “quota-used” property"><span class="type">“quota-used”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-documents-metadata-get-quota-used.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataDocumentsMetadata.html" title="GDataDocumentsMetadata"><span class="type">GDataDocumentsMetadata</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-documents-metadata-get-quota-used.returns"></a><h4>Returns</h4>
<p> the number of quota bytes used by the documents service</p>
</div>
<p class="since">Since: <a class="link" href="ix25.html#api-index-0.17.9">0.17.9</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataDocumentsMetadata.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDataDocumentsMetadata-struct"></a><h3>GDataDocumentsMetadata</h3>
<pre class="programlisting">typedef struct _GDataDocumentsMetadata GDataDocumentsMetadata;</pre>
<p>All the fields in the <a class="link" href="GDataDocumentsMetadata.html" title="GDataDocumentsMetadata"><span class="type">GDataDocumentsMetadata</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix25.html#api-index-0.17.9">0.17.9</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataDocumentsMetadataClass"></a><h3>GDataDocumentsMetadataClass</h3>
<pre class="programlisting">typedef struct {
} GDataDocumentsMetadataClass;
</pre>
<p>All the fields in the <a class="link" href="GDataDocumentsMetadata.html#GDataDocumentsMetadataClass" title="GDataDocumentsMetadataClass"><span class="type">GDataDocumentsMetadataClass</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix25.html#api-index-0.17.9">0.17.9</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataDocumentsMetadata.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GDataDocumentsMetadata--quota-total"></a><h3>The <code class="literal">“quota-total”</code> property</h3>
<pre class="programlisting">  “quota-total”              <a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre>
<p>The user quota limit across all services. Measured in bytes.</p>
<p>Flags: Read</p>
<p>Allowed values: &gt;= -1</p>
<p>Default value: 0</p>
<p class="since">Since: <a class="link" href="ix25.html#api-index-0.17.9">0.17.9</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataDocumentsMetadata--quota-used"></a><h3>The <code class="literal">“quota-used”</code> property</h3>
<pre class="programlisting">  “quota-used”               <a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre>
<p>The amount of user quota used up across all services. Measured in bytes.</p>
<p>Flags: Read</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
<p class="since">Since: <a class="link" href="ix25.html#api-index-0.17.9">0.17.9</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26.1</div>
</body>
</html>