Package zendesk.support.guide
Class HelpCenterConfiguration
- java.lang.Object
-
- zendesk.support.guide.HelpCenterConfiguration
-
public class HelpCenterConfiguration extends java.lang.Object
Data class, that represents the initial configuration ofHelpCenterActivity
. Use theHelpCenterConfiguration.Builder
to create an instance.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
HelpCenterConfiguration.Builder
This builder is used to generate the startup configuration for the Activity.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description java.util.List<java.lang.Long>
getCategoryIds()
java.util.List<Configuration>
getConfigurations()
java.util.List<Engine>
getEngines()
Returns the list ofEngine
s that was set onHelpCenterConfiguration.Builder.withEngines(Engine...)
.java.lang.String[]
getLabelNames()
java.util.List<java.lang.Long>
getSectionIds()
boolean
isCollapseCategories()
boolean
isContactUsButtonVisible()
boolean
isShowConversationsMenuButton()
-
-
-
Method Detail
-
getCategoryIds
public java.util.List<java.lang.Long> getCategoryIds()
-
getSectionIds
public java.util.List<java.lang.Long> getSectionIds()
-
getLabelNames
public java.lang.String[] getLabelNames()
-
getEngines
public java.util.List<Engine> getEngines()
Returns the list ofEngine
s that was set onHelpCenterConfiguration.Builder.withEngines(Engine...)
. This method should not be called more than once, as retrieving the Engine list removes it from the internal storage. As such, every subsequent call to this method will return null. Note also that theHelpCenterConfiguration.Builder
starts with an empty list rather than null.- Returns:
- a List of
Engine
, or null.
-
isContactUsButtonVisible
public boolean isContactUsButtonVisible()
-
isCollapseCategories
public boolean isCollapseCategories()
-
isShowConversationsMenuButton
public boolean isShowConversationsMenuButton()
-
getConfigurations
public java.util.List<Configuration> getConfigurations()
-
-