SCSKnowledgeHomeViewController

@interface SCSKnowledgeHomeViewController : UIViewController

View controller that implements the built-in Support Home experience. This class is not meant to be used when using SCServiceInterface.

  • The parent category this view controller is showing.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic) SCSCategory *_Nonnull parentCategory;

    Swift

    var parentCategory: SCSCategory { get }

  • The currently expanded section index set. Changes from the user will cause KVO events on this property to fire.

    The expanded index values represent the childCategory objects within the parentCategory object.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, null_resettable)
    NSIndexSet *expandedIndexes;

    Swift

    var expandedIndexes: IndexSet! { get set }

  • Delegate property to use to interact with the knowledge home view controller.

    Declaration

    Objective-C

    @property (readwrite, nonatomic, nullable)
    NSObject<SCSKnowledgeHomeViewControllerDelegate> *delegate;

    Swift

    weak var delegate: SCSKnowledgeHomeViewControllerDelegate? { get set }

  • Indicates whether or not searching is allowed within this controller.

    Declaration

    Objective-C

    @property (getter=isSearchEnabled, assign, readwrite, nonatomic)
    BOOL searchEnabled;

    Swift

    var isSearchEnabled: Bool { get set }

  • Template to use when composing a search to show per-article. This template object is used for each category within the knowledge home view controller as the basis to find the top articles.

    Note

    The categories property is overwritten with the appropriate category being displayed. Furthermore, it is advisable to avoid setting the articleId or searchTerm properties, as these may produce unexpected results.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, null_resettable)
    SCSArticleQuery *articleQueryTemplate;

    Swift

    @NSCopying var articleQueryTemplate: SCSArticleQuery! { get set }

  • Designated initializer

    Declaration

    Objective-C

    - (nonnull instancetype)initWithParentCategory:
    (nonnull SCSCategory *)parentCategory;

    Swift

    init(parentCategory: SCSCategory)

    Parameters

    parentCategory

    Parent category to use when displaying the interface.

    Return Value

    View controller