DBFILEPROPERTIESPropertyFieldTemplate

Objective-C

@interface DBFILEPROPERTIESPropertyFieldTemplate
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILEPROPERTIESPropertyFieldTemplate : NSObject, DBSerializable, NSCopying

The PropertyFieldTemplate struct.

Defines how a single property field may be structured. Used exclusively by PropertyGroupTemplate.

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

Instance fields

  • Key of the property field being described. Property field keys can be up to 256 bytes.

    Declaration

    Objective-C

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

    Swift

    var name: String { get }

  • Description of the property field. Property field descriptions can be up to 1024 bytes.

    Declaration

    Objective-C

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

    Swift

    var description_: String { get }

  • Data type of the value of this property field. This type will be enforced upon property creation and modifications.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILEPROPERTIESPropertyType *_Nonnull type;

    Swift

    var type: DBFILEPROPERTIESPropertyType { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithName:(nonnull NSString *)name
                        description_:(nonnull NSString *)description_
                                type:(nonnull DBFILEPROPERTIESPropertyType *)
                                         type;

    Swift

    init(name: String, description_: String, type: DBFILEPROPERTIESPropertyType)

    Parameters

    name

    Key of the property field being described. Property field keys can be up to 256 bytes.
    description_

    Description of the property field. Property field descriptions can be up to 1024 bytes.
    type

    Data type of the value of this property field. This type will be enforced upon property creation and modifications.

    Return Value

    An initialized instance.