SCSServiceConfiguration Class Reference

Inherits from NSObject
Declared in SCSServiceConfiguration.h

Overview

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.

Other Methods

  communityURL

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

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

Declared In

SCSServiceConfiguration.h

– initWithCommunity:

Creates a service configuration with the given communityURL.

- (instancetype)initWithCommunity:(NSURL *)communityURL

Parameters

communityURL

URL of the community which hosts the public knowledge base.

Declared In

SCSServiceConfiguration.h

ChatCore Methods

  chatConfiguration

Represents the chat session configuration.

@property (nonatomic, copy) SCSChatConfiguration *chatConfiguration

Declared In

SCSServiceConfiguration+ChatCore.h

KnowledgeCore Methods

  dataCategoryGroup

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

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

Declared In

SCSServiceConfiguration+KnowledgeCore.h

  rootDataCategory

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

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

Declared In

SCSServiceConfiguration+KnowledgeCore.h

  language

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

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

Declared In

SCSServiceConfiguration+KnowledgeCore.h

  imageFolderPath

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.

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

Declared In

SCSServiceConfiguration+KnowledgeCore.h

  articleSortByField

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

@property (nonatomic) SCArticleSortByField articleSortByField

Declared In

SCSServiceConfiguration+KnowledgeCore.h

  articleSortOrder

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.

@property (nonatomic) SCArticleSortOrder articleSortOrder

Declared In

SCSServiceConfiguration+KnowledgeCore.h

– initWithCommunity:dataCategoryGroup:rootDataCategory:

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

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

Parameters

communityURL

URL of the community which hosts the public knowledge base.

dataCategoryGroup

Data category group name.

rootDataCategory

Root data category name.

Declared In

SCSServiceConfiguration+KnowledgeCore.h