public class

DataCategoriesRequest

extends KnowledgeRequest
java.lang.Object
   ↳ com.salesforce.android.service.common.fetchsave.requests.FetchSaveRequest
     ↳ com.salesforce.android.knowledge.core.requests.KnowledgeRequest
       ↳ com.salesforce.android.knowledge.core.requests.DataCategoriesRequest

Class Overview

Request that is made to retrieve DataCategories. Submitting this request will return a DataCategoryList instance.

Instances of this class can be submitted to a KnowledgeClient instance, which will service the request from the offline cache or the online Salesforce Knowledge Base (or both) as appropriate.

Summary

Nested Classes
class DataCategoriesRequest.Builder Builder for the DataCategoriesRequest class. 
Public Methods
static DataCategoriesRequest.Builder builder(String dataCategoryGroup, String rootDataCategory)
Instantiate a DataCategoriesRequest.Builder for constructing DataCategoriesRequest instances.
String getDataCategoryGroup()
Retrieve the API name of the data category group in which to retrieve categories.
String getRootDataCategory()
Retrieve the API name of the data category of which the direct child sub-categories should be retrieved.
[Expand]
Inherited Methods
From class com.salesforce.android.service.common.fetchsave.requests.FetchSaveRequest
From class java.lang.Object

Public Methods

public static DataCategoriesRequest.Builder builder (String dataCategoryGroup, String rootDataCategory)

Instantiate a DataCategoriesRequest.Builder for constructing DataCategoriesRequest instances.

Parameters
dataCategoryGroup The API name of the data category group in which to retrieve categories.
rootDataCategory The API name of the data category of which the direct child sub-categories should be retrieved.
Returns

public String getDataCategoryGroup ()

Retrieve the API name of the data category group in which to retrieve categories.

Returns
  • The data category group API name.

public String getRootDataCategory ()

Retrieve the API name of the data category of which the direct child sub-categories should be retrieved.

Returns
  • The root category API name.