Files
element-x-ios/ElementX/Sources/Application/Settings/MapTilerConfiguration.swift
T
2026-08-05 16:00:43 +02:00

39 lines
1.4 KiB
Swift

//
// Copyright 2025 Element Creations Ltd.
// Copyright 2025 New Vector Ltd.
//
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
// Please see LICENSE files in the repository root for full details.
//
import Foundation
/// All of the configuration necessary to use MapTiler maps.
///
/// The style IDs need to be generated with the account that the API key belongs to. For more information read
/// [FORKING.md](https://github.com/element-hq/element-x-ios/blob/develop/docs/FORKING.md#setup-the-location-sharing)
nonisolated struct MapTilerConfiguration: Equatable, Codable {
let baseURL: URL
/// The API key for fetching map tiles. When empty, the server at ``baseURL`` is expected to
/// provide the key itself, so none is sent with the requests.
///
/// When not set, location sharing will be disabled and any received locations will be shown
/// in the timeline with a generic blurred map image.
let apiKey: String?
/// A MapLibre style ID for a light-mode map.
let lightStyleID: String
/// A MapLibre style ID for a dark-mode map.
let darkStyleID: String
enum CodingKeys: String, CodingKey {
case baseURL = "base_url"
case apiKey = "api_key"
case lightStyleID = "light_style_id"
case darkStyleID = "dark_style_id"
}
var isEnabled: Bool {
apiKey != nil
}
}