Index
All Classes|All Packages
A
- A_NON_GIFT_PAID_UPGRADE - Enum constant in enum class io.github.jtwitch.message.MessageType
- A_NON_SUB_GIFT - Enum constant in enum class io.github.jtwitch.message.MessageType
- action() - Method in record class io.github.jtwitch.action.ScheduleAction
-
Returns the value of the
action
record component. - addModerator(String) - Static method in class io.github.jtwitch.command.Commands
-
This command will allow you to promote a user to a channel moderator allowing them to have access to all the above commands and features.
- addVip(String) - Static method in class io.github.jtwitch.command.Commands
- answer(Message, String) - Method in class io.github.jtwitch.socket.ConnectedTwitchBot
-
reply to a message.
B
- ban(String) - Static method in class io.github.jtwitch.command.Commands
-
This command will allow you to permanently ban a user from the chat room.
- BITS_BADGE_TIER - Enum constant in enum class io.github.jtwitch.message.MessageType
- block(String) - Static method in class io.github.jtwitch.command.Commands
-
This command will allow you to block all messages from a specific user in chat and whispers if you do not wish to see their comments
- BLUE - Enum constant in enum class io.github.jtwitch.command.type.ColorName
- BLUE_VIOLET - Enum constant in enum class io.github.jtwitch.command.type.ColorName
C
- CADET_BLUE - Enum constant in enum class io.github.jtwitch.command.type.ColorName
- CHOCOLATE - Enum constant in enum class io.github.jtwitch.command.type.ColorName
- clear() - Static method in class io.github.jtwitch.command.Commands
-
This command will allow the Broadcaster and chat moderators to completely wipe the previous chat history.
- color(ColorName) - Static method in class io.github.jtwitch.command.Commands
-
Allows you to change the color of your username.
- color(String) - Static method in class io.github.jtwitch.command.Commands
-
Allows you to change the color of your username.
- ColorName - Enum Class in io.github.jtwitch.command.type
-
Allows you to change the color of your username.
- command(String, Command) - Method in class io.github.jtwitch.socket.ConnectedTwitchBot
-
send command to a specific channel.
- Command - Interface in io.github.jtwitch.command
-
Broadcasters and channel moderators appointed by the broadcaster are equipped with a set of commands and features that will allow them to closely monitor and moderate the chat.
- Commands - Class in io.github.jtwitch.command
-
Repository of all possible
Command
. - commercial(When) - Static method in class io.github.jtwitch.command.Commands
-
An Affiliate and Partner command that runs a commercial for all of your viewers.
- connect() - Method in class io.github.jtwitch.socket.TwitchBot
-
connect the bot to the twitch socket.
- ConnectedTwitchBot - Class in io.github.jtwitch.socket
-
Represent a Twitch bos when it is connected.
- ConnectedTwitchBot(ConnectionOption, List<MessageAction>, List<ScheduleAction>) - Constructor for class io.github.jtwitch.socket.ConnectedTwitchBot
-
constructor with all
- ConnectionOption - Class in io.github.jtwitch.socket.connection
-
Describe options to create a socket connection through the twitch IRC socket.
- ConnectionOption(String, String) - Constructor for class io.github.jtwitch.socket.connection.ConnectionOption
-
The only constructor.
- control(int) - Method in enum class io.github.jtwitch.command.type.Unit
- CORAL - Enum constant in enum class io.github.jtwitch.command.type.ColorName
D
- DAYS - Enum constant in enum class io.github.jtwitch.command.type.Unit
- delete(Message) - Static method in class io.github.jtwitch.command.Commands
-
This command will delete the target message from the chat.
- delete(Message) - Method in class io.github.jtwitch.socket.ConnectedTwitchBot
-
delete a message.
- delete(String) - Static method in class io.github.jtwitch.command.Commands
-
This command will delete the target message from the chat.
- disconnect() - Static method in class io.github.jtwitch.command.Commands
-
This command will simply disconnect you from the chat server.
- DODGER_BLUE - Enum constant in enum class io.github.jtwitch.command.type.ColorName
E
- emoteOnly() - Static method in class io.github.jtwitch.command.Commands
-
This command allows you to set your room so only messages that are 100% emotes are allowed.
- emoteOnlyOff() - Static method in class io.github.jtwitch.command.Commands
-
This command allows you to disable emote only mode if you previously enabled it.
- equals(Object) - Method in record class io.github.jtwitch.action.ScheduleAction
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.jtwitch.command.FollowersCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.jtwitch.command.type.TimeUnit
-
Indicates whether some other object is "equal to" this one.
- execute(ConnectedTwitchBot) - Method in interface io.github.jtwitch.action.ScheduleAction.Action
-
execute the action to be scheduled.
- execute(ConnectedTwitchBot, Message) - Method in interface io.github.jtwitch.action.MessageAction
-
execute something to do on the last message on the twitch chat.
F
- FIREBRICK - Enum constant in enum class io.github.jtwitch.command.type.ColorName
- followers(TimeUnit) - Static method in class io.github.jtwitch.command.Commands
-
This command allows you or your mods to restrict chat to all or some of your followers, based on how long they’ve followed — from 0 minutes (all followers) to 3 months.
- FollowersCommand - Record Class in io.github.jtwitch.command
-
This command allows you or your mods to restrict chat to all or some of your followers, based on how long they’ve followed — from 0 minutes (all followers) to 3 months.
- FollowersCommand(TimeUnit) - Constructor for record class io.github.jtwitch.command.FollowersCommand
-
Creates an instance of a
FollowersCommand
record class. - followersOff() - Static method in class io.github.jtwitch.command.Commands
-
This command will disable followers only mode if it was previously enabled on the channel.
G
- getCommand() - Method in interface io.github.jtwitch.command.Command
- getCommand() - Method in record class io.github.jtwitch.command.FollowersCommand
- getConnectionUrl() - Method in class io.github.jtwitch.socket.connection.ConnectionOption
- getToken() - Method in class io.github.jtwitch.socket.connection.ConnectionOption
- getUser() - Method in class io.github.jtwitch.socket.connection.ConnectionOption
- GIFT_PAID_UPGRADE - Enum constant in enum class io.github.jtwitch.message.MessageType
- GOLDEN_ROD - Enum constant in enum class io.github.jtwitch.command.type.ColorName
- GREEN - Enum constant in enum class io.github.jtwitch.command.type.ColorName
H
- HALF_MINUTE - Enum constant in enum class io.github.jtwitch.command.type.When
- hashCode() - Method in record class io.github.jtwitch.action.ScheduleAction
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.jtwitch.command.FollowersCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.jtwitch.command.type.TimeUnit
-
Returns a hash code value for this object.
- HIGHLIGHT - Enum constant in enum class io.github.jtwitch.message.MessageType
- host(String) - Static method in class io.github.jtwitch.command.Commands
-
This command will allow you to host another channel on yours (embedded video player).
- HOT_PINK - Enum constant in enum class io.github.jtwitch.command.type.ColorName
- HOURS - Enum constant in enum class io.github.jtwitch.command.type.Unit
I
- io.github.jtwitch.action - package io.github.jtwitch.action
- io.github.jtwitch.command - package io.github.jtwitch.command
- io.github.jtwitch.command.type - package io.github.jtwitch.command.type
- io.github.jtwitch.message - package io.github.jtwitch.message
- io.github.jtwitch.socket - package io.github.jtwitch.socket
- io.github.jtwitch.socket.connection - package io.github.jtwitch.socket.connection
J
- join(String) - Method in class io.github.jtwitch.socket.ConnectedTwitchBot
-
Join a streamer channel.
L
- leave(String) - Method in class io.github.jtwitch.socket.ConnectedTwitchBot
-
Leave a streamer channel
M
- marker(String) - Static method in class io.github.jtwitch.command.Commands
-
Adds a stream marker (with an optional description, max 140 characters) at the current timestamp.
- me(String) - Static method in class io.github.jtwitch.command.Commands
-
This command will remove the colon that typically appears after your chat name and italicize your message text.
- mention(String, String) - Static method in class io.github.jtwitch.command.Commands
-
This command will allow you to target your message at a user, or reply directly to a specific message they’ve posted in the chat.
- mention(String, String, String) - Method in class io.github.jtwitch.socket.ConnectedTwitchBot
-
Mention a specific user on a specific channel.
- Message - Class in io.github.jtwitch.message
-
Represent a message sent by a user on twitch to create an instance of it, you need to pass the twitch socket message version of it.
- Message(String) - Constructor for class io.github.jtwitch.message.Message
- MessageAction - Interface in io.github.jtwitch.action
-
Represent what to do when you are trigger by the chat message.
- MessageType - Enum Class in io.github.jtwitch.message
-
Represent a type of message.
- MINUTES - Enum constant in enum class io.github.jtwitch.command.type.Unit
- moderators() - Static method in class io.github.jtwitch.command.Commands
-
This command will display a list of all chat moderators for that specific channel.
- MOUNTH - Enum constant in enum class io.github.jtwitch.command.type.Unit
N
- NORMAL - Enum constant in enum class io.github.jtwitch.message.MessageType
O
- ONE_MINUTE - Enum constant in enum class io.github.jtwitch.command.type.When
- ONE_MINUTE_AND_A_HALF - Enum constant in enum class io.github.jtwitch.command.type.When
- ORANGE_RED - Enum constant in enum class io.github.jtwitch.command.type.ColorName
P
- periodInSecond() - Method in record class io.github.jtwitch.action.ScheduleAction
-
Returns the value of the
periodInSecond
record component.
R
- raid(String) - Static method in class io.github.jtwitch.command.Commands
-
This command will send the viewer to another live channel.
- RAID - Enum constant in enum class io.github.jtwitch.message.MessageType
- RED - Enum constant in enum class io.github.jtwitch.command.type.ColorName
- removeModerator(String) - Static method in class io.github.jtwitch.command.Commands
-
This command will allow you to demote an existing moderator back to viewer status (removing their moderator abilities).
- removeVip(String) - Static method in class io.github.jtwitch.command.Commands
- RESUB - Enum constant in enum class io.github.jtwitch.message.MessageType
- REWARD_GIFT - Enum constant in enum class io.github.jtwitch.message.MessageType
- RITUAL - Enum constant in enum class io.github.jtwitch.message.MessageType
- run(ConnectedTwitchBot) - Method in record class io.github.jtwitch.action.ScheduleAction
-
run a schedule action.
S
- ScheduleAction - Record Class in io.github.jtwitch.action
-
Represent what to on a specific time.
- ScheduleAction(int, ScheduleAction.Action) - Constructor for record class io.github.jtwitch.action.ScheduleAction
-
Creates an instance of a
ScheduleAction
record class. - ScheduleAction.Action - Interface in io.github.jtwitch.action
-
the action to be scheduled.
- SEA_GREEN - Enum constant in enum class io.github.jtwitch.command.type.ColorName
- SECONDS - Enum constant in enum class io.github.jtwitch.command.type.Unit
- secureConnection() - Method in class io.github.jtwitch.socket.connection.ConnectionOption
-
trigger the socket to connect to the SSL connection of twitch
- secureConnection() - Method in class io.github.jtwitch.socket.TwitchBot
-
trigger the socket to connect to the SSL connection of twitch
- send(String, String) - Method in class io.github.jtwitch.socket.ConnectedTwitchBot
-
send a message to a specific channel.
- sendRawSocketMessage(String) - Method in class io.github.jtwitch.socket.ConnectedTwitchBot
-
send a raw command to the socket.
- SKIP_SUBS_MODE_MESSAGE - Enum constant in enum class io.github.jtwitch.message.MessageType
- SPRING_GREEN - Enum constant in enum class io.github.jtwitch.command.type.ColorName
- SUB - Enum constant in enum class io.github.jtwitch.message.MessageType
- SUB_GIFT - Enum constant in enum class io.github.jtwitch.message.MessageType
- SUB_MYSTERY_GIFT - Enum constant in enum class io.github.jtwitch.message.MessageType
T
- THREE_MINUTE - Enum constant in enum class io.github.jtwitch.command.type.When
- time() - Method in record class io.github.jtwitch.command.type.TimeUnit
-
Returns the value of the
time
record component. - timeout(String, Integer) - Static method in class io.github.jtwitch.command.Commands
-
This command allows you to temporarily ban someone from the chat room for 10 minutes by default.
- timeUnit() - Method in record class io.github.jtwitch.command.FollowersCommand
-
Returns the value of the
timeUnit
record component. - TimeUnit - Record Class in io.github.jtwitch.command.type
- TimeUnit(int, Unit) - Constructor for record class io.github.jtwitch.command.type.TimeUnit
-
Creates an instance of a
TimeUnit
record class. - toString() - Method in record class io.github.jtwitch.action.ScheduleAction
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.jtwitch.command.FollowersCommand
-
Returns a string representation of this record class.
- toString() - Method in enum class io.github.jtwitch.command.type.ColorName
- toString() - Method in record class io.github.jtwitch.command.type.TimeUnit
-
Returns a string representation of this record class.
- toString() - Method in enum class io.github.jtwitch.command.type.Unit
- toString() - Method in enum class io.github.jtwitch.command.type.When
- toString() - Method in class io.github.jtwitch.message.Message
- TwitchBot - Class in io.github.jtwitch.socket
-
Represent a twitch bot before it is connected.
- TwitchBot(String, String) - Constructor for class io.github.jtwitch.socket.TwitchBot
-
The only constructor.
- TWO_MINUTE - Enum constant in enum class io.github.jtwitch.command.type.When
- TWO_MINUTE_AND_A_HALF - Enum constant in enum class io.github.jtwitch.command.type.When
U
- unblock(String) - Static method in class io.github.jtwitch.command.Commands
-
This command will allow you to block all messages from a specific user in chat and whispers if you do not wish to see their comments
- unhost() - Static method in class io.github.jtwitch.command.Commands
-
Using this command will revert the embedding from hosting a channel and return it to its normal state.
- uniqueChat() - Static method in class io.github.jtwitch.command.Commands
-
This command disallows users from posting non-unique messages to the channel.
- uniqueChatOff() - Static method in class io.github.jtwitch.command.Commands
-
This command will disable Uniquechat mode if it was previously enabled on the channel.
- unit() - Method in record class io.github.jtwitch.command.type.TimeUnit
-
Returns the value of the
unit
record component. - Unit - Enum Class in io.github.jtwitch.command.type
- unraid() - Static method in class io.github.jtwitch.command.Commands
-
This command will cancel the raid.
- UNRAID - Enum constant in enum class io.github.jtwitch.message.MessageType
V
- valueOf(String) - Static method in enum class io.github.jtwitch.command.type.ColorName
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.jtwitch.command.type.Unit
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.jtwitch.command.type.When
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.jtwitch.message.MessageType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.jtwitch.command.type.ColorName
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.jtwitch.command.type.Unit
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.jtwitch.command.type.When
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.jtwitch.message.MessageType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- vips() - Static method in class io.github.jtwitch.command.Commands
-
This command will display a list of VIPs for that specific channel.
W
- WEEK - Enum constant in enum class io.github.jtwitch.command.type.Unit
- When - Enum Class in io.github.jtwitch.command.type
- whisper(String, String) - Static method in class io.github.jtwitch.command.Commands
-
This command sends a private message to another user on Twitch.
- whisper(String, String) - Method in class io.github.jtwitch.socket.ConnectedTwitchBot
-
This command sends a private message to another user on Twitch.
- withActionOnMessage(MessageAction) - Method in class io.github.jtwitch.socket.TwitchBot
-
add an action triggered by a message
- withScheduleAction(int, ScheduleAction.Action) - Method in class io.github.jtwitch.socket.TwitchBot
-
add an action
Y
- YELLOW_GREEN - Enum constant in enum class io.github.jtwitch.command.type.ColorName
All Classes|All Packages