InteractiveControl (mixer-interactive-api 2.1.0 API)

java.lang.Object
- com.mixer.interactive.resources.InteractiveResource<T>
- - com.mixer.interactive.resources.control.InteractiveControl<T>

All Implemented Interfaces:

IInteractiveCreatable, IInteractiveDeletable, IInteractiveUpdatable, Comparable<InteractiveControl>

Direct Known Subclasses:

ButtonControl, JoystickControl
```
public abstract class InteractiveControl<T extends InteractiveResource<T>>
extends InteractiveResource<T>
implements IInteractiveCreatable, IInteractiveDeletable, Comparable<InteractiveControl>
```
The abstract class InteractiveControl is the superclass for all controls on the Interactive service.

Since:

1.0.0

Author:

Microsoft Corporation

See Also:

ButtonControl, JoystickControl

Field Summary
- Fields inherited from class com.mixer.interactive.resources.InteractiveResource
  meta

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`addPosition(InteractiveControlPosition... controlPositions)` Adds `InteractiveControlPositions` to this `InteractiveControl`.
`int`	`compareTo(InteractiveControl o)`
`CompletableFuture<Boolean>`	`create(GameClient gameClient)` Creates `this` in the default scene on the Interactive service.
`CompletableFuture<Boolean>`	`delete(GameClient gameClient)` Asynchronously deletes `this` from the specified scene.
`boolean`	`equals(Object o)`
`String`	`getControlID()` Returns the unique identifier for the `InteractiveControl`.
`InteractiveControlType`	`getKind()` Returns the kind of control this `InteractiveControl` is.
`InteractiveControlPosition`	`getPositionFor(InteractiveCanvasSize canvasSize)` Returns the `InteractiveControlPosition` for the provided `InteractiveCanvasSize` if there exists one, `null` otherwise.
`InteractiveControlPosition`	`getPositionFor(String canvasSize)` Returns the `InteractiveControlPosition` for the provided canvas size if there exists one, `null` otherwise.
`Set<InteractiveControlPosition>`	`getPositions()` Returns a `Set` of all `InteractiveControlPositions` for this `InteractiveControl`.
`String`	`getSceneID()` Returns the unique identifier for the `InteractiveScene` that contains this control.
`int`	`hashCode()`
`boolean`	`hasPositionFor(InteractiveCanvasSize canvasSize)` Returns `true` if this `InteractiveControl` has a controlPositions for the provided `InteractiveCanvasSize`, `false` otherwise.
`boolean`	`hasPositionFor(String canvasSize)` Returns `true` if this `InteractiveControl` has a controlPositions for the provided canvas size, `false` otherwise.
`boolean`	`isDisabled()` Returns `true` if this `InteractiveControlType` is disabled, `false` otherwise
`T`	`removeAllPositions()` Removes all `InteractiveControlPositions` associated with this `InteractiveControl`.
`T`	`removePosition(InteractiveCanvasSize canvasSize)` Attempts to remove any `InteractiveControlPosition` associated with the provided `InteractiveCanvasSize`.
`T`	`removePosition(String canvasSize)` Attempts to remove any `InteractiveControlPosition` associated with the provided canvas size.
`T`	`setDisabled(Boolean disabled)` Sets the disabled state for this `InteractiveControlType`.
`T`	`setPositions(Collection<InteractiveControlPosition> controlPositions)` Sets the `InteractiveControlPositions` for this `InteractiveControl`.
`T`	`setPositions(InteractiveControlPosition... controlPositions)` Sets the `InteractiveControlPositions` for this `InteractiveControl`.
`CompletableFuture<Boolean>`	`update(GameClient gameClient)` Asynchronously updates `this` in the specified on the Interactive service.

Methods inherited from class com.mixer.interactive.resources.InteractiveResource
addMetaProperty, getMeta, getThis, setMeta, syncIfEqual

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getControlID
```
public String getControlID()
```
    Returns the unique identifier for the InteractiveControl.
    
    Returns:
    
    The unique identifier for the InteractiveControl
    
    Since:
    
    1.0.0
  - getSceneID
```
public String getSceneID()
```
    Returns the unique identifier for the InteractiveScene that contains this control.
    
    Returns:
    
    The unique identifier for the InteractiveControl that contains this control
    
    Since:
    
    1.0.0
  - getKind
```
public InteractiveControlType getKind()
```
    Returns the kind of control this InteractiveControl is.
    
    Returns:
    
    InteractiveControlType representing what kind of InteractiveControl this is
    
    Since:
    
    1.0.0
  - isDisabled
```
public boolean isDisabled()
```
    Returns true if this InteractiveControlType is disabled, false otherwise
    
    Returns:
    
    true if this InteractiveControlType is disabled, false otherwise
    
    Since:
    
    1.0.0
  - setDisabled
```
public T setDisabled(Boolean disabled)
```
    Sets the disabled state for this InteractiveControlType.
    
    Parameters:
    
    disabled - true if this InteractiveControlType should be disabled, false otherwise
    
    Returns:
    
    this for method chaining
    
    Since:
    
    1.0.0
  - hasPositionFor
```
public boolean hasPositionFor(String canvasSize)
```
    Returns true if this InteractiveControl has a controlPositions for the provided canvas size, false otherwise.
    
    Parameters:
    
    canvasSize - The canvas size that is being checked for a controlPositions setting for this control
    
    Returns:
    
    true if this InteractiveControl has a controlPositions for the provided canvas size, false otherwise
    
    Since:
    
    1.0.0
  - hasPositionFor
