<divclass="inheritance"title="Inheritance Tree"><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html"title="class or interface in java.lang"class="external-link">java.lang.Object</a>
<dd><code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html"title="class or interface in java.lang"class="external-link">Cloneable</a></code>, <code><ahref="ConversationCanceller.html"title="interface in org.bukkit.conversations">ConversationCanceller</a></code></dd>
</dl>
<hr>
<divclass="type-signature"><spanclass="modifiers">public class </span><spanclass="element-name type-name-label">InactivityConversationCanceller</span>
<spanclass="extends-implements">extends <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html"title="class or interface in java.lang"class="external-link">Object</a>
implements <ahref="ConversationCanceller.html"title="interface in org.bukkit.conversations">ConversationCanceller</a></span></div>
<divclass="block">An InactivityConversationCanceller will cancel a <ahref="Conversation.html"title="class in org.bukkit.conversations"><code>Conversation</code></a> after
a period of inactivity by the user.</div>
</section>
<sectionclass="summary">
<ulclass="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<sectionclass="field-summary"id="field-summary">
<h2>Field Summary</h2>
<divclass="caption"><span>Fields</span></div>
<divclass="summary-table three-column-summary">
<divclass="table-header col-first">Modifier and Type</div>
<divclass="col-constructor-name even-row-color"><code><ahref="#%3Cinit%3E(org.bukkit.plugin.Plugin,int)"class="member-name-link">InactivityConversationCanceller</a><wbr>(<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="../plugin/Plugin.html"title="interface in org.bukkit.plugin">Plugin</a> plugin,
int timeoutSeconds)</code></div>
<divclass="col-last even-row-color">
<divclass="block">Creates an InactivityConversationCanceller.</div>
<divclass="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="#cancelBasedOnInput(org.bukkit.conversations.ConversationContext,java.lang.String)"class="member-name-link">cancelBasedOnInput</a><wbr>(<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="ConversationContext.html"title="class in org.bukkit.conversations">ConversationContext</a> context,
<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html"title="class or interface in java.lang"class="external-link">String</a> input)</code></div>
<divclass="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="#cancelling(org.bukkit.conversations.Conversation)"class="member-name-link">cancelling</a><wbr>(<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="Conversation.html"title="class in org.bukkit.conversations">Conversation</a> conversation)</code></div>
<divclass="block">Subclasses of InactivityConversationCanceller can override this method
to take additional actions when the inactivity timer abandons the
conversation.</div>
</div>
<divclass="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="ConversationCanceller.html"title="interface in org.bukkit.conversations">ConversationCanceller</a></code></div>
<divclass="block">Allows the <ahref="ConversationFactory.html"title="class in org.bukkit.conversations"><code>ConversationFactory</code></a> to duplicate this
ConversationCanceller when creating a new <ahref="Conversation.html"title="class in org.bukkit.conversations"><code>Conversation</code></a>.</div>
<divclass="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="#setConversation(org.bukkit.conversations.Conversation)"class="member-name-link">setConversation</a><wbr>(<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="Conversation.html"title="class in org.bukkit.conversations">Conversation</a> conversation)</code></div>
<divclass="block">Sets the conversation this ConversationCanceller can optionally cancel.</div>
</div>
</div>
</div>
</div>
<divclass="inherited-list">
<h3id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html"title="class or interface in java.lang"class="external-link">Object</a></h3>
<code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)"title="class or interface in java.lang"class="external-link">equals</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()"title="class or interface in java.lang"class="external-link">finalize</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()"title="class or interface in java.lang"class="external-link">getClass</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()"title="class or interface in java.lang"class="external-link">hashCode</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()"title="class or interface in java.lang"class="external-link">notify</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()"title="class or interface in java.lang"class="external-link">notifyAll</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()"title="class or interface in java.lang"class="external-link">toString</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()"title="class or interface in java.lang"class="external-link">wait</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)"title="class or interface in java.lang"class="external-link">wait</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)"title="class or interface in java.lang"class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<sectionclass="details">
<ulclass="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<sectionclass="field-details"id="field-detail">
<h2>Field Details</h2>
<ulclass="member-list">
<li>
<sectionclass="detail"id="plugin">
<h3>plugin</h3>
<divclass="member-signature"><spanclass="modifiers">protected</span> <spanclass="return-type"><ahref="../plugin/Plugin.html"title="interface in org.bukkit.plugin">Plugin</a></span> <spanclass="element-name">plugin</span></div>
<divclass="member-signature"><spanclass="modifiers">protected</span> <spanclass="return-type"><ahref="Conversation.html"title="class in org.bukkit.conversations">Conversation</a></span> <spanclass="element-name">conversation</span></div>
<divclass="member-signature"><spanclass="modifiers">public</span> <spanclass="element-name">InactivityConversationCanceller</span><wbr><spanclass="parameters">(<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a>
<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="../plugin/Plugin.html"title="interface in org.bukkit.plugin">Plugin</a> plugin,
int timeoutSeconds)</span></div>
<divclass="block">Creates an InactivityConversationCanceller.</div>
<dlclass="notes">
<dt>Parameters:</dt>
<dd><code>plugin</code> - The owning plugin.</dd>
<dd><code>timeoutSeconds</code> - The number of seconds of inactivity to wait.</dd>
<divclass="member-signature"><spanclass="modifiers">public</span> <spanclass="return-type">void</span> <spanclass="element-name">setConversation</span><wbr><spanclass="parameters">(<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a>
<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="Conversation.html"title="class in org.bukkit.conversations">Conversation</a> conversation)</span></div>
<divclass="block"><spanclass="descfrm-type-label">Description copied from interface: <code><ahref="ConversationCanceller.html#setConversation(org.bukkit.conversations.Conversation)">ConversationCanceller</a></code></span></div>
<divclass="block">Sets the conversation this ConversationCanceller can optionally cancel.</div>
<dlclass="notes">
<dt>Specified by:</dt>
<dd><code><ahref="ConversationCanceller.html#setConversation(org.bukkit.conversations.Conversation)">setConversation</a></code> in interface <code><ahref="ConversationCanceller.html"title="interface in org.bukkit.conversations">ConversationCanceller</a></code></dd>
<dt>Parameters:</dt>
<dd><code>conversation</code> - A conversation.</dd>
<divclass="member-signature"><spanclass="modifiers">public</span> <spanclass="return-type">boolean</span> <spanclass="element-name">cancelBasedOnInput</span><wbr><spanclass="parameters">(<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a>
<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="ConversationContext.html"title="class in org.bukkit.conversations">ConversationContext</a> context,
<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a>
<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html"title="class or interface in java.lang"class="external-link">String</a> input)</span></div>
<divclass="block"><spanclass="descfrm-type-label">Description copied from interface: <code><ahref="ConversationCanceller.html#cancelBasedOnInput(org.bukkit.conversations.ConversationContext,java.lang.String)">ConversationCanceller</a></code></span></div>
<divclass="block">Cancels a conversation based on user input.</div>
<dlclass="notes">
<dt>Specified by:</dt>
<dd><code><ahref="ConversationCanceller.html#cancelBasedOnInput(org.bukkit.conversations.ConversationContext,java.lang.String)">cancelBasedOnInput</a></code> in interface <code><ahref="ConversationCanceller.html"title="interface in org.bukkit.conversations">ConversationCanceller</a></code></dd>
<dt>Parameters:</dt>
<dd><code>context</code> - Context information about the conversation.</dd>
<dd><code>input</code> - The input text from the user.</dd>
<dt>Returns:</dt>
<dd>True to cancel the conversation, False otherwise.</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="clone()">
<h3>clone</h3>
<divclass="member-signature"><spanclass="annotations"><ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a>
</span><spanclass="modifiers">public</span> <spanclass="return-type"><ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="ConversationCanceller.html"title="interface in org.bukkit.conversations">ConversationCanceller</a></span> <spanclass="element-name">clone</span>()</div>
<divclass="block"><spanclass="descfrm-type-label">Description copied from interface: <code><ahref="ConversationCanceller.html#clone()">ConversationCanceller</a></code></span></div>
<divclass="block">Allows the <ahref="ConversationFactory.html"title="class in org.bukkit.conversations"><code>ConversationFactory</code></a> to duplicate this
ConversationCanceller when creating a new <ahref="Conversation.html"title="class in org.bukkit.conversations"><code>Conversation</code></a>.
<p>
Implementing this method should reset any internal object state.</div>
<dlclass="notes">
<dt>Specified by:</dt>
<dd><code><ahref="ConversationCanceller.html#clone()">clone</a></code> in interface <code><ahref="ConversationCanceller.html"title="interface in org.bukkit.conversations">ConversationCanceller</a></code></dd>
<dt>Overrides:</dt>
<dd><code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()"title="class or interface in java.lang"class="external-link">clone</a></code> in class <code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html"title="class or interface in java.lang"class="external-link">Object</a></code></dd>
<divclass="member-signature"><spanclass="modifiers">protected</span> <spanclass="return-type">void</span> <spanclass="element-name">cancelling</span><wbr><spanclass="parameters">(<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a>
<ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="Conversation.html"title="class in org.bukkit.conversations">Conversation</a> conversation)</span></div>
<divclass="block">Subclasses of InactivityConversationCanceller can override this method
to take additional actions when the inactivity timer abandons the
conversation.</div>
<dlclass="notes">
<dt>Parameters:</dt>
<dd><code>conversation</code> - The conversation being abandoned.</dd>