Package com.zendesk.sdk.model.helpcenter

Class ArticlesListResponse

java.lang.Object

com.zendesk.sdk.model.helpcenter.ArticlesListResponse

All Implemented Interfaces:

ArticlesResponse

public class ArticlesListResponse
extends java.lang.Object
implements ArticlesResponse

This is a class model for a response for requesting articles. This object will be created by HelpCenterProvider

See Also:

Help Center REST APIs

Constructor Summary

Constructors

Constructor and Description
ArticlesListResponse()

Method Summary

Modifier and Type	Method and Description
java.util.List<Article>	getArticles() Gets a list of the Article returned as a result of HelpCenterService.searchArticles(String, String, String, String, String, String, String, Integer, Integer)
java.util.List<Category>	getCategories() Gets a list of Category returned as a result of specifying
java.lang.String	getNextPage() Gets the URL of the next page of results
java.lang.String	getPreviousPage() Gets the URL of the previous page of results
java.util.List<Section>	getSections() Gets a list of Section returned as a result of specifying
java.util.List<User>	getUsers() Gets a list of User returned as a result of specifying

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArticlesListResponse

public ArticlesListResponse()

Method Detail

getArticles

public java.util.List<Article> getArticles()

Description copied from interface: ArticlesResponse

Gets a list of the Article returned as a result of HelpCenterService.searchArticles(String, String, String, String, String, String, String, Integer, Integer)

Specified by:

getArticles in interface ArticlesResponse

Returns:

The list of articles. This will be an empty list if there were no results.

getCategories

public java.util.List<Category> getCategories()

Description copied from interface: ArticlesResponse

Gets a list of Category returned as a result of specifying

categories

as a part of a sideload operation when calling HelpCenterService.searchArticles(String, String, String, String, String, String, String, Integer, Integer) or HelpCenterService.listArticles(String, String, String, String, String, String, Integer, Integer)

Specified by:

getCategories in interface ArticlesResponse

Returns:

The list of categories. This will be an empty list if there were no results or if categories were not side-loaded.

getSections

public java.util.List<Section> getSections()

Description copied from interface: ArticlesResponse

Gets a list of Section returned as a result of specifying

sections

as a part of a sideload operation when calling HelpCenterService.searchArticles(String, String, String, String, String, String, String, Integer, Integer) or HelpCenterService.listArticles(String, String, String, String, String, String, Integer, Integer)

Specified by:

getSections in interface ArticlesResponse

Returns:

The list of sections. This will be an empty list if there were no results or if sections were not side-loaded.

getUsers

public java.util.List<User> getUsers()

Description copied from interface: ArticlesResponse

Gets a list of User returned as a result of specifying

users

as a part of a sideload operation when calling HelpCenterService.searchArticles(String, String, String, String, String, String, String, Integer, Integer) or HelpCenterService.listArticles(String, String, String, String, String, String, Integer, Integer)

Specified by:

getUsers in interface ArticlesResponse

Returns:

The list of users. This will be an empty list if there were no results or if users were not side-loaded.

getNextPage

public java.lang.String getNextPage()

Gets the URL of the next page of results

If this method returns null it means there is no next page for the given parameters specified in a HelpCenterSearch

Returns:

The URL of the next page or null if there is no next page

See Also:

Pagination

getPreviousPage

public java.lang.String getPreviousPage()

Gets the URL of the previous page of results

If this method returns null it means you are on the first page.

Returns:

The URL of the previous page of results or null if this is the first page

See Also:

Pagination