DBFILEPROPERTIESAddPropertiesError

Objective-C

@interface DBFILEPROPERTIESAddPropertiesError
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILEPROPERTIESAddPropertiesError : NSObject, DBSerializable, NSCopying

The AddPropertiesError 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) DBFILEPROPERTIESAddPropertiesErrorTag tag;

    Swift

    var tag: DBFILEPROPERTIESAddPropertiesErrorTag { 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 }

  • (no description). - note: Ensure the isPath method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILEPROPERTIESLookupError *_Nonnull path;

    Swift

    var path: DBFILEPROPERTIESLookupError { 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 “path”.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:
    (nonnull DBFILEPROPERTIESLookupError *)path;

    Swift

    init(path: DBFILEPROPERTIESLookupError)

    Parameters

    path

    (no description).

    Return Value

    An initialized instance.

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

    Description of the “unsupported_folder” tag state: This folder cannot be tagged. Tagging folders is not supported for team-owned templates.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnsupportedFolder;

    Swift

    init(unsupportedFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “property_field_too_large” tag state: One or more of the supplied property field values is too large.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPropertyFieldTooLarge;

    Swift

    init(propertyFieldTooLarge: ())

    Return Value

    An initialized instance.

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

    Description of the “does_not_fit_template” tag state: One or more of the supplied property fields does not conform to the template specifications.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDoesNotFitTemplate;

    Swift

    init(doesNotFitTemplate: ())

    Return Value

    An initialized instance.

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

    Description of the “duplicate_property_groups” tag state: There are 2 or more property groups referring to the same templates in the input.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDuplicatePropertyGroups;

    Swift

    init(duplicatePropertyGroups: ())

    Return Value

    An initialized instance.

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

    Description of the “property_group_already_exists” tag state: A property group associated with this template and file already exists.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPropertyGroupAlreadyExists;

    Swift

    init(propertyGroupAlreadyExists: ())

    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 “path”.

    Note

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

    Declaration

    Objective-C

    - (BOOL)isPath;

    Swift

    func isPath() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isUnsupportedFolder;

    Swift

    func isUnsupportedFolder() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isPropertyFieldTooLarge;

    Swift

    func isPropertyFieldTooLarge() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isDoesNotFitTemplate;

    Swift

    func isDoesNotFitTemplate() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isDuplicatePropertyGroups;

    Swift

    func isDuplicatePropertyGroups() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isPropertyGroupAlreadyExists;

    Swift

    func isPropertyGroupAlreadyExists() -> Bool

    Return Value

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

  • 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.