NCBeacon Class Reference

Class is used for storing iBeacon. More...

#include <com/navigine/idl/objc/NCBeacon.h>

Inherits NSObject.

Properties
NCPoint *	point
	beacon's X and Y coordinates in meters as Point (within the sublocation).
int32_t	locationId
	beacon's location identifier.
int32_t	sublocationId
	beacon's sublocation identifier.
NSString *	name
	beacon's name.
int32_t	major
	beacon's major. Values [1-65535]
int32_t	minor
	beacon's minor. Values [1-65535]
NSString *	uuid
	beacon's uuid. Format [XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX]
NSNumber *	power
	beacon's power.
NCTransmitterStatus	status
	iBeacon status. TransmitterStatus
BOOL	valid

Detailed Description

Class is used for storing iBeacon.

Referenced from Sublocation.

Definition at line 21 of file NCBeacon.h.

Property Documentation

locationId

- (int32_t) locationId

readnonatomicassign

beacon's location identifier.

Swift code snippet:

        // Get beacon location ID
        let locationId = beacon.getLocationId()
        print("Beacon location ID: \‍(locationId)")

Objective C code snippet:

    // Get beacon location ID
    int32_t locationId = [beacon getLocationId];
    NSLog(@"Beacon location ID: %d", locationId);

Definition at line 51 of file NCBeacon.h.

major

- (int32_t) major

readnonatomicassign

beacon's major. Values [1-65535]

Swift code snippet:

        // Get beacon major
        let major = beacon.getMajor()
        print("Beacon major: \‍(major)")

Objective C code snippet:

    // Get beacon major
    int32_t major = [beacon getMajor];
    NSLog(@"Beacon major: %d", major);

Definition at line 96 of file NCBeacon.h.

minor

- (int32_t) minor

readnonatomicassign

beacon's minor. Values [1-65535]

Swift code snippet:

        // Get beacon minor
        let minor = beacon.getMinor()
        print("Beacon minor: \‍(minor)")

Objective C code snippet:

    // Get beacon minor
    int32_t minor = [beacon getMinor];
    NSLog(@"Beacon minor: %d", minor);

Definition at line 111 of file NCBeacon.h.

name

- (NSString*) name

readnonatomicassign

beacon's name.

Swift code snippet:

        // Get beacon name
        let beaconName = beacon.getName()
        print("Beacon name: \‍(beaconName ?? "nil")")

Objective C code snippet:

    // Get beacon name
    NSString *beaconName = [beacon getName];
    NSLog(@"Beacon name: %@", beaconName);

Definition at line 81 of file NCBeacon.h.

point

- (NCPoint*) point

readnonatomicassign

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

Swift code snippet:

        // Get beacon point
        let point = beacon.getPoint()
        if let point = point {
            demonstratePointUsage(point)
        }

Objective C code snippet:

    // Get beacon point
    NCPoint *point = [beacon getPoint];
    if (point != nil) {
        [self demonstratePointUsage:point];
    }

Definition at line 36 of file NCBeacon.h.

power

- (NSNumber*) power

readnonatomicassign

beacon's power.

Swift code snippet:

        // Get beacon power
        let power = beacon.getPower()
        if let power = power {
            print("Beacon power: \‍(power)")
        }

Objective C code snippet:

    // Get beacon power
    NSNumber *power = [beacon getPower];
    if (power != nil) {
        NSLog(@"Beacon power: %d", [power intValue]);
    }

Definition at line 141 of file NCBeacon.h.

status

- (NCTransmitterStatus) status

readnonatomicassign

iBeacon status. TransmitterStatus

Swift code snippet:

        // Get beacon status
        let status = beacon.getStatus()
        print("Beacon status: \‍(status)")

Objective C code snippet:

    // Get beacon status
    NCTransmitterStatus status = [beacon getStatus];
    NSLog(@"Beacon status: %ld", (long)status);

Definition at line 156 of file NCBeacon.h.

sublocationId

- (int32_t) sublocationId

readnonatomicassign

beacon's sublocation identifier.

Swift code snippet:

        // Get beacon sublocation ID
        let sublocationId = beacon.getSublocationId()
        print("Beacon sublocation ID: \‍(sublocationId)")

Objective C code snippet:

    // Get beacon sublocation ID
    int32_t sublocationId = [beacon getSublocationId];
    NSLog(@"Beacon sublocation ID: %d", sublocationId);

Definition at line 66 of file NCBeacon.h.

uuid

- (NSString*) uuid

readnonatomicassign

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

Swift code snippet:

        // Get beacon UUID
        let uuid = beacon.getUuid()
        print("Beacon UUID: \‍(uuid ?? "nil")")

Objective C code snippet:

    // Get beacon UUID
    NSString *uuid = [beacon getUuid];
    NSLog(@"Beacon UUID: %@", uuid);

Definition at line 126 of file NCBeacon.h.

valid

- (BOOL) valid

readnonatomicassign

Tells if this object is valid or not. Any method called on an invalid object will throw an exception. The object becomes invalid only on UI thread, and only when its implementation depends on objects already destroyed by now.

Definition at line 164 of file NCBeacon.h.

---

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

• NCBeacon.h