DBFILEPROPERTIESTemplateError

@interface DBFILEPROPERTIESTemplateError : NSObject <DBSerializable, NSCopying>

The TemplateError union.

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

  • tag

    Represents the union’s current tag state.

    Declaration

    Objective-C

    @property (readonly, nonatomic) DBFILEPROPERTIESTemplateErrorTag tag;

    Swift

    var tag: DBFILEPROPERTIESTemplateErrorTag { 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 (readonly, copy, nonatomic) NSString *_Nonnull templateNotFound;

    Swift

    var templateNotFound: String { get }
  • 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.

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