ESTSettingGenericAdvertiserPower

@interface ESTSettingGenericAdvertiserPower : ESTSettingReadWrite <NSCopying>

ESTSettingGenericAdvertiserPower represents GenericAdvertiser GenericAdvertiserPower value.

  • Generic advertiser slot identifier. Check ESTGenericAdvertiserID for available options.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic) NSNumber *_Nonnull advertiserID;

    Swift

    var advertiserID: NSNumber { get }
  • Designated initializer. Validates provided value internally with +validationErrorForValue:.

    See

    +[ESTSettingGenericAdvertiserPower validationErrorForValue:]

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithValue:(ESTGenericAdvertiserPowerLevel)genericAdvertiserPower
     advertiserID:(ESTGenericAdvertiserID)advertiserID;

    Swift

    init(value genericAdvertiserPower: ESTGenericAdvertiserPowerLevel, advertiserID: ESTGenericAdvertiserID)

    Parameters

    genericAdvertiserPower

    GenericAdvertiser GenericAdvertiserPower value.

    advertiserID

    GenericAdvertiser ID.

    Return Value

    Initialized object. Nil if validation fails.

  • Returns current value of GenericAdvertiser GenericAdvertiserPower setting.

    Declaration

    Objective-C

    - (ESTGenericAdvertiserPowerLevel)getValue;

    Swift

    func getValue() -> ESTGenericAdvertiserPowerLevel

    Return Value

    GenericAdvertiser GenericAdvertiserPower value.

  • Method allows to read value of initialized GenericAdvertiser GenericAdvertiserPower setting object.

    Declaration

    Objective-C

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

    Swift

    func readValue(completion: @escaping ESTSettingGenericAdvertiserPowerCompletionBlock)

    Parameters

    completion

    Block to be invoked when operation is complete.

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

    Declaration

    Objective-C

    - (void)writeValue:(ESTGenericAdvertiserPowerLevel)genericAdvertiserPower
            completion:
                (nonnull ESTSettingGenericAdvertiserPowerCompletionBlock)completion;

    Swift

    func writeValue(_ genericAdvertiserPower: ESTGenericAdvertiserPowerLevel, completion: @escaping ESTSettingGenericAdvertiserPowerCompletionBlock)

    Parameters

    genericAdvertiserPower

    GenericAdvertiserPower 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:(ESTGenericAdvertiserPowerLevel)power
               advertiserID:(ESTGenericAdvertiserID)advertiserID;

    Swift

    class func validationError(forValue power: ESTGenericAdvertiserPowerLevel, advertiserID: ESTGenericAdvertiserID) -> Error?

    Parameters

    power

    GenericAdvertiser Power value.

    advertiserID

    GenericAdvertiser ID.

    Return Value

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