Class OverkizServer

Describes a named Overkiz-compatible cloud server endpoint. Instances are stored in SupportedServers and passed to OverkizClient on construction.

public sealed class OverkizServer

Inherited Members: object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

Optional URL of the end-user configuration portal for this server.

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

Base URL of the Overkiz enduserAPI for this server.

[JsonPropertyName("endpoint")]
public required string Endpoint { get; init; }

Name of the hardware manufacturer or reseller associated with this server.

[JsonPropertyName("manufacturer")]
public required string Manufacturer { get; init; }

Human-readable display name of the server / brand (e.g. "Somfy (Europe)").

[JsonPropertyName("name")]
public required string Name { get; init; }

Whether requests to this server must be scoped to a selected gateway via a custom header.

[JsonPropertyName("requiresGatewaySelection")]
public bool RequiresGatewaySelection { get; init; }