Class RainPointSceneAction

Namespace

RainPointClient

Assembly

RainPointClient.dll

An immutable action. Creating a scene containing notifications can send messages when it executes.

public sealed class RainPointSceneAction

Inheritance

object

RainPointSceneAction

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

Description

Gets a readable decoded description or an explicit unsupported-action message.

public string Description { get; }

Property Value

string

DeviceAddress

Gets the associated child RF address, or null when absent.

public int? DeviceAddress { get; }

Property Value

int?

Enabled

Gets the recognized enabled flag, or null for an unknown value.

public bool? Enabled { get; }

Property Value

bool?

HubId

Gets the associated positive hub ID, or null when absent.

public long? HubId { get; }

Property Value

long?

Kind

Gets the recognized action kind, or Unsupported without discarding its wire representation.

public RainPointSceneActionKind Kind { get; }

Property Value

RainPointSceneActionKind

Message

Gets the notification message, or null when this action is not a decoded notification.

public string? Message { get; }

Property Value

string

RainDelayDays

Gets the decoded rain-delay length in days, or null when unavailable.

public int? RainDelayDays { get; }

Property Value

int?

Recipients

Member identifiers or email addresses, never a protocol payload.

public IReadOnlyList<string> Recipients { get; }

Property Value

IReadOnlyList<string>

Zones

Gets the one-based zones targeted by a decoded rain-delay action, otherwise an empty list.

public IReadOnlyList<int> Zones { get; }

Property Value

IReadOnlyList<int>

Methods

Notify(string, IReadOnlyList<long>, IReadOnlyList<string>)

Creates a notification action for the specified home members and email recipients; creating the object sends nothing.

public static RainPointSceneAction Notify(string message, IReadOnlyList<long> memberIds, IReadOnlyList<string> emailAddresses)

Parameters

message string

The message text associated with this operation.

memberIds IReadOnlyList<long>

The home-member IDs that should receive the notification when the scene executes.

emailAddresses IReadOnlyList<string>

The email recipients that should receive the notification when the scene executes.

Returns

RainPointSceneAction

An immutable notification action; no message is sent by this factory.

Exceptions

ArgumentException

Use a message of 1..100 characters. Recipients must be distinct; at most five email addresses are supported. Use plain email addresses. At least one recipient is required; the combined recipient list is limited to 200 characters.

ArgumentNullException

A required argument is null.

RainDelay(RainPointHub, int, int, int)

Creates a rain-delay action for one timer zone; execution changes future plan behavior rather than stopping a running valve.

public static RainPointSceneAction RainDelay(RainPointHub hub, int address, int zone, int days)

Parameters

hub RainPointHub

A hub discovered through its home in the current account; its child list identifies valid RF addresses and models.

address int

The paired child's RF address within its hub, distinct from its cloud database ID.

zone int

The one-based zone number on the selected timer.

days int

The supported whole-day rain delay to apply when the scene executes.

Returns

RainPointSceneAction

An immutable rain-delay action; no device change is submitted by this factory.

Exceptions

ArgumentNullException

A required argument is null.

ArgumentException

Select a supported discovered timer.

ArgumentOutOfRangeException

An argument is outside the supported range described above.