long dao / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of BLE_API by Bluetooth Low Energy

Diff: services/URIBeacon2Service.h

Revision:
173:05c4b1cea65f
Parent:
172:fb95afa93697
Child:
174:5ae7781362b6
--- a/services/URIBeacon2Service.h	Fri Nov 28 14:11:22 2014 +0000
+++ b/services/URIBeacon2Service.h	Fri Nov 28 14:11:22 2014 +0000
@@ -86,6 +86,22 @@
         ble.onDataWritten(this, &URIBeacon2Service::onDataWritten);
     }
 
+    /**
+     * Update flags of the URIBeacon dynamically.
+     *
+     * @param[in] flagsIn
+     *
+     *     ### UriBeacon Flags
+     *     Bit   | Description
+     *     :---- | :----------
+     *     0     | Invisible Hint
+     *     1..7  | Reserved for future use. Must be zero.
+     *
+     *     The `Invisible Hint` flag is a command for the user-agent that tells
+     *     it not to access or display the UriBeacon. This is a guideline only,
+     *     and is not a blocking method. User agents may, with user approval,
+     *     display invisible beacons.
+     */
     void setFlags(uint8_t flagsIn) {
         flags = flagsIn;
         setup();