public class

KnowledgeUIConfiguration

extends Object
java.lang.Object
   ↳ com.salesforce.android.knowledge.ui.KnowledgeUIConfiguration

Class Overview

Configuration class used in the creation of a KnowledgeUIClient instance via KnowledgeUI.

See Also

Summary

Public Methods
static KnowledgeUIConfiguration create(KnowledgeConfiguration knowledgeConfiguration, String dataCategoryGroupName, String rootDataCategory)
Create a new Knowledge UI Configuration instance by providing a KnowledgeConfiguration instance and a Root Data Category.
KnowledgeConfiguration getCoreConfiguration()
KnowledgeCssProvider getCssProvider()
Retrieve the KnowledgeCssProvider instance, if any, that is used to provide CSS to Knowledge articles.
String getDataCategoryGroupName()
Retrieve the name of the DataCategoryGroup that is being browsed by this instance of Knowledge UI.
KnowledgeImageProvider getImageProvider()
Retrieve the KnowledgeImageProvider instance, if any, that is used to provide hero images to Knowledge UI for categories and articles.
KnowledgeJsProvider getJsProvider()
Retrieve the KnowledgeJsProvider instance, if any, that is used to provide JavaScript to Knowledge articles.
String getRootDataCategory()
Retrieve the root data category that is used as the top-level category when viewing SCENE_HOME.
KnowledgeUIConfiguration setCssProvider(KnowledgeCssProvider cssProvider)
Provide an optional KnowledgeCssProvider instance for loading custom CSS into Knowledge articles as they are displayed to the user.
KnowledgeUIConfiguration setImageProvider(KnowledgeImageProvider imageProvider)
Provide an optional KnowledgeImageProvider instance for loading custom images into the Knowledge UI.
KnowledgeUIConfiguration setJsProvider(KnowledgeJsProvider jsProvider)
Provide an optional KnowledgeJsProvider instance for loading custom JavaScript into Knowledge articles as they are displayed to the user.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static KnowledgeUIConfiguration create (KnowledgeConfiguration knowledgeConfiguration, String dataCategoryGroupName, String rootDataCategory)

Create a new Knowledge UI Configuration instance by providing a KnowledgeConfiguration instance and a Root Data Category.

Parameters
knowledgeConfiguration A KnowledgeConfiguration instance.
dataCategoryGroupName The data category group in which the root data category resides.
rootDataCategory The Root Data Category that will populate the Home screen.
Returns

public KnowledgeConfiguration getCoreConfiguration ()

public KnowledgeCssProvider getCssProvider ()

Retrieve the KnowledgeCssProvider instance, if any, that is used to provide CSS to Knowledge articles.

Returns

public String getDataCategoryGroupName ()

Retrieve the name of the DataCategoryGroup that is being browsed by this instance of Knowledge UI.

Returns
  • The name of the data category group.

public KnowledgeImageProvider getImageProvider ()

Retrieve the KnowledgeImageProvider instance, if any, that is used to provide hero images to Knowledge UI for categories and articles.

Returns
  • The image provider, or null if none was provided.

public KnowledgeJsProvider getJsProvider ()

Retrieve the KnowledgeJsProvider instance, if any, that is used to provide JavaScript to Knowledge articles.

Returns

public String getRootDataCategory ()

Retrieve the root data category that is used as the top-level category when viewing SCENE_HOME. The immediate children of this category are shown when Knowledge UI is launched to the home scene.

Returns
  • The top-level category to use when browsing Knowledge UI.

public KnowledgeUIConfiguration setCssProvider (KnowledgeCssProvider cssProvider)

Provide an optional KnowledgeCssProvider instance for loading custom CSS into Knowledge articles as they are displayed to the user.

Parameters
cssProvider A KnowledgeCssProvider instance.
Returns

public KnowledgeUIConfiguration setImageProvider (KnowledgeImageProvider imageProvider)

Provide an optional KnowledgeImageProvider instance for loading custom images into the Knowledge UI.

Parameters
imageProvider An KnowledgeImageProvider instance.
Returns

public KnowledgeUIConfiguration setJsProvider (KnowledgeJsProvider jsProvider)

Provide an optional KnowledgeJsProvider instance for loading custom JavaScript into Knowledge articles as they are displayed to the user.

Parameters
jsProvider A KnowledgeJsProvider instance.
Returns