ESTSettingGenericAdvertiserInterval

@interface ESTSettingGenericAdvertiserInterval : ESTSettingReadWrite <NSCopying>

ESTSettingGenericAdvertiserInterval represents GenericAdvertiser GenericAdvertiserInterval value.

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

    Declaration

    Objective-C

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

    Swift

    var advertiserID: NSNumber { get }

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

    See

    +[ESTSettingGenericAdvertiserInterval validationErrorForValue:]

    Declaration

    Objective-C

    - (nonnull instancetype)initWithValue:(unsigned short)genericAdvertiserInterval
                         advertiserID:(ESTGenericAdvertiserID)advertiserID;

    Swift

    init(value genericAdvertiserInterval: UInt16, advertiserID: ESTGenericAdvertiserID)

    Parameters

    genericAdvertiserInterval

    GenericAdvertiser GenericAdvertiserInterval value.
    advertiserID

    GenericAdvertiser ID.

    Return Value

    Initialized object. Nil if validation fails.

  • Returns current value of GenericAdvertiser GenericAdvertiserInterval setting.

    Declaration

    Objective-C

    - (unsigned short)getValue;

    Swift

    func getValue() -> UInt16

    Return Value

    GenericAdvertiser GenericAdvertiserInterval value.

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

    Declaration

    Objective-C

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

    Swift

    func readValue(completion: @escaping ESTSettingGenericAdvertiserIntervalCompletionBlock)

    Parameters

    completion

    Block to be invoked when operation is complete.

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

    Declaration

    Objective-C

    - (void)writeValue:(unsigned short)genericAdvertiserInterval
        completion:(nonnull ESTSettingGenericAdvertiserIntervalCompletionBlock)
                       completion;

    Swift

    func writeValue(_ genericAdvertiserInterval: UInt16, completion: @escaping ESTSettingGenericAdvertiserIntervalCompletionBlock)

    Parameters

    genericAdvertiserInterval

    GenericAdvertiserInterval 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:(unsigned short)interval
                                 advertiserID:
                                     (ESTGenericAdvertiserID)advertiserID;

    Swift

    class func validationError(forValue interval: UInt16, advertiserID: ESTGenericAdvertiserID) -> Error?

    Parameters

    interval

    GenericAdvertiser Interval value.
    advertiserID

    GenericAdvertiser ID.

    Return Value

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