DBFILEPROPERTIESPropertyGroupTemplate

Objective-C

@interface DBFILEPROPERTIESPropertyGroupTemplate
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILEPROPERTIESPropertyGroupTemplate : NSObject, DBSerializable, NSCopying

The PropertyGroupTemplate struct.

Defines how a property group may be structured.

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

Instance fields

  • Display name for the template. Template names can be up to 256 bytes.

    Declaration

    Objective-C

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

    Swift

    var name: String { get }

  • Description for the template. Template descriptions can be up to 1024 bytes.

    Declaration

    Objective-C

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

    Swift

    var description_: String { get }

  • Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<DBFILEPROPERTIESPropertyFieldTemplate *> *_Nonnull fields;

    Swift

    var fields: [DBFILEPROPERTIESPropertyFieldTemplate] { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithName:(nonnull NSString *)name
    description_:(nonnull NSString *)description_
          fields:(nonnull NSArray<DBFILEPROPERTIESPropertyFieldTemplate *> *)
                     fields;

    Swift

    init(name: String, description_: String, fields: [DBFILEPROPERTIESPropertyFieldTemplate])

    Parameters

    name

    Display name for the template. Template names can be up to 256 bytes.
    description_

    Description for the template. Template descriptions can be up to 1024 bytes.
    fields

    Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.

    Return Value

    An initialized instance.