ESTSettingGenericAdvertiserData

@interface ESTSettingGenericAdvertiserData : ESTSettingReadWrite <NSCopying>

ESTSettingGenericAdvertiserData represents GenericAdvertiser GenericAdvertiserData 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:advertiserID:.

    See

    +[ESTSettingGenericAdvertiserData validationErrorForValue:]

    Declaration

    Objective-C

    - (nonnull instancetype)initWithValue:(nonnull NSData *)genericAdvertiserData
                         advertiserID:(ESTGenericAdvertiserID)advertiserID;

    Swift

    init(value genericAdvertiserData: Data, advertiserID: ESTGenericAdvertiserID)

    Parameters

    genericAdvertiserData

    GenericAdvertiser GenericAdvertiserData value.
    advertiserID

    GenericAdvertiser ID.

    Return Value

    Initialized object. Nil if validation fails.

  • Returns current value of GenericAdvertiser GenericAdvertiserData setting.

    Declaration

    Objective-C

    - (nonnull NSData *)getValue;

    Swift

    func getValue() -> Data

    Return Value

    GenericAdvertiser GenericAdvertiserData value.

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

    Declaration

    Objective-C

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

    Swift

    func readValue(completion: @escaping ESTSettingGenericAdvertiserDataCompletionBlock)

    Parameters

    completion

    Block to be invoked when operation is complete.

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

    Declaration

    Objective-C

    - (void)writeValue:(nonnull NSData *)genericAdvertiserData
        completion:
            (nonnull ESTSettingGenericAdvertiserDataCompletionBlock)completion;

    Swift

    func writeValue(_ genericAdvertiserData: Data, completion: @escaping ESTSettingGenericAdvertiserDataCompletionBlock)

    Parameters

    genericAdvertiserData

    GenericAdvertiserData 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 NSData *)data
                                 advertiserID:
                                     (ESTGenericAdvertiserID)advertiserID;

    Swift

    class func validationError(forValue data: Data, advertiserID: ESTGenericAdvertiserID) -> Error?

    Parameters

    data

    GenericAdvertiser Data value.
    advertiserID

    GenericAdvertiser ID.

    Return Value

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