org.kitteh.irc.client.library.feature.twitch

Class TwitchSupport

java.lang.Object

org.kitteh.irc.client.library.feature.twitch.TwitchSupport

public final class TwitchSupport
extends Object

A class for introducing Twitch support to a KICL client.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CAPABILITY_COMMANDS Capability to receive commands.
static String	CAPABILITY_MEMBERSHIP Capability to receive JOIN, MODE, NAMES, and PART.
static String	CAPABILITY_TAGS Capability to receive tags.

Method Summary

Modifier and Type	Method and Description
static Client	addSupport(@NonNull Client client) Adds support for Twitch to the client.
static Client	addSupport(@NonNull Client client, boolean alwaysModOrOp) Adds support for Twitch to the client.
static boolean	hasSupport(@NonNull Client client) Checks if the given client has had Twitch support added.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CAPABILITY_COMMANDS

public static final String CAPABILITY_COMMANDS

Capability to receive commands.

See Also:

Constant Field Values

CAPABILITY_MEMBERSHIP

public static final String CAPABILITY_MEMBERSHIP

Capability to receive JOIN, MODE, NAMES, and PART.

See Also:

Constant Field Values

CAPABILITY_TAGS

public static final String CAPABILITY_TAGS

Capability to receive tags.

See Also:

Constant Field Values

Method Detail

addSupport

public static Client addSupport(@NonNull Client client)

Adds support for Twitch to the client. Registers all the Twitch tags, switches out an event listener for connection information (Twitch does it differently), disables querying channel info (missing on Twitch), and replaces the message sending queue supplier with a Twitch-targeted queue for regular users.

Parameters:

client - unconnected client

Returns:

the same client

See Also:

TwitchListener, TwitchDelaySender

addSupport

public static Client addSupport(@NonNull Client client,
                                boolean alwaysModOrOp)

Adds support for Twitch to the client. Registers all the Twitch tags, switches out an event listener for connection information (Twitch does it differently), disables querying channel info (missing on Twitch), and sets the message sending queue supplier to be a Twitch-targeted queue for regular users or mod/op depending on the second parameter. This method must be called prior to connecting.

Parameters:

client - unconnected client

alwaysModOrOp - if the client will be a mod/op in EVERY channel

Returns:

the same client

See Also:

TwitchListener, TwitchDelaySender

hasSupport

public static boolean hasSupport(@NonNull Client client)

Checks if the given client has had Twitch support added. Checks by looking for the twitch-modified event listener added in addSupport(Client, boolean).

Parameters:

client - client to check

Returns:

true if the client has Twitch support added