ESTSettingPowerScheduledAdvertisingPeriod

@interface ESTSettingPowerScheduledAdvertisingPeriod
    : ESTSettingReadWrite <NSCopying>

ESTSettingPowerScheduledAdvertisingPeriod represents Power ScheduledAdvertisingPeriod value.

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

    See

    +[ESTSettingPowerScheduledAdvertisingPeriod validationErrorForValue:]

    Declaration

    Objective-C

    - (nonnull instancetype)initWithValue:(nonnull ESTTimePeriod *)period;

    Swift

    init(value period: ESTTimePeriod)

    Parameters

    period

    Power ScheduledAdvertisingPeriod value.

    Return Value

    Initialized object. Nil if validation fails.

  • Returns current value of Power ScheduledAdvertisingPeriod setting.

    Declaration

    Objective-C

    - (nonnull ESTTimePeriod *)getValue;

    Swift

    func getValue() -> ESTTimePeriod

    Return Value

    Power ScheduledAdvertisingPeriod value.

  • Method allows to read value of initialized Power ScheduledAdvertisingPeriod setting object.

    Declaration

    Objective-C

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

    Swift

    func readValue(completion: @escaping ESTSettingPowerScheduledAdvertisingPeriodCompletionBlock)

    Parameters

    completion

    Block to be invoked when operation is complete.

    Return Value

    Initialized operation object.

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

    Declaration

    Objective-C

    - (void)writeValue:(nonnull ESTTimePeriod *)period
            completion:
                (nonnull ESTSettingPowerScheduledAdvertisingPeriodCompletionBlock)
                    completion;

    Swift

    func writeValue(_ period: ESTTimePeriod, completion: @escaping ESTSettingPowerScheduledAdvertisingPeriodCompletionBlock)

    Parameters

    period

    ScheduledAdvertisingPeriod value to be written to the device.

    completion

    Block to be invoked when operation is complete.

    Return Value

    Initialized operation object.

  • Method checks if provided value is allowed. Returns nil if validation passes.

    Declaration

    Objective-C

    + (NSError *_Nullable)validationErrorForValue:(nonnull ESTTimePeriod *)period;

    Swift

    class func validationError(forValue period: ESTTimePeriod) -> Error?

    Parameters

    period

    ScheduledAdvertisingPeriod value.

    Return Value

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