DBFILEPROPERTIESTemplateFilter

Objective-C

@interface DBFILEPROPERTIESTemplateFilter : NSObject <DBSerializable, NSCopying>

Swift

class DBFILEPROPERTIESTemplateFilter : NSObject, DBSerializable, NSCopying

The TemplateFilter 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) DBFILEPROPERTIESTemplateFilterTag tag;

    Swift

    var tag: DBFILEPROPERTIESTemplateFilterTag { get }

  • Only templates with an ID in the supplied list will be returned (a subset of templates will be returned). - note: Ensure the isFilterSome method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSString *> *_Nonnull filterSome;

    Swift

    var filterSome: [String] { get }

Constructors

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

    Description of the “filter_some” tag state: Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFilterSome:
    (nonnull NSArray<NSString *> *)filterSome;

    Swift

    init(filterSome: [String])

    Parameters

    filterSome

    Only templates with an ID in the supplied list will be returned (a subset of templates will be returned).

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

    Description of the “filter_none” tag state: No templates will be filtered from the result (all templates will be returned).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFilterNone;

    Swift

    init(filterNone: ())

    Return Value

    An initialized instance.

Tag state methods

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isFilterSome;

    Swift

    func isFilterSome() -> Bool

    Return Value

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

  • 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 “filter_none”.

    Declaration

    Objective-C

    - (BOOL)isFilterNone;

    Swift

    func isFilterNone() -> Bool

    Return Value

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

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