ESTSettingEddystoneURLData

@interface ESTSettingEddystoneURLData : ESTSettingReadWrite <NSCopying>

ESTSettingEddystoneURLData represents Eddystone URL Data value.

  • Designated initializer. Validates provided value internally with +validationErrorForValue:.

    See

    +[ESTSettingEddystoneURLInterval validationErrorForValue:]

    Declaration

    Objective-C

    - (instancetype _Nullable)initWithValue:(nonnull NSString *)eddystoneURL;

    Swift

    init?(value eddystoneURL: String)

    Parameters

    eddystoneURL

    Eddystone URL Data value.

    Return Value

    Initialized object. Nil if validation fails.

  • Returns current value of Eddystone URL Data setting.

    Declaration

    Objective-C

    - (nonnull NSString *)getValue;

    Swift

    func getValue() -> String

    Return Value

    Eddystone URL URL Data value.

  • Method allows to read value of initialized Eddystone URL Data setting object.

    Declaration

    Objective-C

    - (void)readValueWithCompletion:
    (nonnull ESTSettingEddystoneURLDataCompletionBlock)completion;

    Swift

    func readValue(completion: @escaping ESTSettingEddystoneURLDataCompletionBlock)

    Parameters

    completion

    Block to be invoked when operation is complete.

  • Method allows to create write operation from already initialized Eddystone URL Data setting object. Value provided during initialization will be used as a desired value.

    Declaration

    Objective-C

    - (void)writeValue:(nonnull NSString *)eddystoneURL
        completion:
            (nonnull ESTSettingEddystoneURLDataCompletionBlock)completion;

    Swift

    func writeValue(_ eddystoneURL: String, completion: @escaping ESTSettingEddystoneURLDataCompletionBlock)

    Parameters

    eddystoneURL

    URL Data value to be written to the device.
    completion

    Block to be invoked when operation is complete.

  • Method checks if provided value is a proper Eddystone URL string. Returns nil if validation passes.

    Declaration

    Objective-C

    + (NSError *_Nullable)validationErrorForValue:(nonnull NSString *)eddystoneURL;

    Swift

    class func validationError(forValue eddystoneURL: String) -> Error?

    Parameters

    eddystoneURL

    Eddystone URL string.

    Return Value

    Error object describing why validation failed. Nil if validation passes.