ESTSettingGenericAdvertiserEnable

@interface ESTSettingGenericAdvertiserEnable : ESTSettingReadWrite <NSCopying>

ESTSettingGenericAdvertiserEnable represents GenericAdvertiser GenericAdvertiserEnabled 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:genericAdvertiserID:.

    See

    +[ESTSettingGenericAdvertiserEnable validationErrorForValue:]

    Declaration

    Objective-C

    - (nonnull instancetype)initWithValue:(BOOL)genericAdvertiserEnabled
                         advertiserID:(ESTGenericAdvertiserID)advertiserID;

    Swift

    init(value genericAdvertiserEnabled: Bool, advertiserID: ESTGenericAdvertiserID)

    Parameters

    genericAdvertiserEnabled

    GenericAdvertiser GenericAdvertiserEnabled value.
    advertiserID

    GenericAdvertiser ID represented by ESTGenericAdvertiserID enum.

    Return Value

    Initialized object. Nil if validation fails.

  • Returns current value of GenericAdvertiser GenericAdvertiserEnabled setting.

    Declaration

    Objective-C

    - (BOOL)getValue;

    Swift

    func getValue() -> Bool

    Return Value

    GenericAdvertiser GenericAdvertiserEnabled value.

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

    Declaration

    Objective-C

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

    Swift

    func readValue(completion: @escaping ESTSettingGenericAdvertiserEnableCompletionBlock)

    Parameters

    completion

    Block to be invoked when operation is complete.

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

    Declaration

    Objective-C

    - (void)writeValue:(BOOL)genericAdvertiserEnabled
        completion:(nonnull ESTSettingGenericAdvertiserEnableCompletionBlock)
                       completion;

    Swift

    func writeValue(_ genericAdvertiserEnabled: Bool, completion: @escaping ESTSettingGenericAdvertiserEnableCompletionBlock)

    Parameters

    genericAdvertiserEnabled

    GenericAdvertiserEnabled 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:(BOOL)enabled
                                 advertiserID:
                                     (ESTGenericAdvertiserID)advertiserID;

    Swift

    class func validationError(forValue enabled: Bool, advertiserID: ESTGenericAdvertiserID) -> Error?

    Parameters

    enabled

    GenericAdvertiser Enabled value.
    advertiserID

    GenericAdvertiser ID.

    Return Value

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