com.navigine.idl.java.Beacon Class Reference

Class is used for storing iBeacon. More...

Inheritance diagram for com.navigine.idl.java.Beacon:

Public Member Functions
abstract Point	getPoint ()
	beacon's X and Y coordinates in meters as Point (within the sublocation).
abstract int	getLocationId ()
	beacon's location identifier.
abstract int	getSublocationId ()
	beacon's sublocation identifier.
abstract String	getName ()
	beacon's name.
abstract int	getMajor ()
	beacon's major. Values [1-65535]
abstract int	getMinor ()
	beacon's minor. Values [1-65535]
abstract String	getUuid ()
	beacon's uuid. Format [XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX]
abstract Integer	getPower ()
	beacon's power.
abstract TransmitterStatus	getStatus ()
	iBeacon status. TransmitterStatus
abstract boolean	isValid ()

Detailed Description

Class is used for storing iBeacon.

Referenced from Sublocation.

Definition at line 16 of file Beacon.java.

Member Function Documentation

getLocationId()

abstract int com.navigine.idl.java.Beacon.getLocationId ( )

abstract

beacon's location identifier.

Returns

Java code snippet:

        // Get beacon location ID
        int locationId = beacon.getLocationId();
        System.out.println("Beacon location ID: " + locationId);

Kotlin code snippet:

        // Get beacon location ID
        val locationId = beacon.locationId
        println("Beacon location ID: $locationId")

Reimplemented in com.navigine.idl.java.internal.BeaconBinding.

getMajor()

abstract int com.navigine.idl.java.Beacon.getMajor ( )

abstract

beacon's major. Values [1-65535]

Returns

Java code snippet:

        // Get beacon major
        int major = beacon.getMajor();
        System.out.println("Beacon major: " + major);

Kotlin code snippet:

        // Get beacon major
        val major = beacon.major
        println("Beacon major: $major")

Reimplemented in com.navigine.idl.java.internal.BeaconBinding.

getMinor()

abstract int com.navigine.idl.java.Beacon.getMinor ( )

abstract

beacon's minor. Values [1-65535]

Returns

Java code snippet:

        // Get beacon minor
        int minor = beacon.getMinor();
        System.out.println("Beacon minor: " + minor);

Kotlin code snippet:

        // Get beacon minor
        val minor = beacon.minor
        println("Beacon minor: $minor")

Reimplemented in com.navigine.idl.java.internal.BeaconBinding.

getName()

abstract String com.navigine.idl.java.Beacon.getName ( )

abstract

beacon's name.

Returns

Java code snippet:

        // Get beacon name
        String beaconName = beacon.getName();
        System.out.println("Beacon name: " + beaconName);

Kotlin code snippet:

        // Get beacon name
        val beaconName = beacon.name
        println("Beacon name: $beaconName")

Reimplemented in com.navigine.idl.java.internal.BeaconBinding.

getPoint()

abstract Point com.navigine.idl.java.Beacon.getPoint ( )

abstract

beacon's X and Y coordinates in meters as Point (within the sublocation).

Returns

Java code snippet:

        // Get beacon point
        Point point = beacon.getPoint();
        if (point != null) {
            demonstratePointUsage(point);
        }

Kotlin code snippet:

        // Get beacon point
        val point = beacon.point
        point?.let { demonstratePointUsage(it) }

Reimplemented in com.navigine.idl.java.internal.BeaconBinding.

getPower()

abstract Integer com.navigine.idl.java.Beacon.getPower ( )

abstract

beacon's power.

Returns

Java code snippet:

        // Get beacon power
        Integer power = beacon.getPower();
        if (power != null) {
            System.out.println("Beacon power: " + power);
        }

Kotlin code snippet:

        // Get beacon power
        val power = beacon.power
        power?.let { println("Beacon power: $it") }

Reimplemented in com.navigine.idl.java.internal.BeaconBinding.

getStatus()

abstract TransmitterStatus com.navigine.idl.java.Beacon.getStatus ( )

abstract

iBeacon status. TransmitterStatus

Returns

Java code snippet:

        // Get beacon status
        TransmitterStatus status = beacon.getStatus();
        System.out.println("Beacon status: " + status);

Kotlin code snippet:

        // Get beacon status
        val status = beacon.status
        println("Beacon status: $status")

Reimplemented in com.navigine.idl.java.internal.BeaconBinding.

getSublocationId()

abstract int com.navigine.idl.java.Beacon.getSublocationId ( )

abstract

beacon's sublocation identifier.

Returns

Java code snippet:

        // Get beacon sublocation ID
        int sublocationId = beacon.getSublocationId();
        System.out.println("Beacon sublocation ID: " + sublocationId);

Kotlin code snippet:

        // Get beacon sublocation ID
        val sublocationId = beacon.sublocationId
        println("Beacon sublocation ID: $sublocationId")

Reimplemented in com.navigine.idl.java.internal.BeaconBinding.

getUuid()

abstract String com.navigine.idl.java.Beacon.getUuid ( )

abstract

beacon's uuid. Format [XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX]

Returns

Java code snippet:

        // Get beacon UUID
        String uuid = beacon.getUuid();
        System.out.println("Beacon UUID: " + uuid);

Kotlin code snippet:

        // Get beacon UUID
        val uuid = beacon.uuid
        println("Beacon UUID: $uuid")

Reimplemented in com.navigine.idl.java.internal.BeaconBinding.

isValid()

abstract boolean com.navigine.idl.java.Beacon.isValid ( )

abstract

Tells if this Beacon is valid or not. Any other method (except for this one) called on an invalid Beacon will throw java.lang.RuntimeException.

Reimplemented in com.navigine.idl.java.internal.BeaconBinding.

---

The documentation for this class was generated from the following file:

• Beacon.java