DBFILEPROPERTIESPropertyGroupUpdate

Objective-C

@interface DBFILEPROPERTIESPropertyGroupUpdate
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILEPROPERTIESPropertyGroupUpdate : NSObject, DBSerializable, NSCopying

The PropertyGroupUpdate struct.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

  • A unique identifier for a property template.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull templateId;

    Swift

    var templateId: String { get }

  • Property fields to update. If the property field already exists, it is updated. If the property field doesn’t exist, the property group is added.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSArray<DBFILEPROPERTIESPropertyField *> *addOrUpdateFields;

    Swift

    var addOrUpdateFields: [DBFILEPROPERTIESPropertyField]? { get }

  • Property fields to remove (by name), provided they exist.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSArray<NSString *> *removeFields;

    Swift

    var removeFields: [String]? { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithTemplateId:(nonnull NSString *)templateId
     addOrUpdateFields:
         (nullable NSArray<DBFILEPROPERTIESPropertyField *> *)addOrUpdateFields
          removeFields:(nullable NSArray<NSString *> *)removeFields;

    Swift

    init(templateId: String, addOrUpdate addOrUpdateFields: [DBFILEPROPERTIESPropertyField]?, removeFields: [String]?)

    Parameters

    templateId

    A unique identifier for a property template.
    addOrUpdateFields

    Property fields to update. If the property field already exists, it is updated. If the property field doesn’t exist, the property group is added.
    removeFields

    Property fields to remove (by name), provided they exist.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTemplateId:(nonnull NSString *)templateId;

    Swift

    init(templateId: String)

    Parameters

    templateId

    A unique identifier for a property template.

    Return Value

    An initialized instance.