Package zendesk.answerbot

Enum AnswerBot

java.lang.Object

java.lang.Enum<AnswerBot>

zendesk.answerbot.AnswerBot

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AnswerBot>

public enum AnswerBot
extends java.lang.Enum<AnswerBot>

Use this class to setup AnswerBot initialization. Call this first to configure AnswerBot to use the correct Zendesk and Support instances.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
void	init(Zendesk zendesk, Guide guide) Initialises the Answer Bot SDK.
void	init(Zendesk zendesk, Support support) Deprecated. Please use AnswerBot.init(Zendesk, Guide) instead. This will be removed in a future release.
AnswerBotProvider	provider() Returns an instance of AnswerBotProvider if Zendesk and AnswerBot have already been initialized, or null if they have not.
static AnswerBot	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AnswerBot[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final AnswerBot INSTANCE

Method Detail

values

public static AnswerBot[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AnswerBot c : AnswerBot.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AnswerBot valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

init

@Deprecated
public void init(Zendesk zendesk,
                 Support support)

Deprecated. Please use AnswerBot.init(Zendesk, Guide) instead. This will be removed in a future release.

Initialises the Answer Bot SDK. Use this method when you have enabled the Answer Bot feature in the Zendesk Answer Bot admin page.

Parameters:

zendesk - The instance of Zendesk to initialize AnswerBot with

support - The instance of Support to initialize AnswerBot with

init

public void init(Zendesk zendesk,
                 Guide guide)

Initialises the Answer Bot SDK. Use this method when you have enabled the Answer Bot feature in the Zendesk Answer Bot admin page.

Parameters:

zendesk - The instance of Zendesk to initialize AnswerBot with

guide - The instance of Guide to initialize AnswerBot with

provider

public AnswerBotProvider provider()

Returns an instance of AnswerBotProvider if Zendesk and AnswerBot have already been initialized, or null if they have not. AnswerBotProvider is the interface to the Answer Bot back-end. Use this if you want to build your own UI instead of presenting Answer Bot through the Zendesk Messaging SDK.

Returns:

an instance of AnswerBotProvider if Zendesk and AnswerBot have already been initialized, null otherwise.