Package org.freeplane.api.ai

Enum Class AiRequestMode

java.lang.Object

java.lang.Enum<AiRequestMode>

org.freeplane.api.ai.AiRequestMode

All Implemented Interfaces:

Serializable, Comparable<AiRequestMode>, Constable

public enum AiRequestMode
extends Enum<AiRequestMode>

User-interface visibility for an AI request.

Since:

1.13.3

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADD_TO_CHAT	Add the request to the selected chat when compatible, otherwise start a new visible script chat.
HIDDEN	Run hidden from chat history without showing a progress dialog.
HIDDEN_WITH_CANCEL_DIALOG	Run hidden from chat history and show a progress dialog with cancellation.
SHOW_IN_NEW_CHAT	Start a new visible chat tab/session for the request.

Method Summary

Modifier and Type	Method	Description
static AiRequestMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AiRequestMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SHOW_IN_NEW_CHAT

public static final AiRequestMode SHOW_IN_NEW_CHAT

Start a new visible chat tab/session for the request.

ADD_TO_CHAT

public static final AiRequestMode ADD_TO_CHAT

Add the request to the selected chat when compatible, otherwise start a new visible script chat.

HIDDEN_WITH_CANCEL_DIALOG

public static final AiRequestMode HIDDEN_WITH_CANCEL_DIALOG

Run hidden from chat history and show a progress dialog with cancellation.

HIDDEN

public static final AiRequestMode HIDDEN

Run hidden from chat history without showing a progress dialog.

Method Details

values

public static AiRequestMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AiRequestMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null