SITBeaconFilter

Objective-C

@interface SITBeaconFilter : NSObject

Swift

class SITBeaconFilter : NSObject

The purpose of this class is to hold information of custom uuids

Initializers

  • Initialize a new object with the uuid string

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithUUID:(NSString *_Nonnull)uuidString;

    Swift

    init(uuid uuidString: String)

    Parameters

    uuidString

    string containing an UUID

    Return Value

    a new initialized SITBeaconFilter object

  • Initialize a new object with the uuid string and a custom identifier

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithUUID:(NSString *_Nonnull)uuidString
                           identifier:(NSString *_Nonnull)identifier;

    Swift

    init(uuid uuidString: String, identifier: String)

    Parameters

    uuidString

    string containing an UUID
    identifier

    custom identifier (for example: com.situm.beacon)

    Return Value

    a new initialized SITBeaconFilter object

Methods

  • Retrieve data of the store uuid

    Declaration

    Objective-C

    - (NSString *_Nonnull)uuid;

    Swift

    func uuid() -> String

  • Check syntax validation (UUID String must comform to the following format: 7AXB7475-6D73-6974-756D-736974756D15)

    Declaration

    Objective-C

    - (BOOL)isValid;

    Swift

    func isValid() -> Bool

  • Retrieve data of the identifier of the Filter (for example: com.situm.beacon)

    Declaration

    Objective-C

    - (NSString *_Nonnull)identifier;

    Swift

    func identifier() -> String

  • Compares the receiving beaconFilter to another beacon filter

    Declaration

    Objective-C

    - (BOOL)isEqualToBeaconFilter:(SITBeaconFilter *_Nonnull)aBeaconFilter;

    Swift

    func isEqual(to aBeaconFilter: SITBeaconFilter) -> Bool

    Parameters

    aBeaconFilter

    SITBeaconFilter The beacon filter to compare with the receiver

    Return Value

    YES if the aBeaconFilter is equivalent to the receiving beaconFilter (both have same uuid), otherwise NO.