Class States

Namespace

OverKizApi.Models

Assembly

OverKizApi.dll

An ordered, name-indexed collection of State objects for a device. Implements IEnumerable<T> so it can be used directly in foreach loops.

[JsonConverter(typeof(StatesJsonConverter))]
public sealed class States : IEnumerable<State>, IEnumerable

Inheritance

object

States

Implements

IEnumerable<State>

IEnumerable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Remarks

Initialises the collection from an optional sequence of states.

Constructors

States(IEnumerable<State>?)

An ordered, name-indexed collection of State objects for a device. Implements IEnumerable<T> so it can be used directly in foreach loops.

public States(IEnumerable<State>? states = null)

Parameters

states IEnumerable<State>

Initial states; pass null or omit for an empty collection.

Remarks

Initialises the collection from an optional sequence of states.

Properties

this[string]

Returns the State with the given qualified name, or null if not found.

public State? this[string name] { get; }

Parameters

name string

Qualified state name (e.g. "core:ClosureState").

Property Value

State

Methods

Contains(string)

Returns true if a state with the given qualified name is present.

public bool Contains(string name)

Parameters

name string

Qualified state name to look up.

Returns

bool

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<State> GetEnumerator()

Returns

IEnumerator<State>

An enumerator that can be used to iterate through the collection.