<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qlowenergydescriptordata.cpp -->
<title>QLowEnergyDescriptorData Class | Qt Bluetooth 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="qtbluetooth-index.html">Qt Bluetooth</a></td><td ><a href="qtbluetooth-module.html">C++ Classes</a></td><td >QLowEnergyDescriptorData</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtbluetooth-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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QLowEnergyDescriptorData Class</h1>
<!-- $$$QLowEnergyDescriptorData-brief -->
<p>The <a href="qlowenergydescriptordata.html">QLowEnergyDescriptorData</a> class is used to create GATT service data. <a href="#details">More...</a></p>
<!-- @@@QLowEnergyDescriptorData -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QLowEnergyDescriptorData></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += bluetooth</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.7</td></tr></table></div><ul>
<li><a href="qlowenergydescriptordata-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"> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#QLowEnergyDescriptorData">QLowEnergyDescriptorData</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#QLowEnergyDescriptorData-1">QLowEnergyDescriptorData</a></b>(const QBluetoothUuid &<i>uuid</i>, const QByteArray &<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#QLowEnergyDescriptorData-2">QLowEnergyDescriptorData</a></b>(const QLowEnergyDescriptorData &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#dtor.QLowEnergyDescriptorData">~QLowEnergyDescriptorData</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#isReadable">isReadable</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#isValid">isValid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#isWritable">isWritable</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBluetooth::AttAccessConstraints </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#readConstraints">readConstraints</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#setReadPermissions">setReadPermissions</a></b>(bool <i>readable</i>, QBluetooth::AttAccessConstraints <i>constraints</i> = ...)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#setUuid">setUuid</a></b>(const QBluetoothUuid &<i>uuid</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#setValue">setValue</a></b>(const QByteArray &<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#setWritePermissions">setWritePermissions</a></b>(bool <i>writable</i>, QBluetooth::AttAccessConstraints <i>constraints</i> = ...)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#swap">swap</a></b>(QLowEnergyDescriptorData &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBluetoothUuid </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#uuid">uuid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QByteArray </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#value">value</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBluetooth::AttAccessConstraints </td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#writeConstraints">writeConstraints</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLowEnergyDescriptorData &</td><td class="memItemRight bottomAlign"><b><a href="qlowenergydescriptordata.html#operator-eq">operator=</a></b>(const QLowEnergyDescriptorData &<i>other</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QLowEnergyDescriptorData-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qlowenergydescriptordata.html">QLowEnergyDescriptorData</a> class is used to create GATT service data.</p>
<p>An object of this class provides a descriptor to be added to a <a href="qlowenergycharacteristicdata.html">QLowEnergyCharacteristicData</a> object via <a href="qlowenergycharacteristicdata.html#addDescriptor">QLowEnergyCharacteristicData::addDescriptor</a>().</p>
<p><b>Note: </b>The member functions related to access permissions are only applicable to those types of descriptors for which the Bluetooth specification does not prescribe if and how their values can be accessed.</p></div>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html">QLowEnergyCharacteristicData</a>, <a href="qlowenergyservicedata.html">QLowEnergyServiceData</a>, and <a href="qlowenergycontroller.html#addService">QLowEnergyController::addService</a>.</p>
<!-- @@@QLowEnergyDescriptorData -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QLowEnergyDescriptorData[overload1]$$$QLowEnergyDescriptorData -->
<h3 class="fn" id="QLowEnergyDescriptorData"><a name="QLowEnergyDescriptorData"></a>QLowEnergyDescriptorData::<span class="name">QLowEnergyDescriptorData</span>()</h3>
<p>Creates a new invalid object of this class.</p>
<!-- @@@QLowEnergyDescriptorData -->
<!-- $$$QLowEnergyDescriptorData$$$QLowEnergyDescriptorDataconstQBluetoothUuid&constQByteArray& -->
<h3 class="fn" id="QLowEnergyDescriptorData-1"><a name="QLowEnergyDescriptorData-1"></a>QLowEnergyDescriptorData::<span class="name">QLowEnergyDescriptorData</span>(const <span class="type"><a href="qbluetoothuuid.html">QBluetoothUuid</a></span> &<i>uuid</i>, const <span class="type">QByteArray</span> &<i>value</i>)</h3>
<p>Creates a new object of this class with UUID and value being provided by <i>uuid</i> and <i>value</i>, respectively.</p>
<!-- @@@QLowEnergyDescriptorData -->
<!-- $$$QLowEnergyDescriptorData$$$QLowEnergyDescriptorDataconstQLowEnergyDescriptorData& -->
<h3 class="fn" id="QLowEnergyDescriptorData-2"><a name="QLowEnergyDescriptorData-2"></a>QLowEnergyDescriptorData::<span class="name">QLowEnergyDescriptorData</span>(const <span class="type"><a href="qlowenergydescriptordata.html#QLowEnergyDescriptorData">QLowEnergyDescriptorData</a></span> &<i>other</i>)</h3>
<p>Constructs a new object of this class that is a copy of <i>other</i>.</p>
<!-- @@@QLowEnergyDescriptorData -->
<!-- $$$~QLowEnergyDescriptorData[overload1]$$$~QLowEnergyDescriptorData -->
<h3 class="fn" id="dtor.QLowEnergyDescriptorData"><a name="dtor.QLowEnergyDescriptorData"></a>QLowEnergyDescriptorData::<span class="name">~QLowEnergyDescriptorData</span>()</h3>
<p>Destroys this object.</p>
<!-- @@@~QLowEnergyDescriptorData -->
<!-- $$$isReadable[overload1]$$$isReadable -->
<h3 class="fn" id="isReadable"><a name="isReadable"></a><span class="type">bool</span> QLowEnergyDescriptorData::<span class="name">isReadable</span>() const</h3>
<p>Returns <code>true</code> if the value of this descriptor is readable and <code>false</code> otherwise.</p>
<!-- @@@isReadable -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn" id="isValid"><a name="isValid"></a><span class="type">bool</span> QLowEnergyDescriptorData::<span class="name">isValid</span>() const</h3>
<p>Returns true if and only if this object has a non-null UUID.</p>
<!-- @@@isValid -->
<!-- $$$isWritable[overload1]$$$isWritable -->
<h3 class="fn" id="isWritable"><a name="isWritable"></a><span class="type">bool</span> QLowEnergyDescriptorData::<span class="name">isWritable</span>() const</h3>
<p>Returns <code>true</code> if the value of this descriptor is writable and <code>false</code> otherwise.</p>
<!-- @@@isWritable -->
<!-- $$$readConstraints[overload1]$$$readConstraints -->
<h3 class="fn" id="readConstraints"><a name="readConstraints"></a><span class="type"><a href="qbluetooth.html#AttAccessConstraint-enum">QBluetooth::AttAccessConstraints</a></span> QLowEnergyDescriptorData::<span class="name">readConstraints</span>() const</h3>
<p>Returns the constraints under which the value of this descriptor can be read. This value is only relevant if <a href="qlowenergydescriptordata.html#isReadable">isReadable</a>() returns <code>true</code>.</p>
<!-- @@@readConstraints -->
<!-- $$$setReadPermissions[overload1]$$$setReadPermissionsboolQBluetooth::AttAccessConstraints -->
<h3 class="fn" id="setReadPermissions"><a name="setReadPermissions"></a><span class="type">void</span> QLowEnergyDescriptorData::<span class="name">setReadPermissions</span>(<span class="type">bool</span> <i>readable</i>, <span class="type"><a href="qbluetooth.html#AttAccessConstraint-enum">QBluetooth::AttAccessConstraints</a></span> <i>constraints</i> = ...)</h3>
<p>Specifies whether the value of this descriptor is <i>readable</i> and if so, under which <i>constraints</i>.</p>
<p><b>See also </b><a href="qlowenergydescriptordata.html#setWritePermissions">setWritePermissions</a>().</p>
<!-- @@@setReadPermissions -->
<!-- $$$setUuid[overload1]$$$setUuidconstQBluetoothUuid& -->
<h3 class="fn" id="setUuid"><a name="setUuid"></a><span class="type">void</span> QLowEnergyDescriptorData::<span class="name">setUuid</span>(const <span class="type"><a href="qbluetoothuuid.html">QBluetoothUuid</a></span> &<i>uuid</i>)</h3>
<p>Sets the UUID of this descriptor to <i>uuid</i>.</p>
<p><b>See also </b><a href="qlowenergydescriptordata.html#uuid">uuid</a>().</p>
<!-- @@@setUuid -->
<!-- $$$setValue[overload1]$$$setValueconstQByteArray& -->
<h3 class="fn" id="setValue"><a name="setValue"></a><span class="type">void</span> QLowEnergyDescriptorData::<span class="name">setValue</span>(const <span class="type">QByteArray</span> &<i>value</i>)</h3>
<p>Sets the value of this descriptor to <i>value</i>. It will be sent to a peer device exactly the way it is provided here, so callers need to take care of things such as endianness.</p>
<p><b>See also </b><a href="qlowenergydescriptordata.html#value">value</a>().</p>
<!-- @@@setValue -->
<!-- $$$setWritePermissions[overload1]$$$setWritePermissionsboolQBluetooth::AttAccessConstraints -->
<h3 class="fn" id="setWritePermissions"><a name="setWritePermissions"></a><span class="type">void</span> QLowEnergyDescriptorData::<span class="name">setWritePermissions</span>(<span class="type">bool</span> <i>writable</i>, <span class="type"><a href="qbluetooth.html#AttAccessConstraint-enum">QBluetooth::AttAccessConstraints</a></span> <i>constraints</i> = ...)</h3>
<p>Specifies whether the value of this descriptor is <i>writable</i> and if so, under which <i>constraints</i>.</p>
<p><b>See also </b><a href="qlowenergydescriptordata.html#setReadPermissions">setReadPermissions</a>().</p>
<!-- @@@setWritePermissions -->
<!-- $$$swap[overload1]$$$swapQLowEnergyDescriptorData& -->
<h3 class="fn" id="swap"><a name="swap"></a><span class="type">void</span> QLowEnergyDescriptorData::<span class="name">swap</span>(<span class="type"><a href="qlowenergydescriptordata.html#QLowEnergyDescriptorData">QLowEnergyDescriptorData</a></span> &<i>other</i>)</h3>
<p>Swaps this object with <i>other</i>.</p>
<!-- @@@swap -->
<!-- $$$uuid[overload1]$$$uuid -->
<h3 class="fn" id="uuid"><a name="uuid"></a><span class="type"><a href="qbluetoothuuid.html">QBluetoothUuid</a></span> QLowEnergyDescriptorData::<span class="name">uuid</span>() const</h3>
<p>Returns the UUID of this descriptor.</p>
<p><b>See also </b><a href="qlowenergydescriptordata.html#setUuid">setUuid</a>().</p>
<!-- @@@uuid -->
<!-- $$$value[overload1]$$$value -->
<h3 class="fn" id="value"><a name="value"></a><span class="type">QByteArray</span> QLowEnergyDescriptorData::<span class="name">value</span>() const</h3>
<p>Returns the value of this descriptor.</p>
<p><b>See also </b><a href="qlowenergydescriptordata.html#setValue">setValue</a>().</p>
<!-- @@@value -->
<!-- $$$writeConstraints[overload1]$$$writeConstraints -->
<h3 class="fn" id="writeConstraints"><a name="writeConstraints"></a><span class="type"><a href="qbluetooth.html#AttAccessConstraint-enum">QBluetooth::AttAccessConstraints</a></span> QLowEnergyDescriptorData::<span class="name">writeConstraints</span>() const</h3>
<p>Returns the constraints under which the value of this descriptor can be written. This value is only relevant if <a href="qlowenergydescriptordata.html#isWritable">isWritable</a>() returns <code>true</code>.</p>
<!-- @@@writeConstraints -->
<!-- $$$operator=[overload1]$$$operator=constQLowEnergyDescriptorData& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qlowenergydescriptordata.html#QLowEnergyDescriptorData">QLowEnergyDescriptorData</a></span> &QLowEnergyDescriptorData::<span class="name">operator=</span>(const <span class="type"><a href="qlowenergydescriptordata.html#QLowEnergyDescriptorData">QLowEnergyDescriptorData</a></span> &<i>other</i>)</h3>
<p>Makes this object a copy of <i>other</i> and returns the new value of this object.</p>
<!-- @@@operator= -->
</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>
