Class RainPointScene

Namespace

RainPointClient

Assembly

RainPointClient.dll

A scene observation. Enabling can start future automation; disabling does not stop an already running valve.

public sealed class RainPointScene

Inheritance

object

RainPointScene

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

Actions

Gets the observed actions, including explicitly unsupported kinds.

public IReadOnlyList<RainPointSceneAction> Actions { get; }

Property Value

IReadOnlyList<RainPointSceneAction>

Available

Gets reported scene availability, or null for an unrecognized availability value.

public bool? Available { get; }

Property Value

bool?

Conditions

Gets the observed conditions, including explicitly unsupported kinds.

public IReadOnlyList<RainPointSceneCondition> Conditions { get; }

Property Value

IReadOnlyList<RainPointSceneCondition>

Enabled

Gets the recognized enabled state, or null for an unrecognized switch value.

public bool? Enabled { get; }

Property Value

bool?

ExecutingHubId

Gets the cloud ID of the hub assigned to execute the scene.

public long? ExecutingHubId { get; }

Property Value

long?

HomeId

Gets the home containing this scene.

public long HomeId { get; }

Property Value

long

Id

Gets the cloud scene identifier.

public long Id { get; }

Property Value

long

MatchAll

Gets whether all conditions must match, or null when the flags cannot be interpreted.

public bool? MatchAll { get; }

Property Value

bool?

MaximumRunsPerDay

Zero means unlimited.

public int? MaximumRunsPerDay { get; }

Property Value

int?

MinimumIntervalMinutes

Gets the minimum execution interval in minutes, or null when unavailable.

public int? MinimumIntervalMinutes { get; }

Property Value

int?

Name

Gets the scene display name.

public string Name { get; }

Property Value

string

Methods

CreateDraft()

Copies a fully understood scene to an editable definition. Unsupported effective periods or components are never silently discarded.

public RainPointSceneDraft CreateDraft()

Returns

RainPointSceneDraft

An editable complete copy, provided every effective-period and component representation is supported.

Exceptions

NotSupportedException

This scene contains settings which cannot yet be edited without losing information. Missing executing hub.