SCSCategoryGroup


@interface SCSCategoryGroup : NSObject

A SCSCategoryGroup represents a data category group. A category group contains a hierarchical tree of data categories.

Refer to SCSCategory for a representation of data categories.

  • Unique category group name.

    Declaration

    Objective-C

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

    Swift

    var name: String { get }

  • Label, or display name, for this category group.

    Declaration

    Objective-C

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

    Swift

    var label: String { get }

  • String describing which types of objects this category group can be used for.

    Declaration

    Objective-C

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

    Swift

    var objectUsage: String { get }

  • Array of root-level child categories within this category group.

    See

    SCSCategory

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<SCSCategory *> *_Nonnull childCategories;

    Swift

    var childCategories: [SCSCategory] { get }

  • The knowledge manager this category group belongs to. If this value becomes nil, the article instance should be considered invalid and should be removed or released.

    Declaration

    Objective-C

    @property (nonatomic, weak, readonly) SCSKnowledgeManager *_Nullable manager;

    Swift

    weak var manager: SCSKnowledgeManager? { get }

  • Returns a category within this category group that matches the specified name.

    See

    -[SCSCategory categoryWithName:]

    Declaration

    Objective-C

    - (nullable SCSCategory *)categoryWithName:(nonnull NSString *)name;

    Swift

    func category(withName name: String) -> SCSCategory?

    Parameters

    name

    Category name.

    Return Value

    SCSCategory instance matching the specified category name, or nil if no child category is found.

  • Returns a string suitable for debugging that displays the contents of the category group tree.

    Declaration

    Objective-C

    @property (copy, readonly) NSString *_Nonnull debugDescription;

    Swift

    var debugDescription: String { get }