Package com.zendesk.sdk.model.helpcenter.help

Interface HelpItem

All Known Implementing Classes:

ArticleItem, CategoryItem, SectionItem, SeeAllArticlesItem

public interface HelpItem

Model representing items in the HelpCenter UI.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_ARTICLE
static int	TYPE_CATEGORY
static int	TYPE_LOADING
static int	TYPE_NO_RESULTS
static int	TYPE_PADDING
static int	TYPE_SECTION
static int	TYPE_SEE_ALL

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends HelpItem>	getChildren() Gets the list of children that this item has.
java.lang.Long	getId() Gets the ID of this item.
java.lang.String	getName() Gets the name of the item
java.lang.Long	getParentId() Returns the ID of the parent item.
int	getViewType() Gets the type of the item

Field Detail

TYPE_CATEGORY

static final int TYPE_CATEGORY

See Also:

Constant Field Values

TYPE_SECTION

static final int TYPE_SECTION

See Also:

Constant Field Values

TYPE_ARTICLE

static final int TYPE_ARTICLE

See Also:

Constant Field Values

TYPE_SEE_ALL

static final int TYPE_SEE_ALL

See Also:

Constant Field Values

TYPE_LOADING

static final int TYPE_LOADING

See Also:

Constant Field Values

TYPE_NO_RESULTS

static final int TYPE_NO_RESULTS

See Also:

Constant Field Values

TYPE_PADDING

static final int TYPE_PADDING

See Also:

Constant Field Values

Method Detail

getViewType

int getViewType()

Gets the type of the item

Returns:

the type of the item

getName

java.lang.String getName()

Gets the name of the item

Returns:

the name of the item, or an empty String if there is no name.

getId

java.lang.Long getId()

Gets the ID of this item.

Returns:

The ID of this item, or null if there is none.

getParentId

java.lang.Long getParentId()

Returns the ID of the parent item.

Returns:

the ID of the parent item, or null if there is none.

getChildren

java.util.List<? extends HelpItem> getChildren()

Gets the list of children that this item has.

Returns:

the list of children that this item has. May be empty if there are no children, or if the item type does not permit children.