An InactivityConversationCanceller will cancel a Conversation after a period of inactivity by the user. More...

Inheritance diagram for org.bukkit.conversations.InactivityConversationCanceller:

Collaboration diagram for org.bukkit.conversations.InactivityConversationCanceller:

Public Member Functions
	InactivityConversationCanceller (Plugin plugin, int timeoutSeconds)
	Creates an InactivityConversationCanceller.

void	setConversation (Conversation conversation)

boolean	cancelBasedOnInput (ConversationContext context, String input)

ConversationCanceller	clone ()

Public Member Functions inherited from org.bukkit.conversations.ConversationCanceller
void	setConversation (Conversation conversation)
	Sets the conversation this ConversationCanceller can optionally cancel.

boolean	cancelBasedOnInput (ConversationContext context, String input)
	Cancels a conversation based on user input/.

ConversationCanceller	clone ()
	Allows the ConversationFactory to duplicate this ConversationCanceller when creating a new Conversation.

Protected Member Functions
void	cancelling (Conversation conversation)
	Subclasses of InactivityConversationCanceller can override this method to take additional actions when the inactivity timer abandons the conversation.

Protected Attributes
Plugin	plugin

int	timeoutSeconds

Conversation	conversation

Detailed Description

An InactivityConversationCanceller will cancel a Conversation after a period of inactivity by the user.

Definition at line 9 of file InactivityConversationCanceller.java.

Constructor & Destructor Documentation

org.bukkit.conversations.InactivityConversationCanceller.InactivityConversationCanceller	(	Plugin	plugin,
		int	timeoutSeconds
	)

Creates an InactivityConversationCanceller.

Parameters

plugin	The owning plugin.
timeoutSeconds	The number of seconds of inactivity to wait.

Definition at line 20 of file InactivityConversationCanceller.java.

References org.bukkit.conversations.InactivityConversationCanceller.plugin, and org.bukkit.conversations.InactivityConversationCanceller.timeoutSeconds.

Referenced by org.bukkit.conversations.InactivityConversationCanceller.clone().

Member Function Documentation

boolean org.bukkit.conversations.InactivityConversationCanceller.cancelBasedOnInput	(	ConversationContext	context,
		String	input
	)

Definition at line 30 of file InactivityConversationCanceller.java.

void org.bukkit.conversations.InactivityConversationCanceller.cancelling ( Conversation conversation )

protected

Subclasses of InactivityConversationCanceller can override this method to take additional actions when the inactivity timer abandons the conversation.

Parameters

conversation The conversation being abandoned.

Definition at line 72 of file InactivityConversationCanceller.java.

ConversationCanceller org.bukkit.conversations.InactivityConversationCanceller.clone ( )

Definition at line 37 of file InactivityConversationCanceller.java.

References org.bukkit.conversations.InactivityConversationCanceller.InactivityConversationCanceller(), org.bukkit.conversations.InactivityConversationCanceller.plugin, and org.bukkit.conversations.InactivityConversationCanceller.timeoutSeconds.

void org.bukkit.conversations.InactivityConversationCanceller.setConversation ( Conversation conversation )

Definition at line 25 of file InactivityConversationCanceller.java.

References org.bukkit.conversations.InactivityConversationCanceller.conversation.