public class

KnowledgeUI

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

Class Overview

Entry point for initializing a KnowledgeUIClient and launching the Knowledge UI.

Calling createClient(Context) will begin the process of initializing a KnowledgeUIClient. Once the client has been returned, you may use it to launchHome(Activity) and interact with Knowledge UI.

Summary

Public Methods
static KnowledgeUI configure(KnowledgeUIConfiguration configuration)
Configure the Knowledge UI instance with a KnowledgeUIConfiguration object.
Async<KnowledgeUIClient> createClient(Context context)
Create a KnowledgeUIClient based on your configuration.
KnowledgeUI viewAddition(KnowledgeViewAddition viewAddition)
Add an addition to the Knowledge UI that will be overlaid above one or more KnowledgeScene within Knowledge UI.
KnowledgeUI withCoreClient(KnowledgeClient coreClient)
Provide an optional KnowledgeClient instance with which to configure a KnowledgeUIClient.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static KnowledgeUI configure (KnowledgeUIConfiguration configuration)

Configure the Knowledge UI instance with a KnowledgeUIConfiguration object.

Parameters
configuration A KnowledgeUIConfiguration instance.
Returns
  • This instance for fluent API calls.

public Async<KnowledgeUIClient> createClient (Context context)

Create a KnowledgeUIClient based on your configuration.

Parameters
context A Context instance with which to create the client.
Returns

public KnowledgeUI viewAddition (KnowledgeViewAddition viewAddition)

Add an addition to the Knowledge UI that will be overlaid above one or more KnowledgeScene within Knowledge UI. This method may be invoked multiple times to add multiple KnowledgeViewAddition instances.

Parameters
viewAddition The KnowledgeViewAddition to add.
Returns
  • This instance for fluent API calls.

public KnowledgeUI withCoreClient (KnowledgeClient coreClient)

Provide an optional KnowledgeClient instance with which to configure a KnowledgeUIClient. If you do not provide a KnowledgeClient then one will be created for you based on the configuration passed to configure(KnowledgeUIConfiguration).

Parameters
coreClient A KnowledgeClient instance
Returns
  • This instance for fluent API calls.