<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Akonadi.Item</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>Item Class Reference</h1>
<code>from PyKDE4.akonadi import *</code>
<p>
Inherits: <a href="../akonadi/Akonadi.Entity.html">Akonadi.Entity</a><br />
Namespace: <a href="../akonadi/Akonadi.html">Akonadi</a><br />
<h2>Detailed Description</h2>
<p>Represents a PIM item stored in Akonadi storage.
</p>
<p>
A PIM item consists of one or more parts, allowing a fine-grained access on its
content where needed (eg. mail envelope, mail body and attachments).
</p>
<p>
There is also a namespace (prefix) for special parts which are local to Akonadi.
These parts, prefixed by "akonadi-" will never be fetched in the resource.
They are useful for local extensions like agents which might want to add meta data
to items in order to handle them but the meta data should not be stored back to the
resource.
</p>
<p>
This class is implicitly shared.
</p>
<p>
<h4>Payload</h4>
</p>
<p>
This class contains, beside some type-agnostic information (flags, revision),
zero or more payload objects representing its actual data. Which objects these actually
are depends on the mimetype of the item and the corresponding serializer plugin(s).
</p>
<p>
Technically the only restriction on payload objects is that they have to be copyable.
For safety reasons, pointer payloads are forbidden as well though, as the
ownership would not be clear. In this case, usage of a shared pointer is
recommended (such as boost.shared_ptr or QSharedPointer).
</p>
<p>
Using a shared pointer is also required in case the payload is a polymorphic
type. For supported shared pointer types implicit casting is provided when possible.
</p>
<p>
When using a value-based class as payload, it is recommended to use one that does
support implicit sharing as setting and retrieving a payload as well as copying
an Akonadi.Item object imply copying of the payload object.
</p>
<p>
Since KDE 4.6, Item supports multiple payload types per mime type,
and will automatically convert between them using the serialiser
plugins (which is slow). It also supports mixing shared pointer
types, e.g. inserting a boost.shared_ptr<Foo> and extracting a
QSharedPointer<Foo>. Since the two shared pointer types cannot
share ownership of the same object, the payload class T needs to
provide a clone() method with the usual signature, ie.
</p>
<p>
<pre class="fragment">
virtual T * T.clone() const
</pre>
</p>
<p>
If the class that does not have a clone() method, asking for an
incompatible shared pointer will throw a PayloadException.
</p>
<p>
Since using different shared pointer types and different payload
types for the same mimetype incurs slow conversions (between
payload types) and cloning (between shared pointer types), as well
as manifold memory usage (results of conversions are cached inside
the Item, and only destroyed when a new payload is set by the user
of the class), you want to restrict yourself to just one type and
one shared pointer type. This mechanism was mainly introduced for
backwards compatibility (e.g., putting in a
boost.shared_ptr<KCal.Incidence> and extracting a
QSharedPointer<KCalCore.Incidence>), so it is not optimized for
performance.
</p>
<p>
The availability of a payload of a specific type can be checked using hasPayload(),
payloads can be retrieved by using payload() and set by using setPayload(). Refer
to the documentation of those methods for more details.
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Volker Krause <vkrause@kde.org>, Till Adam <adam@kde.org>, Marc Mutz <mutz@kde.org> </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#UrlType">UrlType</a> </td><td class="memItemRight" valign="bottom">{ UrlShort, UrlWithMimeType }</td></tr>
<tr><td colspan="2"><br><h2>Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#varFullPayload">FullPayload</a></td></tr><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Item">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Item">__init__</a> (self, QString mimeType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Item">__init__</a> (self, <a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a> other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Item">__init__</a> (self, long id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#apply">apply</a> (self, <a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a> other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QVector<int> </td><td class="memItemRight" valign="bottom"><a class="el" href="#availablePayloadMetaTypeIds">availablePayloadMetaTypeIds</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QSet<QByteArray> </td><td class="memItemRight" valign="bottom"><a class="el" href="#availablePayloadParts">availablePayloadParts</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clearFlag">clearFlag</a> (self, QByteArray name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clearFlags">clearFlags</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clearPayload">clearPayload</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QSet<QByteArray> </td><td class="memItemRight" valign="bottom"><a class="el" href="#flags">flags</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasFlag">hasFlag</a> (self, QByteArray name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasPayload">hasPayload</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QSet<QByteArray> </td><td class="memItemRight" valign="bottom"><a class="el" href="#loadedPayloadParts">loadedPayloadParts</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#mimeType">mimeType</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QDateTime </td><td class="memItemRight" valign="bottom"><a class="el" href="#modificationTime">modificationTime</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="#payloadData">payloadData</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#revision">revision</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFlag">setFlag</a> (self, QByteArray name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFlags">setFlags</a> (self, QSet<QByteArray> flags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMimeType">setMimeType</a> (self, QString mimeType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setModificationTime">setModificationTime</a> (self, QDateTime datetime)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPayloadFromData">setPayloadFromData</a> (self, QByteArray data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setRevision">setRevision</a> (self, int revision)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSize">setSize</a> (self, long size)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#size">size</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#storageCollectionId">storageCollectionId</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.html">KUrl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#url">url</a> (self, <a href="../akonadi/Akonadi.Item.html#UrlType">Akonadi.Item.UrlType</a> type=Akonadi.Item.UrlShort)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#fromUrl">fromUrl</a> (<a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="Item"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Creates a new item.
</p></div></div><a class="anchor" name="Item"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>mimeType</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates a new item with the given mime type.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>mimeType</em> </td><td> The mime type of the item.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="Item"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a> </td>
<td class="paramname"><em>other</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates a new item from an <b>other</b> item.
</p></div></div><a class="anchor" name="Item"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>id</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates a new item with the given unique <b>id.</b>
</p></div></div><a class="anchor" name="apply"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> apply</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a> </td>
<td class="paramname"><em>other</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Applies the parts of Item <b>other</b> to this item.
Any parts or attributes available in other, will be applied to this item,
and the payload parts of other will be inserted into this item, overwriting
any existing parts with the same part name.
</p>
<p>
If there is an ItemSerialzerPluginV2 for the type, the merge method in that plugin is
used to perform the merge. If only an ItemSerialzerPlugin class is found, or the merge
method of the -V2 plugin is not implemented, the merge is performed with multiple deserializations
of the payload.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="availablePayloadMetaTypeIds"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QVector<int> availablePayloadMetaTypeIds</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns a list of metatype-ids, describing the different
variants of payload that are currently contained in this item.
</p>
<p>
The result is always sorted (increasing ids).
</p></div></div><a class="anchor" name="availablePayloadParts"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QSet<QByteArray> availablePayloadParts</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the parts available for this item.
</p>
<p>
The returned set refers to parts available on the akonadi server or remotely,
but does not include the loadedPayloadParts() of this item.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="clearFlag"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clearFlag</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QByteArray </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Removes the flag with the given <b>name</b> from the item.
</p></div></div><a class="anchor" name="clearFlags"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clearFlags</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Removes all flags from the item.
</p></div></div><a class="anchor" name="clearPayload"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clearPayload</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Marks that the payload shall be cleared from the cache when this
item is passed to an ItemModifyJob the next time.
This will trigger a refetch of the payload from the backend when the
item is accessed afterwards. Only resources should have a need for
this functionality.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="flags"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QSet<QByteArray> flags</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns all flags of this item.
</p></div></div><a class="anchor" name="hasFlag"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasFlag</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QByteArray </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns whether the flag with the given <b>name</b> is
set in the item.
</p></div></div><a class="anchor" name="hasPayload"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasPayload</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns whether the item has a payload of type T.
This method will only return true if either you requested the exact same payload type
that was put in or the payload uses a supported shared pointer type (currently boost.shared_ptr
and QSharedPointer), and is castable to the requested type. For this to work there needs
to be a specialization of Akonadi.super_trait of the used classes.
</p>
<p>
Trying to retrieve a pointer type will fail to compile.
</p></div></div><a class="anchor" name="loadedPayloadParts"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QSet<QByteArray> loadedPayloadParts</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the list of loaded payload parts. This is not necessarily
identical to all parts in the cache or to all available parts on the backend.
</p></div></div><a class="anchor" name="mimeType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString mimeType</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the mime type of the item.
</p></div></div><a class="anchor" name="modificationTime"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QDateTime modificationTime</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the timestamp of the last modification of this item.
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.2
</dd></dl>
</p></div></div><a class="anchor" name="payloadData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QByteArray payloadData</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the full payload in its canonical representation, e.g. the
binary or textual format usually used for data with this mime type.
This is useful when communicating with non-Akonadi application by
e.g. drag&drop, copy&paste or stored files.
</p></div></div><a class="anchor" name="revision"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int revision</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the revision number of the item.
</p></div></div><a class="anchor" name="setFlag"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setFlag</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QByteArray </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the flag with the given <b>name</b> in the item.
</p></div></div><a class="anchor" name="setFlags"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setFlags</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QSet<QByteArray> </td>
<td class="paramname"><em>flags</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Overwrites all flags of the item by the given <b>flags.</b>
</p></div></div><a class="anchor" name="setMimeType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setMimeType</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>mimeType</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the mime type of the item to <b>mimeType.</b>
</p></div></div><a class="anchor" name="setModificationTime"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setModificationTime</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QDateTime </td>
<td class="paramname"><em>datetime</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the timestamp of the last modification of this item.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> Do not modify this value from within an application,
it is updated automatically by the revision checking functions.
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.2
</dd></dl>
</p></div></div><a class="anchor" name="setPayloadFromData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setPayloadFromData</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QByteArray </td>
<td class="paramname"><em>data</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the payload based on the canonical representation normally
used for data of this mime type.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>data</em> </td><td> The encoded data.
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> fullPayloadData
</dd></dl>
</p></div></div><a class="anchor" name="setRevision"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setRevision</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>revision</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the <b>revision</b> number of the item.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> Do not modify this value from within an application,
it is updated automatically by the revision checking functions.
</dd></dl>
</p></div></div><a class="anchor" name="setSize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setSize</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>size</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the size of the item in bytes.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.2
</dd></dl>
</p></div></div><a class="anchor" name="size"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long size</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the size of the items in bytes.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.2
</dd></dl>
</p></div></div><a class="anchor" name="storageCollectionId"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long storageCollectionId</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the unique identifier of the collection this item is stored in. There is only
a single such collection, although the item can be linked into arbitrary many
virtual collections.
Calling this method makes sense only after running an ItemFetchJob on the item.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the collection ID if it is known, -1 otherwise.
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="url"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KUrl.html">KUrl</a> url</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../akonadi/Akonadi.Item.html#UrlType">Akonadi.Item.UrlType</a> </td>
<td class="paramname"><em>type=Akonadi.Item.UrlShort</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the url of the item.
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="fromUrl"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../akonadi/Akonadi.Item.html">Akonadi.Item</a> fromUrl</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates an item from the given <b>url.</b>
</p></div></div><hr><h2>Attribute Documentation</h2><a class="anchor" name="varFullPayload"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">QString FullPayload</td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><p><hr><h2>Enumeration Documentation</h2><a class="anchor" name="UrlType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">UrlType</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Describes the type of url which is returned in url().
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>UrlShort</em> = 0</td><td><tr><td valign="top"><em>UrlWithMimeType</em> = 1</td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
