CLOSE Beacon Android API documentation

.BUILDING

1: Directory structure

2: Global gradle file

3: Module level gradle file

Step 1: Drop provided "closebeaconapi.aar"-file into the libs folder in your project

Step 2: Add provided "flatDir"-clause into the global level gradle file to tell gradle to look in your local files aswell

flatDir { dirs 'libs' }

Step 3: Add required dependencies to the module level gradle file, the ones required are Ion, commons-lang, compile(name:'closebeaconapi', ext:'aar'), and maybe appcompat, I'm not sure.

compile 'com.android.support:appcompat-v7:23.4.0'
compile(name: 'closebeaconapi', ext: 'aar')
compile 'com.koushikdutta.ion:ion:2.1.7'
compile 'org.apache.commons:commons-lang3:3.1'

.CODE EXAMPLE

Android code

.BEWARE

Be aware of the fact that if you don't include these dependencies you will get some kind of Dex Dalvik ClassNotFoundException and NoClassDefFound.

Also the whole api will throw RuntimeException's left and right if you don't make sure you have bluetooth enabled and it's reachable via the context. Also the minimum required AndroidAPI is 5.0 LOLLIPOP

.LICENSE

The MIT License (MIT)
Copyright (c) 2016 Smart Sensor Devices AB

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.