sysadmin/ct-dtv-hx0100-002kwos
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ea812e34a1ee7080bbc977b95b522249844aeb6b
ct-dtv-hx0100-002kwos/procentric/application/referece/hcap_js_extension-1.24.6.5901/doc/symbols/hcap.beacon.html
sysadmin ff2a3c305b issue #1 
Add 1st PTC Hotel APP codes
2022-04-21 10:46:16 +09:00

1122 lines
37 KiB
HTML
Executable File
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>hcap.beacon | JsDoc Reference</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
<meta name="mobileoptimized" content="0" />
<link rel="stylesheet" href="../css/all.css" media="all" />
<link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)" />
<link rel="stylesheet" href="../css/handheld.css" media="handheld" />
<link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)" />
<link rel="stylesheet" href="../javascript/highlighter/dessert.css" />
<script src="../javascript/all.js"></script>
<!--[if lt IE 9]>
<script src="../javascript/html5.js"></script>
<![endif]-->
</head>
<body>
<div class="index">
<div class="menu">
<div class="indexLinks">
<a href="../index.html">Classes</a>
<a href="../files.html">Files</a>
</div>
<table width=100% class=confidential><tr><td><b>LGE Confidential</b></td></tr></table>
<h2 class="heading1">Library</h2>
<table>
<tr>
<td align=left class=confidential><a href="../../js/hcap.js">&middot;hcap.js (1.24.6.5901)</li></a></td>
</tr>
</table>
<h2 class="heading1">Classes</h2>
<input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
<nav>
<ul class="classList" id="ClassList">
<li><a href="../symbols/_global_.html">_global_</a></li>
<li><a href="../symbols/hcap.html">hcap</a></li>
<li><a href="../symbols/hcap.application.html">hcap<span class='break'> </span>.<span class='break'> </span>application</a></li>
<li><a href="../symbols/hcap.beacon.html">hcap<span class='break'> </span>.<span class='break'> </span>beacon</a></li>
<li><a href="../symbols/hcap.bluetooth.html">hcap<span class='break'> </span>.<span class='break'> </span>bluetooth</a></li>
<li><a href="../symbols/hcap.bluetooth.audio.html">hcap<span class='break'> </span>.<span class='break'> </span>bluetooth<span class='break'> </span>.<span class='break'> </span>audio</a></li>
<li><a href="../symbols/hcap.camera.html">hcap<span class='break'> </span>.<span class='break'> </span>camera</a></li>
<li><a href="../symbols/hcap.carousel.html">hcap<span class='break'> </span>.<span class='break'> </span>carousel</a></li>
<li><a href="../symbols/hcap.channel.html">hcap<span class='break'> </span>.<span class='break'> </span>channel</a></li>
<li><a href="../symbols/hcap.channel.AudioStreamType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>AudioStreamType</a></li>
<li><a href="../symbols/hcap.channel.ChannelStatus.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>ChannelStatus</a></li>
<li><a href="../symbols/hcap.channel.ChannelType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>ChannelType</a></li>
<li><a href="../symbols/hcap.channel.InbandDataServiceType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>InbandDataServiceType</a></li>
<li><a href="../symbols/hcap.channel.IpBroadcastType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>IpBroadcastType</a></li>
<li><a href="../symbols/hcap.channel.Polarization.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>Polarization</a></li>
<li><a href="../symbols/hcap.channel.RfBroadcastType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>RfBroadcastType</a></li>
<li><a href="../symbols/hcap.channel.VideoStreamType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>VideoStreamType</a></li>
<li><a href="../symbols/hcap.checkout.html">hcap<span class='break'> </span>.<span class='break'> </span>checkout</a></li>
<li><a href="../symbols/hcap.externalinput.html">hcap<span class='break'> </span>.<span class='break'> </span>externalinput</a></li>
<li><a href="../symbols/hcap.externalinput.ExternalInputType.html">hcap<span class='break'> </span>.<span class='break'> </span>externalinput<span class='break'> </span>.<span class='break'> </span>ExternalInputType</a></li>
<li><a href="../symbols/hcap.file.html">hcap<span class='break'> </span>.<span class='break'> </span>file</a></li>
<li><a href="../symbols/hcap.iot.html">hcap<span class='break'> </span>.<span class='break'> </span>iot</a></li>
<li><a href="../symbols/hcap.key.html">hcap<span class='break'> </span>.<span class='break'> </span>key</a></li>
<li><a href="../symbols/hcap.key.Code.html">hcap<span class='break'> </span>.<span class='break'> </span>key<span class='break'> </span>.<span class='break'> </span>Code</a></li>
<li><a href="../symbols/hcap.Media.html">hcap<span class='break'> </span>.<span class='break'> </span>Media</a></li>
<li><a href="../symbols/hcap.Media.SubtitleType.html">hcap<span class='break'> </span>.<span class='break'> </span>Media<span class='break'> </span>.<span class='break'> </span>SubtitleType</a></li>
<li><a href="../symbols/hcap.mode.html">hcap<span class='break'> </span>.<span class='break'> </span>mode</a></li>
<li><a href="../symbols/hcap.mouse.html">hcap<span class='break'> </span>.<span class='break'> </span>mouse</a></li>
<li><a href="../symbols/hcap.mpi.html">hcap<span class='break'> </span>.<span class='break'> </span>mpi</a></li>
<li><a href="../symbols/hcap.network.html">hcap<span class='break'> </span>.<span class='break'> </span>network</a></li>
<li><a href="../symbols/hcap.network.DhcpState.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>DhcpState</a></li>
<li><a href="../symbols/hcap.network.NetworkEventType.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>NetworkEventType</a></li>
<li><a href="../symbols/hcap.network.NetworkMode.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>NetworkMode</a></li>
<li><a href="../symbols/hcap.network.WifiSecurityType.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>WifiSecurityType</a></li>
<li><a href="../symbols/hcap.network.WirelessMode.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>WirelessMode</a></li>
<li><a href="../symbols/hcap.power.html">hcap<span class='break'> </span>.<span class='break'> </span>power</a></li>
<li><a href="../symbols/hcap.power.PowerMode.html">hcap<span class='break'> </span>.<span class='break'> </span>power<span class='break'> </span>.<span class='break'> </span>PowerMode</a></li>
<li><a href="../symbols/hcap.preloadedApplication.html">hcap<span class='break'> </span>.<span class='break'> </span>preloadedApplication</a></li>
<li><a href="../symbols/hcap.property.html">hcap<span class='break'> </span>.<span class='break'> </span>property</a></li>
<li><a href="../symbols/hcap.property.InstallerMenuItem.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>InstallerMenuItem</a></li>
<li><a href="../symbols/hcap.property.PictureMode.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>PictureMode</a></li>
<li><a href="../symbols/hcap.property.PicturePropertyKey.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>PicturePropertyKey</a></li>
<li><a href="../symbols/hcap.rms.html">hcap<span class='break'> </span>.<span class='break'> </span>rms</a></li>
<li><a href="../symbols/hcap.rs232c.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c</a></li>
<li><a href="../symbols/hcap.rs232c.BaudRate.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>BaudRate</a></li>
<li><a href="../symbols/hcap.rs232c.DataBit.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>DataBit</a></li>
<li><a href="../symbols/hcap.rs232c.FlowControl.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>FlowControl</a></li>
<li><a href="../symbols/hcap.rs232c.Parity.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>Parity</a></li>
<li><a href="../symbols/hcap.rs232c.StopBit.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>StopBit</a></li>
<li><a href="../symbols/hcap.security.html">hcap<span class='break'> </span>.<span class='break'> </span>security</a></li>
<li><a href="../symbols/hcap.socket.html">hcap<span class='break'> </span>.<span class='break'> </span>socket</a></li>
<li><a href="../symbols/hcap.speech.html">hcap<span class='break'> </span>.<span class='break'> </span>speech</a></li>
<li><a href="../symbols/hcap.speech.HostType.html">hcap<span class='break'> </span>.<span class='break'> </span>speech<span class='break'> </span>.<span class='break'> </span>HostType</a></li>
<li><a href="../symbols/hcap.system.html">hcap<span class='break'> </span>.<span class='break'> </span>system</a></li>
<li><a href="../symbols/hcap.system.SoundOutputType.html">hcap<span class='break'> </span>.<span class='break'> </span>system<span class='break'> </span>.<span class='break'> </span>SoundOutputType</a></li>
<li><a href="../symbols/hcap.time.html">hcap<span class='break'> </span>.<span class='break'> </span>time</a></li>
<li><a href="../symbols/hcap.video.html">hcap<span class='break'> </span>.<span class='break'> </span>video</a></li>
<li><a href="../symbols/hcap.volume.html">hcap<span class='break'> </span>.<span class='break'> </span>volume</a></li>
<li><a href="../symbols/hcap.webrtc.html">hcap<span class='break'> </span>.<span class='break'> </span>webrtc</a></li>
</ul>
</nav>
</div>
<div class="fineprint" style="clear:both">
<footer>
Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
Generated on:
<time datetime='2021-8-13' pubdate>2021-8-13 18:29</time>
</footer>
</div>
</div>
<div class="index indexStatic"></div>
<div class="content">
<div class="innerContent">
<article>
<header>
<h1 class="classTitle">
Namespace <span>hcap.beacon</span>
</h1>
<div class="intro">
<p class="description summary">
hcap.beacon
</p>
<ul class="summary">
<li>Defined in: <a href="../symbols/src/js_hcap-1.24.6.5901.js.html">hcap-1.24.6.5901.js</a></li>
</ul>
</div>
</header>
<section>
<div class="props">
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class hcap.beacon.">
<caption class="sectionTitle">Namespace Summary</caption>
<thead>
<tr>
<th scope="col">Constructor Attributes</th>
<th scope="col">Constructor Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/hcap.beacon.html#constructor">hcap.beacon</a></b>
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
<!--
#### METHODS SUMMARY
-->
<section>
<div class="props">
<h2 class="sectionTitle">Method Summary</h2>
<nav>
<table class="summaryTable" id="MethodsList" cellspacing="0" summary="A summary of the methods documented in the class hcap.beacon.">
<thead>
<tr>
<th scope="col">Method Attributes</th>
<th scope="col">Method Name and Description</th>
</tr>
</thead>
<tbody>
<tr
class='item0'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.beacon.<b><a href="../symbols/hcap.beacon.html#.getBeaconInformation">getBeaconInformation</a></b>(param)
</div>
<div class="description">Gets the configuration of beacon.</div>
</td>
</tr>
<tr
class='item1'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.beacon.<b><a href="../symbols/hcap.beacon.html#.requestEddystoneUid">requestEddystoneUid</a></b>(param)
</div>
<div class="description">Request the Eddystone Uid.</div>
</td>
</tr>
<tr
class='item2'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.beacon.<b><a href="../symbols/hcap.beacon.html#.requestEddystoneUrl">requestEddystoneUrl</a></b>(param)
</div>
<div class="description">Request the Eddystone Url.</div>
</td>
</tr>
<tr
class='item3'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.beacon.<b><a href="../symbols/hcap.beacon.html#.requestiBeacon">requestiBeacon</a></b>(param)
</div>
<div class="description">Request the iBeacon.</div>
</td>
</tr>
<tr
class='item4'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.beacon.<b><a href="../symbols/hcap.beacon.html#.setBeaconMode">setBeaconMode</a></b>(param)
</div>
<div class="description">Sets the beacon mode is enabled or disabled.</div>
</td>
</tr>
<tr
class='item5'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.beacon.<b><a href="../symbols/hcap.beacon.html#.startScan">startScan</a></b>(param)
</div>
<div class="description">Starts to scan beacon data.</div>
</td>
</tr>
<tr
class='item6'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.beacon.<b><a href="../symbols/hcap.beacon.html#.stopScan">stopScan</a></b>(param)
</div>
<div class="description">Stops beacon data scanning.</div>
</td>
</tr>
</tbody>
</table>
</nav>
</div>
</section>
<!--
#### EVENTS SUMMARY
-->
<!--
#### CONSTRUCTOR DETAILS
-->
<section>
<div class="details props">
<div class="innerProps">
<h2 class="sectionTitle" id="constructor">
Namespace Detail
</h2>
<div class="fixedFont">
<b>hcap.beacon</b>
</div>
<div class="description">
</div>
</div>
</div>
</section>
<!--
#### FIELD DETAILS
-->
<!--
#### METHOD DETAILS
-->
<section>
<div class="details props">
<div class="innerProps">
<h2 class="sectionTitle">
Method Detail
</h2>
<ul class="methodDetail" id="MethodDetail">
<li
class='item0'
>
<div class="fixedFont heading" id=".getBeaconInformation">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.beacon.</span><b>getBeaconInformation</b>(param)
</div>
<div class="description">
Gets the configuration of beacon.<br>
</div>
<pre class="code prettyprint">hcap.beacon.getBeaconInformation({
"onSuccess" : function(s) {
console.log("onSuccess : " +
"\n beacon mode : " + s.beaconMode +
"\n beacon type : " + s.beaconType +
"\n iBeacon uuid : " + s.iBeaconUuid +
"\n iBeacon major : " + s.iBeaconMajor +
"\n iBeacon minor : " + s.iBeaconMinor +
"\n eddystone uuid : " + s.eddyStoneUuid +
"\n eddystone frame : " + s.eddyStoneFrame +
"\n eddystone url prefix : " + s.eddyStoneUrlPrefix +
"\n eddystone url ex code : " + s.eddyStoneUrlExCode +
"\n eddystone url : " + s.eddyStoneUrl);
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function (param) {
// {Boolean} param.beaconMode - true : enable to beacon mode, false : disable
// {String} param.beaconType - beacon type(iBeacon, eddystone)
// {String} param.iBeaconUuid - uuid of iBeacon.
// {Number} param.iBeaconMajor - major of iBeacon.
// {Number} param.iBeaconMinor - minor of iBeacon.
// {String} param.eddyStoneUuid - uuid of eddystone.
// {String} param.eddyStoneFrame - frame of eddystone.
// {String} param.eddyStoneUrlPrefix - url prefix of eddystone.
// {String} param.eddyStoneUrlExCode - url ex code of eddystone.
// {String} param.eddyStoneUrl - url of eddystone.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Since:</dt>
<dd>1.22.0</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.beacon.html#.setBeaconMode">hcap.beacon.setBeaconMode()</a><br>
<a href="hcap.beacon.html#.requestiBeacon">hcap.beacon.requestiBeacon()</a><br>
<a href="hcap.beacon.html#.requestEddystoneUid">hcap.beacon.requestEddystoneUid()</a><br>
<a href="hcap.beacon.html#.requestEddystoneUrl">hcap.beacon.requestEddystoneUrl()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item1'
>
<div class="fixedFont heading" id=".requestEddystoneUid">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.beacon.</span><b>requestEddystoneUid</b>(param)
</div>
<div class="description">
Request the Eddystone Uid.<br>
This is worked only when the beacon mode is enabled.<br>
</div>
<pre class="code prettyprint">hcap.beacon.requestEddystoneUid({
"uuid" : "AAAAAAAAAAAAAAAAAAAABBBBBBBB",
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{String} param.uuid [Required] - uuid. the range is 0~F(field1: 20 digits string, field2: 8 digits string)</li>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Since:</dt>
<dd>1.22.0</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.beacon.html#.setBeaconMode">hcap.beacon.setBeaconMode()</a><br>
<a href="hcap.beacon.html#.requestiBeacon">hcap.beacon.requestiBeacon()</a><br>
<a href="hcap.beacon.html#.requestEddystoneUrl">hcap.beacon.requestEddystoneUrl()</a><br>
<a href="hcap.beacon.html#.getBeaconInformation">hcap.beacon.getBeaconInformation()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item2'
>
<div class="fixedFont heading" id=".requestEddystoneUrl">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.beacon.</span><b>requestEddystoneUrl</b>(param)
</div>
<div class="description">
Request the Eddystone Url.<br>
This is worked only when the beacon mode is enabled.<br>
</div>
<pre class="code prettyprint">hcap.beacon.requestEddystoneUrl({
"prefix" : "httpEx",
"excode" : "eduEx",
"url" : "abcdefghijklmnopq",
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{String} param.prefix [Required] - url prefix ("http", "httpEx", "https", "httpsEx")</li>
<li>{String} param.excode [Required] - url excode ("noneValue", "comEx", "orgEx", eduEx", "netEx", "infoEx", "bizEx", "govEx", "com", "org", "edu", "nex", "info", "biz", "gov")</li>
<li>{String} param.url [Required] - url. max length is 17. but max length is 15 when prefix is "httpsEx" or excode is "infoEx".</li>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Since:</dt>
<dd>1.22.0</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.beacon.html#.setBeaconMode">hcap.beacon.setBeaconMode()</a><br>
<a href="hcap.beacon.html#.requestiBeacon">hcap.beacon.requestiBeacon()</a><br>
<a href="hcap.beacon.html#.requestEddystoneUid">hcap.beacon.requestEddystoneUid()</a><br>
<a href="hcap.beacon.html#.getBeaconInformation">hcap.beacon.getBeaconInformation()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item3'
>
<div class="fixedFont heading" id=".requestiBeacon">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.beacon.</span><b>requestiBeacon</b>(param)
</div>
<div class="description">
Request the iBeacon.<br>
This is worked only when the beacon mode is enabled.<br>
</div>
<pre class="code prettyprint">hcap.beacon.requestiBeacon({
"uuid" : "AAAAAAAABBBBCCCCDDDDEEEEEEEE",
"major" : 65535,
"minor" : 65535,
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{String} param.uuid [Required] - uuid. the range is 0~F(field1: 8 digits string, field2: 4 digits string, field3: 4 digits string, field4: 4 digits string, field5: 8 digits string)</li>
<li>{Number} param.major [Required] - the value of major (0 ~ 65535)</li>
<li>{Number} param.minor [Required] - the value of minor (0 ~ 65535)</li>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Since:</dt>
<dd>1.22.0</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.beacon.html#.setBeaconMode">hcap.beacon.setBeaconMode()</a><br>
<a href="hcap.beacon.html#.requestEddystoneUid">hcap.beacon.requestEddystoneUid()</a><br>
<a href="hcap.beacon.html#.requestEddystoneUrl">hcap.beacon.requestEddystoneUrl()</a><br>
<a href="hcap.beacon.html#.getBeaconInformation">hcap.beacon.getBeaconInformation()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item4'
>
<div class="fixedFont heading" id=".setBeaconMode">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.beacon.</span><b>setBeaconMode</b>(param)
</div>
<div class="description">
Sets the beacon mode is enabled or disabled.<br>
</div>
<pre class="code prettyprint">hcap.beacon.setBeaconMode({
"enable" : true,
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Boolean} param.enable [Required] - true : enable to beacon mode, false : disable.</li>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Since:</dt>
<dd>1.22.0</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.beacon.html#.requestiBeacon">hcap.beacon.requestiBeacon()</a><br>
<a href="hcap.beacon.html#.requestEddystoneUid">hcap.beacon.requestEddystoneUid()</a><br>
<a href="hcap.beacon.html#.requestEddystoneUrl">hcap.beacon.requestEddystoneUrl()</a><br>
<a href="hcap.beacon.html#.getBeaconInformation">hcap.beacon.getBeaconInformation()</a><br>
<a href="_global_.html#event:ui_value_changed">{Event} ui_value_changed</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item5'
>
<div class="fixedFont heading" id=".startScan">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.beacon.</span><b>startScan</b>(param)
</div>
<div class="description">
Starts to scan beacon data.<br>
</div>
<pre class="code prettyprint">hcap.beacon.startScan({
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Since:</dt>
<dd>1.24.6</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.beacon.html#.stopScan">hcap.beacon.stopScan()</a><br>
<a href="_global_.html#event:beacon_device_discovered">{Event} beacon_device_discovered</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item6'
>
<div class="fixedFont heading" id=".stopScan">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.beacon.</span><b>stopScan</b>(param)
</div>
<div class="description">
Stops beacon data scanning.<br>
</div>
<pre class="code prettyprint">hcap.beacon.stopScan({
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Since:</dt>
<dd>1.24.6</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.beacon.html#.startScan">hcap.beacon.startScan()</a><br>
<a href="_global_.html#event:beacon_device_discovered">{Event} beacon_device_discovered</a><br></dd>
</dl>
</dl>
</li>
</ul>
</div>
</div>
</section>
<!--
#### EVENT DETAILS
-->
</article>
</div>
</div>
<script type="text/javascript">
wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660)
codeview.classFilter.Init()
</script>
<script src="../javascript/highlighter/prettify.js"></script>
<script>prettyPrint();</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink