2021-08-05 01:02:30 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2024-12-15 00:45:58 +00:00
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
2021-08-05 01:02:30 +00:00
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" />
2024-12-15 00:45:58 +00:00
< meta http-equiv = "X-UA-Compatible" content = "IE=11" />
< meta name = "generator" content = "Doxygen 1.9.8" />
2021-08-05 01:02:30 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" />
2022-01-15 15:23:57 -07:00
< title > esp-nimble-cpp: NimBLEAdvertisementData Class Reference</ title >
2021-08-05 01:02:30 +00:00
< link href = "tabs.css" rel = "stylesheet" type = "text/css" />
< script type = "text/javascript" src = "jquery.js" ></ script >
< script type = "text/javascript" src = "dynsections.js" ></ script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" />
< script type = "text/javascript" src = "resize.js" ></ script >
< script type = "text/javascript" src = "navtreedata.js" ></ script >
< script type = "text/javascript" src = "navtree.js" ></ script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" />
< script type = "text/javascript" src = "search/searchdata.js" ></ script >
< script type = "text/javascript" src = "search/search.js" ></ script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" />
</ head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
2024-12-15 00:45:58 +00:00
< tr id = "projectrow" >
< td id = "projectalign" >
2025-01-13 02:22:00 +00:00
< div id = "projectname" > esp-nimble-cpp< span id = "projectnumber" >   2.1.0</ span >
2021-08-05 01:02:30 +00:00
</ div >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
<!-- end header part -->
2024-12-15 00:45:58 +00:00
<!-- Generated by Doxygen 1.9.8 -->
2021-08-05 01:02:30 +00:00
< script type = "text/javascript" >
2024-12-15 00:45:58 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox ( "searchBox" , "search/" , '.html' );
2021-08-05 01:02:30 +00:00
/* @license-end */
</ script >
< script type = "text/javascript" src = "menudata.js" ></ script >
< script type = "text/javascript" src = "menu.js" ></ script >
< script type = "text/javascript" >
2024-12-15 00:45:58 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
2021-08-05 01:02:30 +00:00
$ ( function () {
initMenu ( '' , true , false , 'search.php' , 'Search' );
$ ( document ). ready ( function () { init_search (); });
});
2024-12-15 00:45:58 +00:00
/* @license-end */
</ script >
2021-08-05 01:02:30 +00:00
< div id = "main-nav" ></ div >
</ div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" ></ div >
</ div >
</ div >
< div id = "splitbar" style = "-moz-user-select:none;"
class = "ui-resizable-handle" >
</ div >
</ div >
< script type = "text/javascript" >
2024-12-15 00:45:58 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
2021-08-05 01:02:30 +00:00
$ ( document ). ready ( function (){ initNavTree ( 'class_nim_b_l_e_advertisement_data.html' , '' ); initResizable (); });
/* @license-end */
</ script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover = "return searchBox.OnSearchSelectShow()"
onmouseout = "return searchBox.OnSearchSelectHide()"
onkeydown = "return searchBox.OnSearchSelectKey(event)" >
</ div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
2024-12-15 00:45:58 +00:00
< div id = "MSearchResults" >
< div class = "SRPage" >
< div id = "SRIndex" >
< div id = "SRResults" ></ div >
< div class = "SRStatus" id = "Loading" > Loading...</ div >
< div class = "SRStatus" id = "Searching" > Searching...</ div >
< div class = "SRStatus" id = "NoMatches" > No Matches</ div >
</ div >
</ div >
</ div >
2021-08-05 01:02:30 +00:00
</ div >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions</ a > |
< a href = "class_nim_b_l_e_advertisement_data-members.html" > List of all members</ a > </ div >
2024-12-15 00:45:58 +00:00
< div class = "headertitle" >< div class = "title" > NimBLEAdvertisementData Class Reference</ div ></ div >
2021-08-05 01:02:30 +00:00
</ div > <!--header-->
< div class = "contents" >
< p > Advertisement data set by the programmer to be published by the BLE server.
< a href = "class_nim_b_l_e_advertisement_data.html#details" > More...</ a ></ p >
2024-12-15 00:45:58 +00:00
< p >< code > #include < < a class = "el" href = "_nim_b_l_e_advertisement_data_8h_source.html" > NimBLEAdvertisementData.h</ a > > </ code ></ p >
2021-08-05 01:02:30 +00:00
< table class = "memberdecls" >
2024-12-15 00:45:58 +00:00
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a id = "pub-methods" name = "pub-methods" ></ a >
2021-08-05 01:02:30 +00:00
Public Member Functions</ h2 ></ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:a67f4d6869eb2797bc78389adf20cb59e" id = "r_a67f4d6869eb2797bc78389adf20cb59e" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a67f4d6869eb2797bc78389adf20cb59e" > addData</ a > (const uint8_t *data, size_t length)</ td ></ tr >
< tr class = "memdesc:a67f4d6869eb2797bc78389adf20cb59e" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Add data to the payload to be advertised. < br /></ td ></ tr >
< tr class = "separator:a67f4d6869eb2797bc78389adf20cb59e" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a051d8f4ae66d2caa39351af8277bf0ed" id = "r_a051d8f4ae66d2caa39351af8277bf0ed" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a051d8f4ae66d2caa39351af8277bf0ed" > addData</ a > (const std::vector< uint8_t > & data)</ td ></ tr >
< tr class = "memdesc:a051d8f4ae66d2caa39351af8277bf0ed" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Add data to the payload to be advertised. < br /></ td ></ tr >
< tr class = "separator:a051d8f4ae66d2caa39351af8277bf0ed" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a63dca8c3219f682569db26eddbc8880c" id = "r_a63dca8c3219f682569db26eddbc8880c" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a63dca8c3219f682569db26eddbc8880c" > setAppearance</ a > (uint16_t appearance)</ td ></ tr >
< tr class = "memdesc:a63dca8c3219f682569db26eddbc8880c" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the appearance. < br /></ td ></ tr >
< tr class = "separator:a63dca8c3219f682569db26eddbc8880c" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a00c9c605b9a1054ad056fc0f0f7ebf0d" id = "r_a00c9c605b9a1054ad056fc0f0f7ebf0d" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a00c9c605b9a1054ad056fc0f0f7ebf0d" > setFlags</ a > (uint8_t)</ td ></ tr >
< tr class = "memdesc:a00c9c605b9a1054ad056fc0f0f7ebf0d" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the advertisement flags. < br /></ td ></ tr >
< tr class = "separator:a00c9c605b9a1054ad056fc0f0f7ebf0d" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a3f227c597ec00f639e4bd26b80ce404b" id = "r_a3f227c597ec00f639e4bd26b80ce404b" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a3f227c597ec00f639e4bd26b80ce404b" > addTxPower</ a > ()</ td ></ tr >
< tr class = "memdesc:a3f227c597ec00f639e4bd26b80ce404b" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Adds Tx power level to the advertisement data. < br /></ td ></ tr >
< tr class = "separator:a3f227c597ec00f639e4bd26b80ce404b" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:acee3a78f4c8d69a1dc3df1f9af16632f" id = "r_acee3a78f4c8d69a1dc3df1f9af16632f" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#acee3a78f4c8d69a1dc3df1f9af16632f" > setPreferredParams</ a > (uint16_t minInterval, uint16_t maxInterval)</ td ></ tr >
< tr class = "memdesc:acee3a78f4c8d69a1dc3df1f9af16632f" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the preferred min and max connection intervals to advertise. < br /></ td ></ tr >
< tr class = "separator:acee3a78f4c8d69a1dc3df1f9af16632f" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:acbea9f95711b329a427919ecd9cbeb23" id = "r_acbea9f95711b329a427919ecd9cbeb23" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#acbea9f95711b329a427919ecd9cbeb23" > addServiceUUID</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & serviceUUID)</ td ></ tr >
< tr class = "memdesc:acbea9f95711b329a427919ecd9cbeb23" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Add a service uuid to exposed list of services. < br /></ td ></ tr >
< tr class = "separator:acbea9f95711b329a427919ecd9cbeb23" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a4119cfc1dafeee9c32f9a08dbb213139" id = "r_a4119cfc1dafeee9c32f9a08dbb213139" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a4119cfc1dafeee9c32f9a08dbb213139" > addServiceUUID</ a > (const char *serviceUUID)</ td ></ tr >
< tr class = "memdesc:a4119cfc1dafeee9c32f9a08dbb213139" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Add a service uuid to exposed list of services. < br /></ td ></ tr >
< tr class = "separator:a4119cfc1dafeee9c32f9a08dbb213139" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ad22fa3253134dd5bfd3e76f8c31bef2e" id = "r_ad22fa3253134dd5bfd3e76f8c31bef2e" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#ad22fa3253134dd5bfd3e76f8c31bef2e" > removeServiceUUID</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & serviceUUID)</ td ></ tr >
< tr class = "memdesc:ad22fa3253134dd5bfd3e76f8c31bef2e" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Remove a service UUID from the advertisement. < br /></ td ></ tr >
< tr class = "separator:ad22fa3253134dd5bfd3e76f8c31bef2e" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a62963648edf361ed7d3f24027dd41a9d" id = "r_a62963648edf361ed7d3f24027dd41a9d" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a62963648edf361ed7d3f24027dd41a9d" > removeServiceUUID</ a > (const char *serviceUUID)</ td ></ tr >
< tr class = "memdesc:a62963648edf361ed7d3f24027dd41a9d" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Remove a service UUID from the advertisement. < br /></ td ></ tr >
< tr class = "separator:a62963648edf361ed7d3f24027dd41a9d" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aff30e0d0dc95e1dc8bb1cb6858a4e813" id = "r_aff30e0d0dc95e1dc8bb1cb6858a4e813" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "aff30e0d0dc95e1dc8bb1cb6858a4e813" name = "aff30e0d0dc95e1dc8bb1cb6858a4e813" ></ a >
bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > removeServices</ b > ()</ td ></ tr >
< tr class = "memdesc:aff30e0d0dc95e1dc8bb1cb6858a4e813" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Remove all service UUIDs from the advertisement. < br /></ td ></ tr >
< tr class = "separator:aff30e0d0dc95e1dc8bb1cb6858a4e813" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a0b076298058755149b4351727d70b198" id = "r_a0b076298058755149b4351727d70b198" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a0b076298058755149b4351727d70b198" > setManufacturerData</ a > (const uint8_t *data, size_t length)</ td ></ tr >
< tr class = "memdesc:a0b076298058755149b4351727d70b198" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set manufacturer specific data. < br /></ td ></ tr >
< tr class = "separator:a0b076298058755149b4351727d70b198" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a043d49566c5d7a3e0808554587ad051b" id = "r_a043d49566c5d7a3e0808554587ad051b" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a043d49566c5d7a3e0808554587ad051b" > setManufacturerData</ a > (const std::string & data)</ td ></ tr >
< tr class = "memdesc:a043d49566c5d7a3e0808554587ad051b" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set manufacturer specific data. < br /></ td ></ tr >
< tr class = "separator:a043d49566c5d7a3e0808554587ad051b" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a9eb01ecb3973fa592effe6fdce39f602" id = "r_a9eb01ecb3973fa592effe6fdce39f602" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a9eb01ecb3973fa592effe6fdce39f602" > setManufacturerData</ a > (const std::vector< uint8_t > & data)</ td ></ tr >
< tr class = "memdesc:a9eb01ecb3973fa592effe6fdce39f602" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set manufacturer specific data. < br /></ td ></ tr >
< tr class = "separator:a9eb01ecb3973fa592effe6fdce39f602" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a852969e05a7884faf6cfcd2001f80ec9" id = "r_a852969e05a7884faf6cfcd2001f80ec9" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a852969e05a7884faf6cfcd2001f80ec9" > setURI</ a > (const std::string & uri)</ td ></ tr >
< tr class = "memdesc:a852969e05a7884faf6cfcd2001f80ec9" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the URI to advertise. < br /></ td ></ tr >
< tr class = "separator:a852969e05a7884faf6cfcd2001f80ec9" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:adf8f35c7735f8a29130482b302f04006" id = "r_adf8f35c7735f8a29130482b302f04006" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#adf8f35c7735f8a29130482b302f04006" > setName</ a > (const std::string & name, bool isComplete=true)</ td ></ tr >
< tr class = "memdesc:adf8f35c7735f8a29130482b302f04006" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the complete name of this device. < br /></ td ></ tr >
< tr class = "separator:adf8f35c7735f8a29130482b302f04006" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a32922b53631443b92463c8942b8d0839" id = "r_a32922b53631443b92463c8942b8d0839" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a32922b53631443b92463c8942b8d0839" > setShortName</ a > (const std::string & name)</ td ></ tr >
< tr class = "memdesc:a32922b53631443b92463c8942b8d0839" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the short name. < br /></ td ></ tr >
< tr class = "separator:a32922b53631443b92463c8942b8d0839" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aafa437cd95751da68d6b8691ce3eea46" id = "r_aafa437cd95751da68d6b8691ce3eea46" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#aafa437cd95751da68d6b8691ce3eea46" > setCompleteServices</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid)</ td ></ tr >
< tr class = "memdesc:aafa437cd95751da68d6b8691ce3eea46" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set a single service to advertise as a complete list of services. < br /></ td ></ tr >
< tr class = "separator:aafa437cd95751da68d6b8691ce3eea46" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a89c45ddb804600bd6b6175687f6c1bb0" id = "r_a89c45ddb804600bd6b6175687f6c1bb0" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a89c45ddb804600bd6b6175687f6c1bb0" > setCompleteServices16</ a > (const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > & uuids)</ td ></ tr >
< tr class = "memdesc:a89c45ddb804600bd6b6175687f6c1bb0" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the complete list of 16 bit services to advertise. < br /></ td ></ tr >
< tr class = "separator:a89c45ddb804600bd6b6175687f6c1bb0" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aef5e7a5b2d3dd9c09b6a55582d7d22d6" id = "r_aef5e7a5b2d3dd9c09b6a55582d7d22d6" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#aef5e7a5b2d3dd9c09b6a55582d7d22d6" > setCompleteServices32</ a > (const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > & uuids)</ td ></ tr >
< tr class = "memdesc:aef5e7a5b2d3dd9c09b6a55582d7d22d6" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the complete list of 32 bit services to advertise. < br /></ td ></ tr >
< tr class = "separator:aef5e7a5b2d3dd9c09b6a55582d7d22d6" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a0a4102da7495d39e8a0033e1661b76a6" id = "r_a0a4102da7495d39e8a0033e1661b76a6" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a0a4102da7495d39e8a0033e1661b76a6" > setPartialServices</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid)</ td ></ tr >
< tr class = "memdesc:a0a4102da7495d39e8a0033e1661b76a6" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set a single service to advertise as a partial list of services. < br /></ td ></ tr >
< tr class = "separator:a0a4102da7495d39e8a0033e1661b76a6" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a91671d595cfed4547df670884633a7a4" id = "r_a91671d595cfed4547df670884633a7a4" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a91671d595cfed4547df670884633a7a4" > setPartialServices16</ a > (const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > & uuids)</ td ></ tr >
< tr class = "memdesc:a91671d595cfed4547df670884633a7a4" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the partial list of services to advertise. < br /></ td ></ tr >
< tr class = "separator:a91671d595cfed4547df670884633a7a4" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a736480e1e778ed93890d2071f558f186" id = "r_a736480e1e778ed93890d2071f558f186" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a736480e1e778ed93890d2071f558f186" > setPartialServices32</ a > (const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > & uuids)</ td ></ tr >
< tr class = "memdesc:a736480e1e778ed93890d2071f558f186" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the partial list of services to advertise. < br /></ td ></ tr >
< tr class = "separator:a736480e1e778ed93890d2071f558f186" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a0399149f6359d33ca4781c8282844394" id = "r_a0399149f6359d33ca4781c8282844394" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a0399149f6359d33ca4781c8282844394" > setServiceData</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid, const uint8_t *data, size_t length)</ td ></ tr >
< tr class = "memdesc:a0399149f6359d33ca4781c8282844394" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the service data advertised for the UUID. < br /></ td ></ tr >
< tr class = "separator:a0399149f6359d33ca4781c8282844394" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ae179e55a5a133a66858047b29343bd75" id = "r_ae179e55a5a133a66858047b29343bd75" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#ae179e55a5a133a66858047b29343bd75" > setServiceData</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid, const std::string & data)</ td ></ tr >
< tr class = "memdesc:ae179e55a5a133a66858047b29343bd75" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the service data (UUID + data) < br /></ td ></ tr >
< tr class = "separator:ae179e55a5a133a66858047b29343bd75" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a2efe483f50ee2013d1eea015c90ba4f5" id = "r_a2efe483f50ee2013d1eea015c90ba4f5" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a2efe483f50ee2013d1eea015c90ba4f5" > setServiceData</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid, const std::vector< uint8_t > & data)</ td ></ tr >
< tr class = "memdesc:a2efe483f50ee2013d1eea015c90ba4f5" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the service data advertised for the UUID. < br /></ td ></ tr >
< tr class = "separator:a2efe483f50ee2013d1eea015c90ba4f5" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:acf839da2c36a9ac5ef53e86b57d73874" id = "r_acf839da2c36a9ac5ef53e86b57d73874" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#acf839da2c36a9ac5ef53e86b57d73874" > removeData</ a > (uint8_t type)</ td ></ tr >
< tr class = "memdesc:acf839da2c36a9ac5ef53e86b57d73874" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Remove data from the advertisement data. < br /></ td ></ tr >
< tr class = "separator:acf839da2c36a9ac5ef53e86b57d73874" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ac0f2238cf17bf3e8bbef8b0ef0d61dcf" id = "r_ac0f2238cf17bf3e8bbef8b0ef0d61dcf" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "ac0f2238cf17bf3e8bbef8b0ef0d61dcf" name = "ac0f2238cf17bf3e8bbef8b0ef0d61dcf" ></ a >
void  </ td >< td class = "memItemRight" valign = "bottom" >< b > clearData</ b > ()</ td ></ tr >
< tr class = "memdesc:ac0f2238cf17bf3e8bbef8b0ef0d61dcf" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Clear the advertisement data for reuse. < br /></ td ></ tr >
< tr class = "separator:ac0f2238cf17bf3e8bbef8b0ef0d61dcf" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a57d4ece891cc23b2079ccc4e06d477b2" id = "r_a57d4ece891cc23b2079ccc4e06d477b2" >< td class = "memItemLeft" align = "right" valign = "top" > int  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a57d4ece891cc23b2079ccc4e06d477b2" > getDataLocation</ a > (uint8_t type) const</ td ></ tr >
< tr class = "memdesc:a57d4ece891cc23b2079ccc4e06d477b2" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get the location of the data in the payload. < br /></ td ></ tr >
< tr class = "separator:a57d4ece891cc23b2079ccc4e06d477b2" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a6ff7fc36a9f5966792f354d2586714a6" id = "r_a6ff7fc36a9f5966792f354d2586714a6" >< td class = "memItemLeft" align = "right" valign = "top" > std::string  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a6ff7fc36a9f5966792f354d2586714a6" > toString</ a > () const</ td ></ tr >
< tr class = "memdesc:a6ff7fc36a9f5966792f354d2586714a6" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get the string representation of the advertisement data. < br /></ td ></ tr >
< tr class = "separator:a6ff7fc36a9f5966792f354d2586714a6" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a2f6960683e8b98d1c3ecf88bb5ec56eb" id = "r_a2f6960683e8b98d1c3ecf88bb5ec56eb" >< td class = "memItemLeft" align = "right" valign = "top" > std::vector< uint8_t >  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a2f6960683e8b98d1c3ecf88bb5ec56eb" > getPayload</ a > () const</ td ></ tr >
< tr class = "memdesc:a2f6960683e8b98d1c3ecf88bb5ec56eb" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Retrieve the payload that is to be advertised. < br /></ td ></ tr >
< tr class = "separator:a2f6960683e8b98d1c3ecf88bb5ec56eb" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
< a name = "details" id = "details" ></ a >< h2 class = "groupheader" > Detailed Description</ h2 >
< div class = "textblock" >< p > Advertisement data set by the programmer to be published by the BLE server. </ p >
</ div >< h2 class = "groupheader" > Member Function Documentation</ h2 >
2024-12-15 00:45:58 +00:00
< a id = "a051d8f4ae66d2caa39351af8277bf0ed" name = "a051d8f4ae66d2caa39351af8277bf0ed" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a051d8f4ae66d2caa39351af8277bf0ed" > ◆  </ a ></ span > addData() < span class = "overload" > [1/2]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::addData </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
2024-12-15 00:45:58 +00:00
< td class = "paramtype" > const std::vector< uint8_t > &  </ td >
< td class = "paramname" >< em > data</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Add data to the payload to be advertised. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > data</ td >< td > The data to be added to the payload. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "a67f4d6869eb2797bc78389adf20cb59e" name = "a67f4d6869eb2797bc78389adf20cb59e" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a67f4d6869eb2797bc78389adf20cb59e" > ◆  </ a ></ span > addData() < span class = "overload" > [2/2]</ span ></ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEAdvertisementData::addData </ td >
< td > (</ td >
< td class = "paramtype" > const uint8_t *  </ td >
2021-08-05 01:02:30 +00:00
< td class = "paramname" >< em > data</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > size_t  </ td >
< td class = "paramname" >< em > length</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Add data to the payload to be advertised. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > data</ td >< td > The data to be added to the payload. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > length</ td >< td > The size of data to be added to the payload. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a4119cfc1dafeee9c32f9a08dbb213139" name = "a4119cfc1dafeee9c32f9a08dbb213139" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a4119cfc1dafeee9c32f9a08dbb213139" > ◆  </ a ></ span > addServiceUUID() < span class = "overload" > [1/2]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::addServiceUUID </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
2024-12-15 00:45:58 +00:00
< td class = "paramtype" > const char *  </ td >
< td class = "paramname" >< em > serviceUUID</ em ></ td >< td > )</ td >
2021-08-05 01:02:30 +00:00
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
2024-12-15 00:45:58 +00:00
< p > Add a service uuid to exposed list of services. </ p >
2021-08-05 01:02:30 +00:00
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > serviceUUID</ td >< td > The string representation of the service to expose. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
</ div >
</ div >
< a id = "acbea9f95711b329a427919ecd9cbeb23" name = "acbea9f95711b329a427919ecd9cbeb23" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#acbea9f95711b329a427919ecd9cbeb23" > ◆  </ a ></ span > addServiceUUID() < span class = "overload" > [2/2]</ span ></ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEAdvertisementData::addServiceUUID </ td >
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > &  </ td >
< td class = "paramname" >< em > serviceUUID</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Add a service uuid to exposed list of services. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > serviceUUID</ td >< td > The UUID of the service to expose. </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a3f227c597ec00f639e4bd26b80ce404b" name = "a3f227c597ec00f639e4bd26b80ce404b" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a3f227c597ec00f639e4bd26b80ce404b" > ◆  </ a ></ span > addTxPower()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::addTxPower </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
2024-12-15 00:45:58 +00:00
< p > Adds Tx power level to the advertisement data. </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a57d4ece891cc23b2079ccc4e06d477b2" name = "a57d4ece891cc23b2079ccc4e06d477b2" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a57d4ece891cc23b2079ccc4e06d477b2" > ◆  </ a ></ span > getDataLocation()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > int NimBLEAdvertisementData::getDataLocation </ td >
< td > (</ td >
< td class = "paramtype" > uint8_t  </ td >
< td class = "paramname" >< em > type</ em ></ td >< td > )</ td >
< td > const</ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Get the location of the data in the payload. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > type</ td >< td > The type of data to search for. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > -1 if the data is not found, otherwise the index of the data in the payload. </ dd ></ dl >
</ div >
</ div >
< a id = "a2f6960683e8b98d1c3ecf88bb5ec56eb" name = "a2f6960683e8b98d1c3ecf88bb5ec56eb" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a2f6960683e8b98d1c3ecf88bb5ec56eb" > ◆  </ a ></ span > getPayload()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::vector< uint8_t > NimBLEAdvertisementData::getPayload </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
< td > const</ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Retrieve the payload that is to be advertised. </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > The payload of the advertisement data. </ dd ></ dl >
</ div >
</ div >
< a id = "acf839da2c36a9ac5ef53e86b57d73874" name = "acf839da2c36a9ac5ef53e86b57d73874" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#acf839da2c36a9ac5ef53e86b57d73874" > ◆  </ a ></ span > removeData()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEAdvertisementData::removeData </ td >
< td > (</ td >
< td class = "paramtype" > uint8_t  </ td >
< td class = "paramname" >< em > type</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Remove data from the advertisement data. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > type</ td >< td > The type of data to remove. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful, false if the data was not found. </ dd ></ dl >
</ div >
</ div >
< a id = "a62963648edf361ed7d3f24027dd41a9d" name = "a62963648edf361ed7d3f24027dd41a9d" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a62963648edf361ed7d3f24027dd41a9d" > ◆  </ a ></ span > removeServiceUUID() < span class = "overload" > [1/2]</ span ></ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEAdvertisementData::removeServiceUUID </ td >
< td > (</ td >
< td class = "paramtype" > const char *  </ td >
< td class = "paramname" >< em > serviceUUID</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Remove a service UUID from the advertisement. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > serviceUUID</ td >< td > The UUID of the service to remove. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful or uuid not found, false if uuid error or data could not be reset. </ dd ></ dl >
</ div >
</ div >
< a id = "ad22fa3253134dd5bfd3e76f8c31bef2e" name = "ad22fa3253134dd5bfd3e76f8c31bef2e" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ad22fa3253134dd5bfd3e76f8c31bef2e" > ◆  </ a ></ span > removeServiceUUID() < span class = "overload" > [2/2]</ span ></ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEAdvertisementData::removeServiceUUID </ td >
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > &  </ td >
< td class = "paramname" >< em > serviceUUID</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Remove a service UUID from the advertisement. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > serviceUUID</ td >< td > The UUID of the service to remove. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful or uuid not found, false if uuid error or data could not be reset. </ dd ></ dl >
</ div >
</ div >
< a id = "a63dca8c3219f682569db26eddbc8880c" name = "a63dca8c3219f682569db26eddbc8880c" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a63dca8c3219f682569db26eddbc8880c" > ◆  </ a ></ span > setAppearance()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEAdvertisementData::setAppearance </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > uint16_t  </ td >
< td class = "paramname" >< em > appearance</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the appearance. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > appearance</ td >< td > The appearance code value. </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful.</ dd ></ dl >
< p > If the appearance value is 0 then it will be removed from the advertisement if set previously. </ p >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "aafa437cd95751da68d6b8691ce3eea46" name = "aafa437cd95751da68d6b8691ce3eea46" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aafa437cd95751da68d6b8691ce3eea46" > ◆  </ a ></ span > setCompleteServices()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setCompleteServices </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > &  </ td >
< td class = "paramname" >< em > uuid</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set a single service to advertise as a complete list of services. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uuid</ td >< td > The service to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a89c45ddb804600bd6b6175687f6c1bb0" name = "a89c45ddb804600bd6b6175687f6c1bb0" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a89c45ddb804600bd6b6175687f6c1bb0" > ◆  </ a ></ span > setCompleteServices16()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setCompleteServices16 </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > &  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > uuids</ em ></ td >< td > )</ td >
2021-08-05 01:02:30 +00:00
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the complete list of 16 bit services to advertise. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uuids</ td >< td > A vector of 16 bit UUID's to advertise. </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "aef5e7a5b2d3dd9c09b6a55582d7d22d6" name = "aef5e7a5b2d3dd9c09b6a55582d7d22d6" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aef5e7a5b2d3dd9c09b6a55582d7d22d6" > ◆  </ a ></ span > setCompleteServices32()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setCompleteServices32 </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > &  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > uuids</ em ></ td >< td > )</ td >
2021-08-05 01:02:30 +00:00
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the complete list of 32 bit services to advertise. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uuids</ td >< td > A vector of 32 bit UUID's to advertise. </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a00c9c605b9a1054ad056fc0f0f7ebf0d" name = "a00c9c605b9a1054ad056fc0f0f7ebf0d" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a00c9c605b9a1054ad056fc0f0f7ebf0d" > ◆  </ a ></ span > setFlags()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setFlags </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > uint8_t  </ td >
< td class = "paramname" >< em > flag</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the advertisement flags. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > flag</ td >< td > The flags to be set in the advertisement.< ul >
< li > BLE_HS_ADV_F_DISC_LTD</ li >
< li > BLE_HS_ADV_F_DISC_GEN</ li >
2024-12-15 00:45:58 +00:00
< li > BLE_HS_ADV_F_BREDR_UNSUP - must always use with NimBLE A flag value of 0 will remove the flags from the advertisement. </ li >
2021-08-05 01:02:30 +00:00
</ ul >
</ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a043d49566c5d7a3e0808554587ad051b" name = "a043d49566c5d7a3e0808554587ad051b" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a043d49566c5d7a3e0808554587ad051b" > ◆  </ a ></ span > setManufacturerData() < span class = "overload" > [1/3]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setManufacturerData </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > data</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set manufacturer specific data. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > data</ td >< td > The manufacturer data to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a9eb01ecb3973fa592effe6fdce39f602" name = "a9eb01ecb3973fa592effe6fdce39f602" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a9eb01ecb3973fa592effe6fdce39f602" > ◆  </ a ></ span > setManufacturerData() < span class = "overload" > [2/3]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setManufacturerData </ td >
< td > (</ td >
< td class = "paramtype" > const std::vector< uint8_t > &  </ td >
< td class = "paramname" >< em > data</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set manufacturer specific data. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > data</ td >< td > The manufacturer data to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
</ div >
</ div >
< a id = "a0b076298058755149b4351727d70b198" name = "a0b076298058755149b4351727d70b198" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a0b076298058755149b4351727d70b198" > ◆  </ a ></ span > setManufacturerData() < span class = "overload" > [3/3]</ span ></ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEAdvertisementData::setManufacturerData </ td >
< td > (</ td >
< td class = "paramtype" > const uint8_t *  </ td >
< td class = "paramname" >< em > data</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > size_t  </ td >
< td class = "paramname" >< em > length</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set manufacturer specific data. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > data</ td >< td > The manufacturer data to advertise. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > length</ td >< td > The length of the data. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
</ div >
</ div >
< a id = "adf8f35c7735f8a29130482b302f04006" name = "adf8f35c7735f8a29130482b302f04006" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#adf8f35c7735f8a29130482b302f04006" > ◆  </ a ></ span > setName()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEAdvertisementData::setName </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > const std::string &  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > name</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
2021-08-05 01:02:30 +00:00
< td ></ td >
2024-12-15 00:45:58 +00:00
< td class = "paramtype" > bool  </ td >
< td class = "paramname" >< em > isComplete</ em > = < code > true</ code >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
2021-08-05 01:02:30 +00:00
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the complete name of this device. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > name</ td >< td > The name to advertise. </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > isComplete</ td >< td > If true the name is complete, which will set the data type accordingly.</ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< p > If the name is longer than 29 characters it will be truncated. and the data type will be set to incomplete name. </ p >< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a0a4102da7495d39e8a0033e1661b76a6" name = "a0a4102da7495d39e8a0033e1661b76a6" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a0a4102da7495d39e8a0033e1661b76a6" > ◆  </ a ></ span > setPartialServices()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setPartialServices </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > &  </ td >
< td class = "paramname" >< em > uuid</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set a single service to advertise as a partial list of services. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uuid</ td >< td > The service to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a91671d595cfed4547df670884633a7a4" name = "a91671d595cfed4547df670884633a7a4" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a91671d595cfed4547df670884633a7a4" > ◆  </ a ></ span > setPartialServices16()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setPartialServices16 </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > &  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > uuids</ em ></ td >< td > )</ td >
2021-08-05 01:02:30 +00:00
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the partial list of services to advertise. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uuids</ td >< td > A vector of 16 bit UUID's to advertise. </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a736480e1e778ed93890d2071f558f186" name = "a736480e1e778ed93890d2071f558f186" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a736480e1e778ed93890d2071f558f186" > ◆  </ a ></ span > setPartialServices32()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setPartialServices32 </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > &  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > uuids</ em ></ td >< td > )</ td >
2021-08-05 01:02:30 +00:00
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the partial list of services to advertise. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uuids</ td >< td > A vector of 32 bit UUID's to advertise. </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "acee3a78f4c8d69a1dc3df1f9af16632f" name = "acee3a78f4c8d69a1dc3df1f9af16632f" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#acee3a78f4c8d69a1dc3df1f9af16632f" > ◆  </ a ></ span > setPreferredParams()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setPreferredParams </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > uint16_t  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > minInterval</ em > , </ td >
2021-08-05 01:02:30 +00:00
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > uint16_t  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > maxInterval</ em >   </ td >
2021-08-05 01:02:30 +00:00
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
2024-12-15 00:45:58 +00:00
< p > Set the preferred min and max connection intervals to advertise. </ p >
2021-08-05 01:02:30 +00:00
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > minInterval</ td >< td > The minimum preferred connection interval. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > maxInterval</ td >< td > The Maximum preferred connection interval.</ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< p > Range = 0x0006(7.5ms) to 0x0C80(4000ms), values not within the range will be limited to this range. </ p >< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "ae179e55a5a133a66858047b29343bd75" name = "ae179e55a5a133a66858047b29343bd75" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ae179e55a5a133a66858047b29343bd75" > ◆  </ a ></ span > setServiceData() < span class = "overload" > [1/3]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setServiceData </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > &  </ td >
< td class = "paramname" >< em > uuid</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > data</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the service data (UUID + data) </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uuid</ td >< td > The UUID to set with the service data. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > data</ td >< td > The data to be associated with the service data advertised. </ td ></ tr >
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if the service data was set successfully. </ dd ></ dl >
< dl class = "section note" >< dt > Note</ dt >< dd > If data length is 0 the service data will not be advertised. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a2efe483f50ee2013d1eea015c90ba4f5" name = "a2efe483f50ee2013d1eea015c90ba4f5" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a2efe483f50ee2013d1eea015c90ba4f5" > ◆  </ a ></ span > setServiceData() < span class = "overload" > [2/3]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setServiceData </ td >
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > &  </ td >
< td class = "paramname" >< em > uuid</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > const std::vector< uint8_t > &  </ td >
< td class = "paramname" >< em > data</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the service data advertised for the UUID. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uuid</ td >< td > The UUID the service data belongs to. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > data</ td >< td > The data to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if the service data was set successfully. </ dd ></ dl >
< dl class = "section note" >< dt > Note</ dt >< dd > If data length is 0 the service data will not be advertised. </ dd ></ dl >
</ div >
</ div >
< a id = "a0399149f6359d33ca4781c8282844394" name = "a0399149f6359d33ca4781c8282844394" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a0399149f6359d33ca4781c8282844394" > ◆  </ a ></ span > setServiceData() < span class = "overload" > [3/3]</ span ></ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEAdvertisementData::setServiceData </ td >
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > &  </ td >
< td class = "paramname" >< em > uuid</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > const uint8_t *  </ td >
< td class = "paramname" >< em > data</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > size_t  </ td >
< td class = "paramname" >< em > length</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the service data advertised for the UUID. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uuid</ td >< td > The UUID the service data belongs to. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > data</ td >< td > The data to advertise. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > length</ td >< td > The length of the data. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section note" >< dt > Note</ dt >< dd > If data length is 0 the service data will not be advertised. </ dd ></ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful, false if data length is too long or could not be set. </ dd ></ dl >
</ div >
</ div >
< a id = "a32922b53631443b92463c8942b8d0839" name = "a32922b53631443b92463c8942b8d0839" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a32922b53631443b92463c8942b8d0839" > ◆  </ a ></ span > setShortName()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEAdvertisementData::setShortName </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > name</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the short name. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > name</ td >< td > The short name of the device. </ td ></ tr >
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a852969e05a7884faf6cfcd2001f80ec9" name = "a852969e05a7884faf6cfcd2001f80ec9" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a852969e05a7884faf6cfcd2001f80ec9" > ◆  </ a ></ span > setURI()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEAdvertisementData::setURI </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > uri</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the URI to advertise. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uri</ td >< td > The uri to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if successful. </ dd ></ dl >
</ div >
</ div >
< a id = "a6ff7fc36a9f5966792f354d2586714a6" name = "a6ff7fc36a9f5966792f354d2586714a6" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a6ff7fc36a9f5966792f354d2586714a6" > ◆  </ a ></ span > toString()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::string NimBLEAdvertisementData::toString </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
< td > const</ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Get the string representation of the advertisement data. </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > The string representation of the advertisement data. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
</ div > <!-- contents -->
</ div > <!-- doc-content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "navelem" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html" > NimBLEAdvertisementData</ a ></ li >
2024-12-15 00:45:58 +00:00
< li class = "footer" > Generated by < a href = "https://www.doxygen.org/index.html" >< img class = "footer" src = "doxygen.svg" width = "104" height = "31" alt = "doxygen" /></ a > 1.9.8 </ li >
2021-08-05 01:02:30 +00:00
</ ul >
</ div >
</ body >
</ html >