| java.lang.Object | |||
| ↳ | com.salesforce.android.service.common.fetchsave.requests.FetchSaveRequest | ||
| ↳ | com.salesforce.android.knowledge.core.requests.KnowledgeRequest | ||
| ↳ | com.salesforce.android.knowledge.core.requests.ArticleDetailRequest | ||
Class Overview
Request object for fetching the detailed content for an article. Submitting this request will
return an ArticleDetails 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 | ArticleDetailRequest.Builder | Builder class for an ArticleDetailRequest. |
|||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static ArticleDetailRequest.Builder |
builder(String articleIdOrUrlName)
Instantiate a builder for this request.
| ||||||||||
| static ArticleDetailRequest.Builder |
builder(ArticleSummary articleSummary)
Instantiate a builder for this request.
| ||||||||||
| boolean |
cacheImages()
Check whether images should be parsed from the article details, downloaded, and cached to disk.
| ||||||||||
| String |
getArticleId()
Retrieve the ID of the article for which this request is fetching the detailed content.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.salesforce.android.service.common.fetchsave.requests.FetchSaveRequest
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Methods
public static ArticleDetailRequest.Builder builder (String articleIdOrUrlName)
Instantiate a builder for this request.
Parameters
| articleIdOrUrlName | The ID or UrlName of the article for which to retrieve details. |
|---|
Returns
- A builder that can be used to further configure the request.
public static ArticleDetailRequest.Builder builder (ArticleSummary articleSummary)
Instantiate a builder for this request.
Parameters
| articleSummary | The summary of the article for which to retrieve details. |
|---|
Returns
- A builder that can be used to further configure the request.
public boolean cacheImages ()
Check whether images should be parsed from the article details, downloaded, and cached to disk.
This flag will be ignored if offline resource caching is disabled globally for the
KnowledgeClient.
Returns
- True if the images should be cached.
See Also
public String getArticleId ()
Retrieve the ID of the article for which this request is fetching the detailed content.
Returns
- The article ID.