Table of Contents

Class Scenario

Namespace
OverKizApi.Models
Assembly
OverKizApi.dll

A named scenario (action group) stored in the setup that can be triggered by name or OID. Scenarios can include optional notification settings and scheduled triggers.

public sealed class Scenario
Inheritance
Scenario
Inherited Members

Properties

Actions

The actions (device command sets) that make up this scenario.

[JsonPropertyName("actions")]
public IReadOnlyList<Action> Actions { get; init; }

Property Value

IReadOnlyList<Action>

The actions (device command sets) that make up this scenario.

CreationTime

Unix epoch millisecond timestamp when the scenario was created.

[JsonPropertyName("creationTime")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public long CreationTime { get; init; }

Property Value

long

Unix epoch millisecond timestamp when the scenario was created.

Id

Alias for Oid; provided for convenience.

[JsonIgnore]
public string? Id { get; }

Property Value

string

Alias for Oid; provided for convenience.

Label

User-visible label for the scenario.

[JsonPropertyName("label")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Label { get; init; }

Property Value

string

User-visible label for the scenario.

LastUpdateTime

Unix epoch millisecond timestamp of the most recent update, or null if never updated.

[JsonPropertyName("lastUpdateTime")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public long? LastUpdateTime { get; init; }

Property Value

long?

Unix epoch millisecond timestamp of the most recent update, or null if never updated.

Metadata

Arbitrary metadata string attached to this scenario.

[JsonPropertyName("metadata")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Metadata { get; init; }

Property Value

string

Arbitrary metadata string attached to this scenario.

NotificationCondition

Condition expression evaluated before sending a notification.

[JsonPropertyName("notificationCondition")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? NotificationCondition { get; init; }

Property Value

string

Condition expression evaluated before sending a notification.

NotificationText

Body text of the push notification sent when this scenario executes.

[JsonPropertyName("notificationText")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? NotificationText { get; init; }

Property Value

string

Body text of the push notification sent when this scenario executes.

NotificationTitle

Title of the push notification sent when this scenario executes.

[JsonPropertyName("notificationTitle")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? NotificationTitle { get; init; }

Property Value

string

Title of the push notification sent when this scenario executes.

NotificationTypeMask

Bitmask controlling which notification types fire when this scenario runs.

[JsonPropertyName("notificationTypeMask")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? NotificationTypeMask { get; init; }

Property Value

int?

Bitmask controlling which notification types fire when this scenario runs.

Oid

Unique OID of this scenario.

[JsonPropertyName("oid")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Oid { get; init; }

Property Value

string

Unique OID of this scenario.

Shortcut

Whether this scenario appears as a shortcut in the Overkiz app.

[JsonPropertyName("shortcut")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? Shortcut { get; init; }

Property Value

bool?

Whether this scenario appears as a shortcut in the Overkiz app.