Interface MessageSearchResponse

public interface MessageSearchResponse

Base interface for message search responses.

See Also:

• Guild.searchMessages()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MessageSearchResponse.NotReady	Represents a response indicating the search index is not yet ready.
static interface	MessageSearchResponse.Results	Represents a response with the found messages.

Method Summary

Modifier and Type	Method	Description
MessageSearchResponse.NotReady	asNotReady()	Returns this instance as NotReady, if it is one.
MessageSearchResponse.Results	asResults()	Returns this instance as Results, if it is one.
boolean	isNotReady()	Whether the message search results are not ready yet.

Method Details

isNotReady

boolean isNotReady()

Whether the message search results are not ready yet.

If this returns true, you must use asNotReady() to retry the request according to the returned delay.

If this returns false, you must use asResults() to read the results.

Returns:

true if the index is not ready yet, false otherwise

asNotReady

@Nonnull
MessageSearchResponse.NotReady asNotReady()

Returns this instance as NotReady, if it is one.

Returns:

The NotReady state

Throws:

IllegalStateException - If the search has succeeded

asResults

@Nonnull
MessageSearchResponse.Results asResults()

Returns this instance as Results, if it is one.

Returns:

The Results state

Throws:

IllegalStateException - If the search is not ready yet