ESTSettingEddystoneUIDInstance
@interface ESTSettingEddystoneUIDInstance : ESTSettingReadWrite <NSCopying>
ESTSettingEddystoneUIDInstance represents Eddystone UID Instance ID value.
-
Designated initializer. Validates provided value internally with +validationErrorForValue:.
See
+[ESTSettingEddystoneUIDInstance validationErrorForValue:]
Declaration
Objective-C
- (instancetype _Nullable)initWithValue:(nonnull NSString *)instanceID;
Swift
init?(value instanceID: String)
Parameters
instanceID
Eddystone UID Instance ID (hex string).
Return Value
Initialized object. Nil if validation fails.
-
Returns current value of Eddystone UID Instance ID setting.
Declaration
Objective-C
- (nonnull NSString *)getValue;
Swift
func getValue() -> String
Return Value
Eddystone UID Instance ID value.
-
Method allows to read value of initialized Eddystone UID Instance ID setting object.
Declaration
Objective-C
- (void)readValueWithCompletion: (nonnull ESTSettingEddystoneUIDInstanceCompletionBlock)completion;
Swift
func readValue(completion: @escaping ESTSettingEddystoneUIDInstanceCompletionBlock)
Parameters
completion
Block to be invoked when operation is complete.
-
Method allows to create write operation from already initialized Eddystone UID Instance ID setting object. Value provided during initialization will be used as a desired value.
Declaration
Objective-C
- (void)writeValue:(nonnull NSString *)instanceID completion: (nonnull ESTSettingEddystoneUIDInstanceCompletionBlock)completion;
Swift
func writeValue(_ instanceID: String, completion: @escaping ESTSettingEddystoneUIDInstanceCompletionBlock)
Parameters
instanceID
Instance ID hex string to be written to the device.
completion
Block to be invoked when operation is complete.
-
Method checks if provided value is allowed. Returns nil if validation passes.
Declaration
Objective-C
+ (NSError *_Nullable)validationErrorForValue:(nonnull NSString *)instanceID;
Swift
class func validationError(forValue instanceID: String) -> Error?
Parameters
instanceID
Instance hex string.
Return Value
Error object describing why validation failed. Nil if validation passes.