Package 

Class AltBeacon

  • All Implemented Interfaces:
    android.os.Parcelable , java.io.Serializable 
    
public class AltBeacon
extends Beacon

    The AltBeacon class represents a single hardware AltBeacon detected by an Android device. It is more specific than the Beacon class in that it provides access to the #mfgReserved field.

    An AltBeacon is identified by a unique three part identifier. The first identifier Id1 is normally used across an organization, the second identifier Id2 is used to group beacons and the third identifier Id3 is used to uniquely identify a specific beacon (in combination with the other two identifiers.)

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class AltBeacon.Builder

      Builder class for AltBeacon objects. Provides a convenient way to set the various fields of a Beacon

      Example: 

      Beacon beacon = new Beacon.Builder()
        .setId1("2F234454-CF6D-4A0F-ADF2-F4911BA9FFA6")
        .setId2("1")
        .setId3("2")
        .setMfgReserved(3);
        .build();

    • Method Summary

      Modifier and Type Method Description
      int getMfgReserved() Returns a field with a value from 0-255 that can be used for the purposes specified by the manufacturer.
      int describeContents() Required for making object Parcelable
      void writeToParcel(Parcel out, int flags) Required for making object Parcelable

      • Methods inherited from class org.altbeacon.beacon.Beacon

        equals, getBeaconTypeCode, getBluetoothAddress, getBluetoothName, getDataFields, getDistance, getDistanceCalculator, getExtraDataFields, getFirstCycleDetectionTimestamp, getHardwareEqualityEnforced, getId1, getId2, getId3, getIdentifier, getIdentifiers, getLastCycleDetectionTimestamp, getManufacturer, getMeasurementCount, getPacketCount, getParserIdentifier, getRssi, getRunningAverageRssi, getRunningAverageRssi, getServiceUuid, getServiceUuid128Bit, getTxPower, hashCode, isExtraBeaconData, isMultiFrameBeacon, requestData, setDistanceCalculator, setExtraDataFields, setFirstCycleDetectionTimestamp, setHardwareEqualityEnforced, setLastCycleDetectionTimestamp, setPacketCount, setRssi, setRssiMeasurementCount, setRunningAverageRssi, toString

      • Methods inherited from class android.os.Parcelable

        describeContents, writeToParcel

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getMfgReserved

         int getMfgReserved()

        Returns a field with a value from 0-255 that can be used for the purposes specified by the manufacturer. The manufacturer specifications for the beacon should be checked before using this field, and the manufacturer should be checked against the Beacon#mManufacturer field

      • writeToParcel

         void writeToParcel(Parcel out, int flags)

        Required for making object Parcelable