ESTSettingDeviceInfoName

@interface ESTSettingDeviceInfoName : ESTSettingReadWrite <NSCopying>

ESTSettingDeviceInfoName represents Device Info Name value.

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

    See

    +[ESTSettingDeviceInfoName validationErrorForValue:]

    Declaration

    Objective-C

    - (nonnull instancetype)initWithValue:(nonnull NSString *)name;

    Swift

    init(value name: String)

    Parameters

    name

    Device Info Name value.

    Return Value

    Initialized object. Nil if validation fails.

  • Returns current value of Device Info Name setting.

    Declaration

    Objective-C

    - (nonnull NSString *)getValue;

    Swift

    func getValue() -> String

    Return Value

    Device Info Name value.

  • Method allows to read value of initialized Device Info Name setting object.

    Declaration

    Objective-C

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

    Swift

    func readValue(completion: @escaping ESTSettingDeviceInfoNameCompletionBlock)

    Parameters

    completion

    Block to be invoked when operation is complete.

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

    Declaration

    Objective-C

    - (void)writeValue:(nonnull NSString *)name
        completion:(nonnull ESTSettingDeviceInfoNameCompletionBlock)completion;

    Swift

    func writeValue(_ name: String, completion: @escaping ESTSettingDeviceInfoNameCompletionBlock)

    Parameters

    name

    Name value 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 *)name;

    Swift

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

    Parameters

    name

    Name value.

    Return Value

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