| java.lang.Object | |
| ↳ | com.salesforce.android.knowledge.core.KnowledgeCore |
Class Overview
Initialization API for Knowledge.
The KnowledgeCore class is a builder for a KnowledgeClient instance. A KnowledgeClient
instance lets you read Knowledge data by submitting requests and handling results.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static void |
clearCacheForUser(Context context, AuthenticatedUser authenticatedUser)
Clears all items from the offline article cache for a specified user.
| ||||||||||
| static KnowledgeCore |
configure(KnowledgeConfiguration configuration)
Configure the Knowledge Core instance with a
KnowledgeConfiguration object. | ||||||||||
| Async<KnowledgeClient> |
createClient(Context context)
Create a new
KnowledgeClient instance which may be used to interact with Salesforce Knowledge. | ||||||||||
| static void |
deleteCache(Context context)
Deletes the offline article cache.
| ||||||||||
| static void |
deleteCacheForUser(Context context, AuthenticatedUser authenticatedUser)
Deletes the offline article cache for the specified user.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Methods
public static void clearCacheForUser (Context context, AuthenticatedUser authenticatedUser)
Clears all items from the offline article cache for a specified user.
Parameters
| context | A context instance with which to create the client. |
|---|---|
| authenticatedUser | An AuthenticatedUser uniquely identifying a user account which should have it's database cleared. Null for an unauthenticated user. |
public static KnowledgeCore configure (KnowledgeConfiguration configuration)
Configure the Knowledge Core instance with a KnowledgeConfiguration object.
Parameters
| configuration | A KnowledgeConfiguration instance. |
|---|
Returns
- A
KnowledgeCoreinstance for syntax chaining.
public Async<KnowledgeClient> createClient (Context context)
Create a new KnowledgeClient instance which may be used to interact with Salesforce Knowledge.
Parameters
| context | A Context instance with which to create the client. |
|---|
Returns
- An
Asyncinstance that will asynchronously provide aKnowledgeClientresult.
public static void deleteCache (Context context)
Deletes the offline article cache. Note, this will remove all offline data for all users.
Parameters
| context | A context instance with which to create the client. |
|---|
public static void deleteCacheForUser (Context context, AuthenticatedUser authenticatedUser)
Deletes the offline article cache for the specified user.
Parameters
| context | A context instance with which to create the client. |
|---|---|
| authenticatedUser | An AuthenticatedUser uniquely identifying a user account which should have it's database deleted. Null for an unauthenticated user.
|