Table of Contents

Class Place

Namespace
OverKizApi.Models
Assembly
OverKizApi.dll

A place in the home hierarchy (house, floor, or room).

public sealed class Place
Inheritance
Place
Inherited Members

Properties

CreationTime

Unix epoch millisecond timestamp when the place was created.

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

Property Value

long

Unix epoch millisecond timestamp when the place 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 place (e.g. "Living Room").

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

Property Value

string

User-visible label for the place (e.g. "Living Room").

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.

Oid

Unique OID of this place.

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

Property Value

string

Unique OID of this place.

SubPlaces

Child places (floors within a house, rooms within a floor).

[JsonPropertyName("subPlaces")]
public IReadOnlyList<Place> SubPlaces { get; init; }

Property Value

IReadOnlyList<Place>

Child places (floors within a house, rooms within a floor).

Type

Place type: 0 = house, 1 = floor, 2 = room.

[JsonPropertyName("type")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public int Type { get; init; }

Property Value

int

Place type: 0 = house, 1 = floor, 2 = room.