Class Location

Namespace

OverKizApi.Models

Assembly

OverKizApi.dll

Geographical and address metadata associated with a Setup.

public sealed class Location

Inheritance

object

Location

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

AddressLine1

First line of the street address.

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

Property Value

string

AddressLine2

Second line of the street address (apartment, suite, etc.).

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

Property Value

string

City

City name.

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

Property Value

string

Country

Country name.

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

Property Value

string

CreationTime

Unix epoch millisecond timestamp when the location was created.

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

Property Value

long

DawnOffset

Manual dawn offset in minutes (positive = later, negative = earlier).

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

Property Value

int

DuskOffset

Manual dusk offset in minutes (positive = later, negative = earlier).

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

Property Value

int

LastUpdateTime

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

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

Property Value

long?

Latitude

Latitude coordinate in decimal degrees.

[JsonPropertyName("latitude")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public double? Latitude { get; init; }

Property Value

double?

Longitude

Longitude coordinate in decimal degrees.

[JsonPropertyName("longitude")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public double? Longitude { get; init; }

Property Value

double?

PostalCode

Postal / ZIP code.

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

Property Value

string

SummerSolsticeDuskMinutes

Minutes after sunset at summer solstice (used for dusk offset calculations).

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

Property Value

int?

Timezone

IANA time zone identifier (e.g. "Europe/Paris").

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

Property Value

string

TwilightAngle

Twilight angle used for custom-mode calculations.

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

Property Value

string

TwilightCity

City used for twilight calculations when TwilightMode is 3.

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

Property Value

string

TwilightMode

Twilight calculation mode (0 = civil, 1 = nautical, 2 = astronomical, 3 = custom city).

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

Property Value

int

TwilightOffsetEnabled

Whether manual dawn/dusk offsets are enabled.

[JsonPropertyName("twilightOffsetEnabled")]
public bool TwilightOffsetEnabled { get; init; }

Property Value

bool

WinterSolsticeDuskMinutes

Minutes after sunset at winter solstice (used for dusk offset calculations).

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

Property Value

int?