ESTRequestGetBeaconsDetails

@interface ESTRequestGetBeaconsDetails : ESTRequestGetJSON

Request allows to fetch information about group of beacons with identifiers provided during initialization.

  • Array of identifiers of beacons which details should be fetched. Can be MAC addresses or Eddystone Identifiers or proximityUUID:major:minor strings

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic)
        NSArray<NSString *> *_Nonnull beaconIdentifiers;

    Swift

    var beaconIdentifiers: [String] { get }
  • Possible beacon parameters that can be fetched from the Estimote Cloud. Provided as NS_OPTIONS ESTBeaconDetailsFields.

    Declaration

    Objective-C

    @property (readonly, assign, nonatomic) ESTBeaconDetailsFields fields;

    Swift

    var fields: ESTBeaconDetailsFields { get }
  • Initialise request with Beacons array.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithBeacons:(nonnull NSArray<CLBeacon *> *)beacons
                                  andFields:(ESTBeaconDetailsFields)fields;

    Swift

    init(beacons: [CLBeacon], andFields fields: ESTBeaconDetailsFields)

    Parameters

    beacons

    Array of CLBeacon objects

    fields

    A mask of fields indicating which beacon parameters you want to fetch

    Return Value

    instance of request

  • Initialise request with MAC addresses.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMacAddresses:
                                (nonnull NSArray<NSString *> *)macAddresses
                                       andFields:(ESTBeaconDetailsFields)fields;

    Swift

    init(macAddresses: [String], andFields fields: ESTBeaconDetailsFields)

    Parameters

    macAddresses

    Array of MAC addresses as NSStrings

    fields

    A mask of fields indicating which beacon parameters you want to fetch

    Return Value

    instance of request

  • Methods allows to send request with completion block invoked as a result.

    Declaration

    Objective-C

    - (void)sendRequestWithCompletion:
        (nonnull ESTRequestGetBeaconsDetailsBlock)completion;

    Swift

    func sendRequest(completion: @escaping ESTRequestGetBeaconsDetailsBlock)

    Parameters

    completion

    Completion block with returned data (Array of beaconVO objects).