public class

ArticleListRequest

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.ArticleListRequest

Class Overview

Request object for fetching lists of article summaries. Submitting this request will return an ArticleList 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 ArticleListRequest.Builder Builder class for the ArticleListRequest type. 
@interface ArticleListRequest.QueryMethod  
@interface ArticleListRequest.SortBy  
@interface ArticleListRequest.SortOrder  
Constants
int QUERY_ABOVE_OR_BELOW
int QUERY_BELOW Searching will retrieve any articles mapped to the given category or any of its descendant sub-categories.
int SORT_ASC Ascending sort (lowest value first).
int SORT_BY_LAST_PUBLISHED_DATE Sort using the last published date for the articles.
int SORT_BY_TITLE Sort using the article titles.
int SORT_BY_VIEW_SCORE Sort using the article view scores.
int SORT_DESC Descending sort (highest value first).
Public Methods
static ArticleListRequest.Builder builder()
String getDataCategoryGroupName()
Retrieve the data category group name, if any, to use for filtering the returned ArticleList.
String getDataCategoryName()
Retrieve the data category name, if any, to use for filtering the returned ArticleList.
int getId()
int getPageNumber()
Retrieve the page number to fetch for this request.
int getPageSize()
Retrieve the page size to fetch for this request.
int getQueryMethod()
Retrieve the search method for this request.
CharSequence getSearchTerm()
Retrieve the search term, if any, to use for filtering the returned ArticleList.
int getSortBy()
Retrieve the sort type for the returned ArticleList.
int getSortOrder()
Retrieve the sort order for the returned ArticleList.
[Expand]
Inherited Methods
From class com.salesforce.android.service.common.fetchsave.requests.FetchSaveRequest
From class java.lang.Object

Constants

public static final int QUERY_ABOVE_OR_BELOW

Constant Value: 2 (0x00000002)

public static final int QUERY_BELOW

Searching will retrieve any articles mapped to the given category or any of its descendant sub-categories.

Constant Value: 1 (0x00000001)

public static final int SORT_ASC

Ascending sort (lowest value first).

Constant Value: 1 (0x00000001)

public static final int SORT_BY_LAST_PUBLISHED_DATE

Sort using the last published date for the articles.

Constant Value: 1 (0x00000001)

public static final int SORT_BY_TITLE

Sort using the article titles.

Constant Value: 2 (0x00000002)

public static final int SORT_BY_VIEW_SCORE

Sort using the article view scores.

Constant Value: 3 (0x00000003)

public static final int SORT_DESC

Descending sort (highest value first).

Constant Value: 2 (0x00000002)

Public Methods

public static ArticleListRequest.Builder builder ()

public String getDataCategoryGroupName ()

Retrieve the data category group name, if any, to use for filtering the returned ArticleList.

Returns
  • The data category group name.

public String getDataCategoryName ()

Retrieve the data category name, if any, to use for filtering the returned ArticleList.

Returns
  • The data category name.

public int getId ()

public int getPageNumber ()

Retrieve the page number to fetch for this request. Note that page numbers are one-indexed.

Returns
  • The page number.

public int getPageSize ()

Retrieve the page size to fetch for this request. The returned ArticleList will contain a number of articles less than or equal to this value.

Returns
  • The page size.

public int getQueryMethod ()

Retrieve the search method for this request.

Returns
  • The search method.

public CharSequence getSearchTerm ()

Retrieve the search term, if any, to use for filtering the returned ArticleList.

Returns
  • The search term.

public int getSortBy ()

Retrieve the sort type for the returned ArticleList.

Returns
  • The sort type.

public int getSortOrder ()

Retrieve the sort order for the returned ArticleList.

Returns
  • The sort order.