DBFILEPROPERTIESModifyTemplateError

Objective-C

@interface DBFILEPROPERTIESModifyTemplateError
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILEPROPERTIESModifyTemplateError : NSObject, DBSerializable, NSCopying

The ModifyTemplateError union.

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

Instance fields

  • tag

    Represents the union’s current tag state.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILEPROPERTIESModifyTemplateErrorTag tag;

    Swift

    var tag: DBFILEPROPERTIESModifyTemplateErrorTag { get }

  • Template does not exist for the given identifier. - note: Ensure the isTemplateNotFound method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var templateNotFound: String { get }

Constructors

  • Initializes union class with tag state of “template_not_found”.

    Description of the “template_not_found” tag state: Template does not exist for the given identifier.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTemplateNotFound:
    (nonnull NSString *)templateNotFound;

    Swift

    init(templateNotFound: String)

    Parameters

    templateNotFound

    Template does not exist for the given identifier.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “restricted_content”.

    Description of the “restricted_content” tag state: You do not have permission to modify this template.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRestrictedContent;

    Swift

    init(restrictedContent: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “other”.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOther;

    Swift

    init(other: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “conflicting_property_names”.

    Description of the “conflicting_property_names” tag state: A property field key with that name already exists in the template.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithConflictingPropertyNames;

    Swift

    init(conflictingPropertyNames: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “too_many_properties”.

    Description of the “too_many_properties” tag state: There are too many properties in the changed template. The maximum number of properties per template is 32.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyProperties;

    Swift

    init(tooManyProperties: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “too_many_templates”.

    Description of the “too_many_templates” tag state: There are too many templates for the team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyTemplates;

    Swift

    init(tooManyTemplates: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “template_attribute_too_large”.

    Description of the “template_attribute_too_large” tag state: The template name, description or one or more of the property field keys is too large.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTemplateAttributeTooLarge;

    Swift

    init(templateAttributeTooLarge: ())

    Return Value

    An initialized instance.

Tag state methods

  • Retrieves whether the union’s current tag state has value “template_not_found”.

    Note

    Call this method and ensure it returns true before accessing the templateNotFound property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isTemplateNotFound;

    Swift

    func isTemplateNotFound() -> Bool

    Return Value

    Whether the union’s current tag state has value “template_not_found”.

  • Retrieves whether the union’s current tag state has value “restricted_content”.

    Declaration

    Objective-C

    - (BOOL)isRestrictedContent;

    Swift

    func isRestrictedContent() -> Bool

    Return Value

    Whether the union’s current tag state has value “restricted_content”.

  • Retrieves whether the union’s current tag state has value “other”.

    Declaration

    Objective-C

    - (BOOL)isOther;

    Swift

    func isOther() -> Bool

    Return Value

    Whether the union’s current tag state has value “other”.

  • Retrieves whether the union’s current tag state has value “conflicting_property_names”.

    Declaration

    Objective-C

    - (BOOL)isConflictingPropertyNames;

    Swift

    func isConflictingPropertyNames() -> Bool

    Return Value

    Whether the union’s current tag state has value “conflicting_property_names”.

  • Retrieves whether the union’s current tag state has value “too_many_properties”.

    Declaration

    Objective-C

    - (BOOL)isTooManyProperties;

    Swift

    func isTooManyProperties() -> Bool

    Return Value

    Whether the union’s current tag state has value “too_many_properties”.

  • Retrieves whether the union’s current tag state has value “too_many_templates”.

    Declaration

    Objective-C

    - (BOOL)isTooManyTemplates;

    Swift

    func isTooManyTemplates() -> Bool

    Return Value

    Whether the union’s current tag state has value “too_many_templates”.

  • Retrieves whether the union’s current tag state has value “template_attribute_too_large”.

    Declaration

    Objective-C

    - (BOOL)isTemplateAttributeTooLarge;

    Swift

    func isTemplateAttributeTooLarge() -> Bool

    Return Value

    Whether the union’s current tag state has value “template_attribute_too_large”.

  • Retrieves string value of union’s current tag state.

    Declaration

    Objective-C

    - (nonnull NSString *)tagName;

    Swift

    func tagName() -> String

    Return Value

    A human-readable string representing the union’s current tag state.