```
public boolean hasPositionFor(InteractiveCanvasSize canvasSize)
```
    Returns true if this InteractiveControl has a controlPositions for the provided InteractiveCanvasSize, false otherwise.
    
    Parameters:
    
    canvasSize - The InteractiveCanvasSize that is being checked for a controlPositions setting for this control
    
    Returns:
    
    true if this InteractiveControl has a controlPositions for the provided InteractiveCanvasSize, false otherwise
    
    Since:
    
    1.0.0
  - getPositionFor
```
public InteractiveControlPosition getPositionFor(String canvasSize)
```
    Returns the InteractiveControlPosition for the provided canvas size if there exists one, null otherwise.
    
    Parameters:
    
    canvasSize - Interactive control canvas size
    
    Returns:
    
    The InteractiveControlPosition if one exists for the provided canvas size, null otherwise
    
    Since:
    
    1.0.0
  - getPositionFor
```
public InteractiveControlPosition getPositionFor(InteractiveCanvasSize canvasSize)
```
    Returns the InteractiveControlPosition for the provided InteractiveCanvasSize if there exists one, null otherwise.
    
    Parameters:
    
    canvasSize - A InteractiveCanvasSize
    
    Returns:
    
    The InteractiveControlPosition for the provided InteractiveCanvasSize if there exists one, null otherwise.
    
    Since:
    
    1.0.0
  - getPositions
```
public Set<InteractiveControlPosition> getPositions()
```
    Returns a Set of all InteractiveControlPositions for this InteractiveControl.
    
    Returns:
    
    A Set of all InteractiveControlPositions for this InteractiveControl
    
    Since:
    
    1.0.0
  - addPosition
```
public T addPosition(InteractiveControlPosition... controlPositions)
```
    Adds InteractiveControlPositions to this InteractiveControl. If there already exists a InteractiveControlPosition for a InteractiveCanvasSize, then the existing value is for that canvas size is retained.
    
    Parameters:
    
    controlPositions - An array of InteractiveControlPositions to be added to this InteractiveControl
    
    Returns:
    
    this for method chaining
    
    Since:
    
    1.0.0
  - setPositions
```
public T setPositions(Collection<InteractiveControlPosition> controlPositions)
```
    Sets the InteractiveControlPositions for this InteractiveControl. All previous positions are cleared and the new ones are applied in place of them.
    
    Parameters:
    
    controlPositions - A Collection of InteractiveControlPositions to be set for this InteractiveControl
    
    Returns:
    
    this for method chaining
    
    Since:
    
    1.0.0
  - setPositions
```
public T setPositions(InteractiveControlPosition... controlPositions)
```
    Sets the InteractiveControlPositions for this InteractiveControl. All previous positions are cleared and the new ones are applied in place of them.
    
    Parameters:
    
    controlPositions - An array of InteractiveControlPositions to be set for this InteractiveControl
    
    Returns:
    
    this for method chaining
    
    Since:
    
    1.0.0
  - removePosition
```
public T removePosition(InteractiveCanvasSize canvasSize)
```
    Attempts to remove any InteractiveControlPosition associated with the provided InteractiveCanvasSize.
    
    Parameters:
    
    canvasSize - The InteractiveCanvasSize for which we would like to remove a InteractiveControlPosition
    
    Returns:
    
    this for method chaining
    
    Since:
    
    1.0.0
  - removePosition
```
public T removePosition(String canvasSize)
```
    Attempts to remove any InteractiveControlPosition associated with the provided canvas size.
    
    Parameters:
    
    canvasSize - The canvas size for which we would like to remove a InteractiveControlPosition
    
    Returns:
    
    this for method chaining
    
    Since:
    
    1.0.0
  - removeAllPositions
```
public T removeAllPositions()
```
    Removes all InteractiveControlPositions associated with this InteractiveControl.
    
    Returns:
    
    this for method chaining
    
    Since:
    
    1.0.0
  - create
```
public CompletableFuture<Boolean> create(GameClient gameClient)
```
    Creates this in the default scene on the Interactive service.
    
    Specified by:
    
    create in interface IInteractiveCreatable
    
    Parameters:
    
    gameClient - The GameClient to use for the create operation
    
    Returns:
    
    A CompletableFuture that when complete returns true if the create method call completes with no errors
    
    Since:
    
    2.0.0
    
    See Also:
    
    IInteractiveCreatable.create(GameClient)
  - update
```
public CompletableFuture<Boolean> update(GameClient gameClient)
```
    Asynchronously updates this in the specified on the Interactive service.
    
    Specified by:
    
    update in interface IInteractiveUpdatable
    
    Parameters:
    
    gameClient - The GameClient to use for the update operation
    
    Returns:
    
    A CompletableFuture that when complete returns true if the update method call completes with no errors
    
    Since:
    
    2.0.0
  - delete
```
public CompletableFuture<Boolean> delete(GameClient gameClient)
```
    Asynchronously deletes this from the specified scene.
    
    Specified by:
    
    delete in interface IInteractiveDeletable
    
    Parameters:
    
    gameClient - The GameClient to use for the delete operation
    
    Returns:
    
    A CompletableFuture that when complete returns true if the delete method call completes with no errors
    
    Since:
    
    2.0.0
  - compareTo
```
public int compareTo(InteractiveControl o)
```
    Specified by:
    
    compareTo in interface Comparable<InteractiveControl>
    
    Since:
    
    1.0.0
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    Since:
    
    1.0.0
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
    
    Since:
    
    1.0.0

Class InteractiveControl<T extends InteractiveResource<T>>

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

getControlID

getSceneID

getKind

isDisabled

setDisabled

hasPositionFor

hasPositionFor

getPositionFor

getPositionFor

getPositions

addPosition

setPositions

setPositions

removePosition

removePosition

removeAllPositions

create

update

delete

compareTo

hashCode

equals