npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cordova-plugin-nearbee

v1.0.0

Published

A Cordova plugin that allows users to recieve notifications from beacons

Downloads

10

Readme

A Cordova plugin for NearBee SDK.

Pre-requisites

  • Set up Cordova

  • An active Bluetooth connection.

  • Get the Developer token and Organization ID from here.

  • Make sure to use any Cordova plugin to keep the app running in background.

Android

  • Android target version should be 28.

  • Coarse Location permission.

  • Replace MY_DEV_TOKEN and MY_ORGANIZATION_ID in the AndroidManifest.xml file with proper values.


    <application>
        ...
        <meta-data
            android:name="co.nearbee.api_key"
            android:value="MY_DEV_TOKEN" />

        <meta-data
            android:name="co.nearbee.organization_id"
            android:value="MY_ORGANIZATION_ID" />
        ...
    </application>

iOS

  • Cordova iOS platform version should be 5.0.0.

  • Pod iOS platform version should be 10.0.

  • Notification and location permissions.

  • Replace MY_DEV_TOKEN and MY_ORGANIZATION_ID in the Info.plist file with proper values


    <key>co.nearbee.api_key</key>
    <string>MY_DEV_TOKEN<string>
    <key>co.nearbee.organization_id</key>
    <string>MY_ORGANIZATION_ID</string>

Configuring the project

cordova plugin add cordova-plugin-nearbee

Usage

NOTE: Every method returns success and error callbacks.

Initialize SDK.

    window.plugins.nearbeePlugin.initialize();

Enable background notifications

If set to true the NearBee SDK will send beacon notifications in the background, when the app is not running.

    window.plugins.nearbeePlugin.enableBackgroundNotifications(true);

Start scanning

This will start the scan for the beacons.

     window.plugins.nearbeePlugin.startScanning();

Receive nearbee notifications

To display a UI with list of beacons, the following needs to be done:

     window.plugins.nearbeePlugin.nearbeeNotifications(function(notificationObject) {
            console.log(JSON.parse(notificationObject));
          }, function(err) {
            console.log('Uh oh... ' + err);
        });

Stop Scanning

This will stop the scan for the beacons.

     window.plugins.nearbeePlugin.stopScanning();

Clearing notification cache

This will clear the cached server responses and will force NearBee to fetch fresh data from the server.

     window.plugins.nearbeePlugin.clearNotificationCache();