Package com.treescrub.spedran.requests.builders.run

Class SubmitRunRequest

java.lang.Object

com.treescrub.spedran.SingleResourceRequest<T>

com.treescrub.spedran.ModifyResourceRequest<Run>

com.treescrub.spedran.requests.builders.run.SubmitRunRequest

public class SubmitRunRequest
extends ModifyResourceRequest<Run>

A request builder to submit a Run to SRC.

Constructor Summary

Constructors

Constructor	Description
SubmitRunRequest()

Method Summary

Modifier and Type	Method	Description
SubmitRunRequest	category(Category category)	Sets the Category for the run.
SubmitRunRequest	category(String categoryId)	Sets the Category for the run.
SubmitRunRequest	comment(String comment)	Sets the comment/description for the run.
SubmitRunRequest	customVariable(Variable variable, String valueText)	Sets the value for a Variable with custom user defined text.
SubmitRunRequest	customVariable(String variableId, String valueText)	Sets the value for a Variable with custom user defined text.
SubmitRunRequest	date(LocalDate runDate)	Sets the date that this run was played on.
SubmitRunRequest	emulated(boolean isEmulated)	Sets whether the run was played on an emulator.
SubmitRunRequest	guestPlayer(Guest guest)	Adds a Guest that participated in the run.
SubmitRunRequest	guestPlayer(String guestName)	Adds a Guest that participated in the run.
SubmitRunRequest	ingameTime(Duration ingameTime)	Sets the ingame time (IGT) for the run.
SubmitRunRequest	level(Level level)	Sets the Level for the run.
SubmitRunRequest	level(String levelId)	Sets the Level for the run.
SubmitRunRequest	platform(Platform platform)	Sets the Platform for the run.
SubmitRunRequest	platform(String platformId)	Sets the Platform for the run.
SubmitRunRequest	realTime(Duration realTime)	Sets the realtime (RTA) time for the run.
SubmitRunRequest	realTimeNoLoads(Duration realTimeNoLoads)	Sets the realtime (RTA) with loads removed time for the run.
SubmitRunRequest	region(Region region)	Sets the Region game version for the run.
SubmitRunRequest	region(String regionId)	Sets the Region game version for the run.
SubmitRunRequest	splitsIO(String splitsIO)	Sets the ID or URL for the splits.io run page.
SubmitRunRequest	userPlayer(User user)	Adds a User that participated in the run.
SubmitRunRequest	userPlayer(String userId)	Adds a User that participated in the run.
SubmitRunRequest	variable(Variable variable, String valueId)	Sets the value for a Variable with a predefined value ID.
SubmitRunRequest	variable(String variableId, String valueId)	Sets the value for a Variable with a predefined value ID.
SubmitRunRequest	verified()	Sets the run to be immediately verified when submitted.
SubmitRunRequest	video(String videoUrl)	Sets the video URL for the run.

Methods inherited from class com.treescrub.spedran.ModifyResourceRequest

complete

Methods inherited from class java.lang.Object

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

Constructor Detail

SubmitRunRequest

public SubmitRunRequest()

Method Detail

category

public SubmitRunRequest category(Category category)

Sets the Category for the run.

Parameters:

category - the category that the run is in

Returns:

this builder object

category

public SubmitRunRequest category(String categoryId)

Sets the Category for the run.

Parameters:

categoryId - the category ID that the run is in

Returns:

this builder object

level

public SubmitRunRequest level(Level level)

Sets the Level for the run.

Parameters:

level - the level that the run is on

Returns:

this builder object

level

public SubmitRunRequest level(String levelId)

Sets the Level for the run.

Parameters:

levelId - the level ID that the run is on

Returns:

this builder object

date

public SubmitRunRequest date(LocalDate runDate)

Sets the date that this run was played on.

Parameters:

runDate - the date this run was ran on

Returns:

this builder object

region

public SubmitRunRequest region(Region region)

