<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qnearfieldsharetarget.cpp -->
<title>QNearFieldShareTarget Class | Qt NFC 5.12.6</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qtnfc-index.html">Qt NFC</a></td><td ><a href="qtnfc-module.html">C++ Classes</a></td><td >QNearFieldShareTarget</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtnfc-index.html">Qt 5.12.6 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QNearFieldShareTarget Class</h1>
<!-- $$$QNearFieldShareTarget-brief -->
<p>The <a href="qnearfieldsharetarget.html">QNearFieldShareTarget</a> class transfers data to remote device over NFC. <a href="#details">More...</a></p>
<!-- @@@QNearFieldShareTarget -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QNearFieldShareTarget></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += nfc</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.3</td></tr></table></div><ul>
<li><a href="qnearfieldsharetarget-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qnearfieldsharetarget.html#dtor.QNearFieldShareTarget">~QNearFieldShareTarget</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qnearfieldsharetarget.html#cancel">cancel</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qnearfieldsharetarget.html#isShareInProgress">isShareInProgress</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qnearfieldsharetarget.html#share">share</a></b>(const QNdefMessage &<i>message</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qnearfieldsharetarget.html#share-1">share</a></b>(const QList<QFileInfo> &<i>files</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QNearFieldShareManager::ShareError </td><td class="memItemRight bottomAlign"><b><a href="qnearfieldsharetarget.html#shareError">shareError</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QNearFieldShareManager::ShareModes </td><td class="memItemRight bottomAlign"><b><a href="qnearfieldsharetarget.html#shareModes">shareModes</a></b>() const</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qnearfieldsharetarget.html#error">error</a></b>(QNearFieldShareManager::ShareError <i>error</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qnearfieldsharetarget.html#shareFinished">shareFinished</a></b>()</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qnearfieldsharetarget.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QNearFieldShareTarget-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qnearfieldsharetarget.html">QNearFieldShareTarget</a> class transfers data to remote device over NFC.</p>
<p>The <a href="qnearfieldsharetarget.html">QNearFieldShareTarget</a> class can be used for sharing NDEF message or files to a remote NFC enabled device supporting the same protocol.</p>
</div>
<p><b>See also </b><a href="qnearfieldsharemanager.html">QNearFieldShareManager</a>.</p>
<!-- @@@QNearFieldShareTarget -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$~QNearFieldShareTarget[overload1]$$$~QNearFieldShareTarget -->
<h3 class="fn" id="dtor.QNearFieldShareTarget"><a name="dtor.QNearFieldShareTarget"></a><code>[virtual] </code>QNearFieldShareTarget::<span class="name">~QNearFieldShareTarget</span>()</h3>
<p>Destroys the near field share target.</p>
<!-- @@@~QNearFieldShareTarget -->
<!-- $$$cancel[overload1]$$$cancel -->
<h3 class="fn" id="cancel"><a name="cancel"></a><span class="type">void</span> QNearFieldShareTarget::<span class="name">cancel</span>()</h3>
<p>Cancel the data or file sharing in progress.</p>
<!-- @@@cancel -->
<!-- $$$error[overload1]$$$errorQNearFieldShareManager::ShareError -->
<h3 class="fn" id="error"><a name="error"></a><code>[signal] </code><span class="type">void</span> QNearFieldShareTarget::<span class="name">error</span>(<span class="type"><a href="qnearfieldsharemanager.html#ShareError-enum">QNearFieldShareManager::ShareError</a></span> <i>error</i>)</h3>
<p>This signal is emitted whenever an <i>error</i> occurs during transfer.</p>
<!-- @@@error -->
<!-- $$$isShareInProgress[overload1]$$$isShareInProgress -->
<h3 class="fn" id="isShareInProgress"><a name="isShareInProgress"></a><span class="type">bool</span> QNearFieldShareTarget::<span class="name">isShareInProgress</span>() const</h3>
<p>Returns true if data or file sharing is in progress, otherwise returns false.</p>
<!-- @@@isShareInProgress -->
<!-- $$$share[overload1]$$$shareconstQNdefMessage& -->
<h3 class="fn" id="share"><a name="share"></a><span class="type">bool</span> QNearFieldShareTarget::<span class="name">share</span>(const <span class="type"><a href="qndefmessage.html">QNdefMessage</a></span> &<i>message</i>)</h3>
<p>Share the NDEF <i>message</i> via the share target. This method starts sharing asynchronously and returns immediately. The method returns true if the request is accepted, otherwise returns false. Sharing is completed when the <a href="qnearfieldsharetarget.html#shareFinished">shareFinished</a>() signal is emitted.</p>
<!-- @@@share -->
<!-- $$$share$$$shareconstQList<QFileInfo>& -->
<h3 class="fn" id="share-1"><a name="share-1"></a><span class="type">bool</span> QNearFieldShareTarget::<span class="name">share</span>(const <span class="type">QList</span><<span class="type">QFileInfo</span>> &<i>files</i>)</h3>
<p>Share the <i>files</i> via the share target. This method starts sharing asynchronously and returns immediately. The method returns true if the request is accepted, otherwise returns false. Sharing is completed when the <a href="qnearfieldsharetarget.html#shareFinished">shareFinished</a>() signal is emitted.</p>
<!-- @@@share -->
<!-- $$$shareError[overload1]$$$shareError -->
<h3 class="fn" id="shareError"><a name="shareError"></a><span class="type"><a href="qnearfieldsharemanager.html#ShareError-enum">QNearFieldShareManager::ShareError</a></span> QNearFieldShareTarget::<span class="name">shareError</span>() const</h3>
<p>Returns the error code of the error that occurred.</p>
<!-- @@@shareError -->
<!-- $$$shareFinished[overload1]$$$shareFinished -->
<h3 class="fn" id="shareFinished"><a name="shareFinished"></a><code>[signal] </code><span class="type">void</span> QNearFieldShareTarget::<span class="name">shareFinished</span>()</h3>
<p>This signal is emitted whenever a data or file transfer has completed successfully.</p>
<!-- @@@shareFinished -->
<!-- $$$shareModes[overload1]$$$shareModes -->
<h3 class="fn" id="shareModes"><a name="shareModes"></a><span class="type"><a href="qnearfieldsharemanager.html#ShareMode-enum">QNearFieldShareManager::ShareModes</a></span> QNearFieldShareTarget::<span class="name">shareModes</span>() const</h3>
<p>Returns the share mode supported by the share target.</p>
<!-- @@@shareModes -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
