SCSServiceConfiguration

@interface SCSServiceConfiguration : NSObject

Class used to specify Service Cloud configuration settings.

Pass an instance of this class to the SCServiceCloud.serviceConfiguration property on the SCServiceCloud shared instance to set the configuration.

  • The URL of the community that hosts the public knowledge base to be exposed.

    See

    -initWithCommunity:

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSURL *_Nonnull communityURL;

    Swift

    var communityURL: URL { get }

  • Creates a service configuration with the given communityURL.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCommunity:(nonnull NSURL *)communityURL;

    Swift

    init(community communityURL: URL)

    Parameters

    communityURL

    URL of the community which hosts the public knowledge base.

ChatCore

KnowledgeCore

  • The unique name of the data category group to use when communicating with Service Cloud.

    See

    rootDataCategory

    See

    -initWithCommunity:dataCategoryGroup:rootDataCategory:

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *dataCategoryGroup;

    Swift

    var dataCategoryGroup: String? { get }

  • The data category to use as the root when displaying knowledge articles.

    See

    dataCategoryGroup

    See

    -initWithCommunity:dataCategoryGroup:rootDataCategory:

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *rootDataCategory;

    Swift

    var rootDataCategory: String? { get }

  • Sets the override language to be used when loading articles. For unauthenticated users, this value is used to override the language value on the device. For unauthenticated users, this value is used to override the device language if the device language is not one of the supported languages on the server.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *language;

    Swift

    var language: String? { get set }

  • The path pointing to the folder where the images in Data Category Header View, Article Header View, and Article Cell are rendered from. This can be an absolute path or relative path to the application bundle.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *imageFolderPath;

    Swift

    var imageFolderPath: String? { get set }

  • Specifies the sort by field to be used to sort while displaying articles in Support home and Data Category Detail and article list screen.

    Declaration

    Objective-C

    @property (nonatomic) SCArticleSortByField articleSortByField;

    Swift

    var articleSortByField: SCArticleSortByField { get set }

  • Specifies the sort order (ascending or descending) to be used to sort while displaying articles in Support home and Data Category Detail and article list screen.

    Declaration

    Objective-C

    @property (nonatomic) SCArticleSortOrder articleSortOrder;

    Swift

    var articleSortOrder: SCArticleSortOrder { get set }

  • Creates a service configuration with the given communityURL, data category group, and root data category.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCommunity:(nonnull NSURL *)communityURL
                        dataCategoryGroup:(nonnull NSString *)dataCategoryGroup
                         rootDataCategory:(nonnull NSString *)rootDataCategory;

    Swift

    init(community communityURL: URL, dataCategoryGroup: String, rootDataCategory: String)

    Parameters

    communityURL

    URL of the community which hosts the public knowledge base.
    dataCategoryGroup

    Data category group name.
    rootDataCategory

    Root data category name.