Sets the Region game version for the run.

Parameters:

region - the region of the game for the run

Returns:

this builder object

region

public SubmitRunRequest region(String regionId)

Sets the Region game version for the run.

Parameters:

regionId - the region ID of the game for the run

Returns:

this builder object

platform

public SubmitRunRequest platform(Platform platform)

Sets the Platform for the run.

Parameters:

platform - the platform that this run was played on

Returns:

this builder object

platform

public SubmitRunRequest platform(String platformId)

Sets the Platform for the run.

Parameters:

platformId - the platform ID that this run was played on

Returns:

this builder object

verified

public SubmitRunRequest verified()

Sets the run to be immediately verified when submitted.
Requires permissions to verify runs for the leaderboard that the run is being submitted to.

Returns:

this builder object

realTime

public SubmitRunRequest realTime(Duration realTime)

Sets the realtime (RTA) time for the run.

Parameters:

realTime - a Duration with the RTA time

Returns:

this builder object

realTimeNoLoads

public SubmitRunRequest realTimeNoLoads(Duration realTimeNoLoads)

Sets the realtime (RTA) with loads removed time for the run.

Parameters:

realTimeNoLoads - a Duration with the RTA no loads time

Returns:

this builder object

ingameTime

public SubmitRunRequest ingameTime(Duration ingameTime)

Sets the ingame time (IGT) for the run.

Parameters:

ingameTime - a Duration with the ingame time

Returns:

this builder object

userPlayer

public SubmitRunRequest userPlayer(User user)

Adds a User that participated in the run.

Parameters:

user - a user that is a player in the run

Returns:

this builder object

userPlayer

public SubmitRunRequest userPlayer(String userId)

Adds a User that participated in the run.

Parameters:

userId - the ID of a user that is a player in the run

Returns:

this builder object

guestPlayer

public SubmitRunRequest guestPlayer(Guest guest)

Adds a Guest that participated in the run.

Parameters:

guest - a guest that is a player in the run

Returns:

this builder object

guestPlayer

public SubmitRunRequest guestPlayer(String guestName)

Adds a Guest that participated in the run.

Parameters:

guestName - the name of a guest that is a player in the run

Returns:

this builder object

emulated

public SubmitRunRequest emulated(boolean isEmulated)

Sets whether the run was played on an emulator.

Parameters:

isEmulated - whether an emulator was used

Returns:

this builder object

video

public SubmitRunRequest video(String videoUrl)

Sets the video URL for the run.

Parameters:

videoUrl - a String with a URL to a video hosting site

Returns:

this builder object

comment

public SubmitRunRequest comment(String comment)

Sets the comment/description for the run.

Parameters:

comment - a String with the custom comment

Returns:

this builder object

splitsIO

public SubmitRunRequest splitsIO(String splitsIO)

Sets the ID or URL for the splits.io run page.

Parameters:

splitsIO - a String with an ID or URL to a splits.io page

Returns:

this builder object

variable

public SubmitRunRequest variable(Variable variable,
                                 String valueId)

Sets the value for a Variable with a predefined value ID.

Parameters:

variable - the variable to set for the run

valueId - the value ID to set for the variable

Returns:

this builder object

variable

public SubmitRunRequest variable(String variableId,
                                 String valueId)

Sets the value for a Variable with a predefined value ID.

Parameters:

variableId - the variable ID to set for the run

valueId - the value ID to set for the variable

Returns:

this builder object

customVariable

public SubmitRunRequest customVariable(Variable variable,
                                       String valueText)

Sets the value for a Variable with custom user defined text.

Parameters:

variable - the variable to set for the run

valueText - the value to set for the variable

Returns:

this builder object

customVariable

public SubmitRunRequest customVariable(String variableId,
                                       String valueText)

Sets the value for a Variable with custom user defined text.

Parameters:

variableId - the variable ID to set for the run

valueText - the value to set for the variable

Returns:

this builder object