Class Gateway

Namespace

OverKizApi.Models

Assembly

OverKizApi.dll

Represents a physical Overkiz-compatible gateway (hub) registered in a setup. A setup may have more than one gateway.

public sealed class Gateway

Inheritance

object

Gateway

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

Alive

Whether the gateway is currently sending heartbeat signals to the cloud.

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

Property Value

bool?

Connectivity

Live connectivity state of the gateway.

[JsonPropertyName("connectivity")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public Connectivity? Connectivity { get; init; }

Property Value

Connectivity

Functions

Comma-separated list of functional capability flags reported by the gateway.

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

Property Value

string

GatewayId

Unique gateway serial number (e.g. "1234-5678-9012").

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

Property Value

string

Id

Alias for GatewayId; provided for convenience.

[JsonIgnore]
public string? Id { get; }

Property Value

string

Mode

Gateway operating mode string (see GatewayMode).

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

Property Value

string

Partners

Third-party partner integrations activated on this gateway.

[JsonPropertyName("partners")]
public IReadOnlyList<Partner> Partners { get; init; }

Property Value

IReadOnlyList<Partner>

PlaceOid

OID of the place (room/floor) the gateway is assigned to.

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

Property Value

string

SubType

Hardware model / product family of the gateway.

[JsonConverter(typeof(GatewaySubTypeJsonConverter))]
[JsonPropertyName("subType")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public GatewaySubType? SubType { get; init; }

Property Value

GatewaySubType?

SyncInProgress

Whether a device synchronisation cycle is in progress.

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

Property Value

bool?

TimeReliable

Whether the gateway's real-time clock is synchronised.

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

Property Value

bool?

Type

Hardware product family of the gateway.

[JsonConverter(typeof(GatewayTypeJsonConverter))]
[JsonPropertyName("type")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public GatewayType? Type { get; init; }

Property Value

GatewayType?

UpToDate

Whether the gateway firmware is up to date.

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

Property Value

bool?

UpdateStatus

Current firmware update lifecycle state.

[JsonPropertyName("updateStatus")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public GatewayUpdateStatus? UpdateStatus { get; init; }

Property Value

GatewayUpdateStatus?