com.mixer.interactive.resources.control

Class ButtonControl

java.lang.Object

com.mixer.interactive.resources.InteractiveResource<T>

com.mixer.interactive.resources.control.InteractiveControl<ButtonControl>

com.mixer.interactive.resources.control.ButtonControl

All Implemented Interfaces:

IInteractiveCreatable, IInteractiveDeletable, IInteractiveUpdatable, Comparable<InteractiveControl>

public class ButtonControl
extends InteractiveControl<ButtonControl>

A InteractiveControl represents a button control on the Interactive service.

Since:

1.0.0

Author:

Microsoft Corporation

Field Summary

Fields inherited from class com.mixer.interactive.resources.InteractiveResource

meta

Constructor Summary

Constructors

Constructor and Description
ButtonControl(String controlID) Initializes a new ButtonControl.
ButtonControl(String controlID, String sceneID, InteractiveControlPosition... position) Initializes a new ButtonControl.

Method Summary

Modifier and Type	Method and Description
ButtonControl	addToCooldown(Duration duration) Adds the provided Duration to the existing cooldown for this ButtonControl.
Long	getCooldown() Returns the UTC unix timestamp (in milliseconds) for when the cooldown for this ButtonControl.
Integer	getCost() Returns the Spark cost for this ButtonControl.
Integer	getKeyCode() Returns the keyCode for this ButtonControl.
Float	getProgress() Returns the value for the progress bar for this ButtonControl.
String	getText() Returns the text displayed on the ButtonControl.
protected ButtonControl	getThis() Returns this as an instance of the specified generic.
String	getTooltip() Returns the tooltip text displayed when the participant hovers over the button.
ButtonControl	setCooldown(Instant cooldown) Sets the UTC unix timestamp (in milliseconds) for when the cooldown for this ButtonControl expires.
ButtonControl	setCooldown(Number cooldown) Sets the UTC unix timestamp (in milliseconds) for when the cooldown for this ButtonControl expires.
ButtonControl	setCost(Integer cost) Sets the Spark cost for this ButtonControl.
ButtonControl	setKeyCode(Integer keyCode) Sets the keyCode for this ButtonControl.
ButtonControl	setProgress(Float progress) Sets the value for the progress bar for this ButtonControl.
ButtonControl	setText(String text) Sets the text to be displayed on the ButtonControl.
ButtonControl	setTooltip(String tooltip) Sets the tooltip text to be displayed when the participant hovers over the ButtonControl.
boolean	syncIfEqual(Collection<?> objects) Iterates through a Collection of Objects.

Methods inherited from class com.mixer.interactive.resources.control.InteractiveControl

addPosition, compareTo, create, delete, equals, getControlID, getKind, getPositionFor, getPositionFor, getPositions, getSceneID, hashCode, hasPositionFor, hasPositionFor, isDisabled, removeAllPositions, removePosition, removePosition, setDisabled, setPositions, setPositions, update

Methods inherited from class com.mixer.interactive.resources.InteractiveResource

addMetaProperty, getMeta, setMeta

Methods inherited from class java.lang.Object

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

Constructor Detail

ButtonControl

public ButtonControl(String controlID)

Initializes a new ButtonControl.

Parameters:

controlID - Unique identifier for the ButtonControl

Since:

1.0.0

ButtonControl

public ButtonControl(String controlID,
                     String sceneID,
                     InteractiveControlPosition... position)

Initializes a new ButtonControl.

Parameters:

controlID - Unique identifier for the ButtonControl

sceneID - Unique identifier for the InteractiveScene that contains this control

position - An array of initial InteractiveControlPosition for this control

Since:

1.0.0

Method Detail

getKeyCode

public Integer getKeyCode()

Returns the keyCode for this ButtonControl.

Returns:

The keyCode for this ButtonControl

Since:

1.0.0

setKeyCode

public ButtonControl setKeyCode(Integer keyCode)

Sets the keyCode for this ButtonControl.

Parameters:

keyCode - The keyCode to be used for this ButtonControl

Returns:

this for method chaining

Since:

1.0.0

getText

public String getText()

Returns the text displayed on the ButtonControl.

Returns:

The text displayed on the ButtonControl

Since:

1.0.0

setText

public ButtonControl setText(String text)

Sets the text to be displayed on the ButtonControl.

Parameters:

text - The text to be displayed on the ButtonControl

Returns:

this for method chaining

Since:

1.0.0

getTooltip

public String getTooltip()

Returns the tooltip text displayed when the participant hovers over the button.

Returns:

The tooltip text displayed when the participant hovers over the button

Since:

2.0.0

setTooltip

public ButtonControl setTooltip(String tooltip)

Sets the tooltip text to be displayed when the participant hovers over the ButtonControl.

Parameters:

tooltip - The tooltip text displayed when the participant hovers over the button

Returns:

this for method chaining

Since:

2.0.0

getCost

public Integer getCost()

Returns the Spark cost for this ButtonControl.

Returns:

The Spark cost for this ButtonControl

Since:

1.0.0

setCost

public ButtonControl setCost(Integer cost)

Sets the Spark cost for this ButtonControl.

Parameters:

cost - The Spark cost for this ButtonControl

Returns:

this for method chaining

Since:

1.0.0

getProgress

public Float getProgress()

Returns the value for the progress bar for this ButtonControl.

Returns:

The value for the progress bar for this ButtonControl

Since:

1.0.0

setProgress

public ButtonControl setProgress(Float progress)

Sets the value for the progress bar for this ButtonControl.

Parameters:

progress - The value for the progress bar for this ButtonControl

Returns:

this for method chaining

Since:

1.0.0

getCooldown

public Long getCooldown()

Returns the UTC unix timestamp (in milliseconds) for when the cooldown for this ButtonControl. expires

Returns:

The UTC unix timestamp (in milliseconds) for when the cooldown for this ButtonControl expires

Since:

1.0.0

setCooldown

public ButtonControl setCooldown(Number cooldown)

Sets the UTC unix timestamp (in milliseconds) for when the cooldown for this ButtonControl expires.

Parameters:

cooldown - The UTC unix timestamp (in milliseconds) for when the cooldown for this ButtonControl expires

Returns:

this for method chaining

Since:

1.0.0

setCooldown

public ButtonControl setCooldown(Instant cooldown)

Sets the UTC unix timestamp (in milliseconds) for when the cooldown for this ButtonControl expires.

Parameters:

cooldown - The Instant for when the cooldown for this ButtonControl expires

Returns:

this for method chaining

Since:

1.0.0

addToCooldown

public ButtonControl addToCooldown(Duration duration)

Adds the provided Duration to the existing cooldown for this ButtonControl.

Parameters:

duration - The Duration to add to the existing cooldown timestamp

Returns:

this for method chaining

Since:

1.0.0

getThis

protected ButtonControl getThis()

Returns this as an instance of the specified generic. Utilizes the getThis programming idiom.

Specified by:

getThis in class InteractiveResource<ButtonControl>

Returns:

this as an object of type T

Since:

1.0.0

See Also:

InteractiveResource.getThis()

syncIfEqual

public boolean syncIfEqual(Collection<?> objects)

Iterates through a Collection of Objects. If this is found to be in the Collection then this has it's values updated.

Specified by:

syncIfEqual in class InteractiveResource<ButtonControl>

Parameters:

objects - A Collection of Objects

Returns:

A CompletableFuture that when complete returns true if the provided Collection contains this

Since:

2.0.0

See Also:

InteractiveResource.syncIfEqual(Collection)