Package io.github.jtwitch.action

Record Class ScheduleAction

java.lang.Object

java.lang.Record

io.github.jtwitch.action.ScheduleAction

public record ScheduleAction(int periodInSecond, ScheduleAction.Action action)
extends Record

Represent what to on a specific time.
It is used when you build a TwitchBot with method TwitchBot.withScheduleAction(int, Action).
You can for instance send `Hello world` all 5 minutes with :
new TwitchBot(user, token).withScheduleAction(300, bot -> bot.send("streamerName", "Hello World")

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScheduleAction.Action	the action to be scheduled.

Constructor Summary

Constructors

Constructor	Description
ScheduleAction(int periodInSecond, ScheduleAction.Action action)	Creates an instance of a ScheduleAction record class.

Method Summary

Modifier and Type	Method	Description
ScheduleAction.Action	action()	Returns the value of the action record component.
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	hashCode()	Returns a hash code value for this object.
int	periodInSecond()	Returns the value of the periodInSecond record component.
void	run(ConnectedTwitchBot bot)	run a schedule action.
String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ScheduleAction

public ScheduleAction(int periodInSecond,
 ScheduleAction.Action action)

Creates an instance of a ScheduleAction record class.

Parameters:

periodInSecond - the value for the periodInSecond record component

action - the value for the action record component

Method Details

run

public void run(ConnectedTwitchBot bot)

run a schedule action.

Parameters:

bot - the bot when it is connected to the twitch socket

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

periodInSecond

public int periodInSecond()

Returns the value of the periodInSecond record component.

Returns:

the value of the periodInSecond record component

action

public ScheduleAction.Action action()

Returns the value of the action record component.

Returns:

the value of the action record component