Package com.zendesk.sdk.model.helpcenter

Interface ArticlesResponse

All Known Implementing Classes:

ArticlesListResponse, ArticlesSearchResponse

public interface ArticlesResponse

Defines the behaviour of a articles response from Help Center.

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

Method Detail

getArticles

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)

Returns:

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

getCategories

java.util.List<Category> getCategories()

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)

Returns:

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

getSections

java.util.List<Section> getSections()

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)

Returns:

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

getUsers

java.util.List<User> getUsers()

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)

Returns:

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