ESTSettingDeviceInfoTags

@interface ESTSettingDeviceInfoTags : ESTSettingReadWrite <NSCopying>

ESTSettingDeviceInfoTags represents Cloud Tags value.

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

    See

    +[ESTSettingDeviceInfoTags validationErrorForValue:]

    Declaration

    Objective-C

    - (nonnull instancetype)initWithValue:(nonnull NSSet<NSString *> *)tags;

    Swift

    init(value tags: Set<String>)

    Parameters

    tags

    Cloud Tags value.

    Return Value

    Initialized object. Nil if validation fails.

  • Returns current value of Cloud Tags setting.

    Declaration

    Objective-C

    - (nonnull NSSet<NSString *> *)getValue;

    Swift

    func getValue() -> Set<String>

    Return Value

    Cloud Tags value.

  • Method allows to read value of initialized Cloud Tags setting object.

    Declaration

    Objective-C

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

    Swift

    func readValue(completion: @escaping ESTSettingDeviceInfoTagsCompletionBlock)

    Parameters

    completion

    Block to be invoked when operation is complete.

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

    Declaration

    Objective-C

    - (void)writeValue:(nonnull NSSet<NSString *> *)tags
        completion:(nonnull ESTSettingDeviceInfoTagsCompletionBlock)completion;

    Swift

    func writeValue(_ tags: Set<String>, completion: @escaping ESTSettingDeviceInfoTagsCompletionBlock)

    Parameters

    tags

    Set containing tags 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 NSSet<NSString *> *)tags;

    Swift

    class func validationError(forValue tags: Set<String>) -> Error?

    Parameters

    tags

    Tags value.

    Return Value

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