DBFILEPROPERTIESRemovePropertiesError

Objective-C

@interface DBFILEPROPERTIESRemovePropertiesError
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILEPROPERTIESRemovePropertiesError : NSObject, DBSerializable, NSCopying

The RemovePropertiesError 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) DBFILEPROPERTIESRemovePropertiesErrorTag tag;

Swift

var tag: DBFILEPROPERTIESRemovePropertiesErrorTag { get }

templateNotFound
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 }
path
(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 }
propertyGroupLookup
(no description). - note: Ensure the isPropertyGroupLookup method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBFILEPROPERTIESLookUpPropertiesError *_Nonnull propertyGroupLookup;
Swift

var propertyGroupLookup: DBFILEPROPERTIESLookUpPropertiesError { get }

Constructors


                    
                    
                    -initWithTemplateNotFound:

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.

-initWithRestrictedContent
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.
-initWithOther
Initializes union class with tag state of “other”.
Declaration
Objective-C

- (nonnull instancetype)initWithOther;
Swift

init(other: ())
Return Value

An initialized instance.


                    
                    
                    -initWithPath:

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.

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


                    
                    
                    -initWithPropertyGroupLookup:

Initializes union class with tag state of “property_group_lookup”.

Declaration

Objective-C

- (nonnull instancetype)initWithPropertyGroupLookup:
    (nonnull DBFILEPROPERTIESLookUpPropertiesError *)propertyGroupLookup;

Swift

init(propertyGroupLookup: DBFILEPROPERTIESLookUpPropertiesError)

Parameters


                                propertyGroupLookup

(no description).

Return Value

An initialized instance.

Tag state methods

-isTemplateNotFound
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”.
-isRestrictedContent
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”.
-isOther
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”.
-isPath
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”.
-isUnsupportedFolder
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”.
-isPropertyGroupLookup
Retrieves whether the union’s current tag state has value “property_group_lookup”.

Note

Call this method and ensure it returns true before accessing the propertyGroupLookup property, otherwise a runtime exception will be thrown.
Declaration
Objective-C

- (BOOL)isPropertyGroupLookup;
Swift

func isPropertyGroupLookup() -> Bool
Return Value

Whether the union’s current tag state has value “property_group_lookup”.
-tagName
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.