SCSMutableArticleQuery


@interface SCSMutableArticleQuery : SCSArticleQuery

An SCSMutableArticleQuery object is the mutable version of SCSArticleQuery. It manages the criteria to apply when fetching and searching knowledge articles. This query object stores the type of search, the search parameters, and any filters or constraints to apply when searching.

Use this object with -[SCSKnowledgeManager fetchArticlesWithQuery:completion:] to download articles that match your query. To access already downloaded articles matching your query, call -[SCSKnowledgeManager articlesMatchingQuery:completion:].

  • Undocumented

    Declaration

    Objective-C

    @property (nullable, nonatomic, copy) NSString *articleId

    Swift

    var articleId: String? { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nullable, nonatomic, copy) NSArray<SCSCategory*> *categories

    Swift

    var categories: [SCSCategory]? { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) SCQueryMethod queryMethod

    Swift

    var queryMethod: SCQueryMethod { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nullable, nonatomic, copy) NSString *searchTerm

    Swift

    var searchTerm: String? { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) NSUInteger pageSize

    Swift

    var pageSize: UInt { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) NSUInteger pageNumber

    Swift

    var pageNumber: UInt { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) SCArticleSortOrder sortOrder

    Swift

    var sortOrder: SCArticleSortOrder { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) SCArticleSortByField sortByField

    Swift

    var sortByField: SCArticleSortByField { get set }