mirror of
https://gitlab.opencode.de/bwi/bundesmessenger/clients/bundesmessenger-ios.git
synced 2026-04-18 23:48:29 +02:00
Move Analytics from Managers to Modules.
This commit is contained in:
65
Riot/Modules/Analytics/AnalyticsSettings.swift
Normal file
65
Riot/Modules/Analytics/AnalyticsSettings.swift
Normal file
@@ -0,0 +1,65 @@
|
||||
//
|
||||
// Copyright 2021 New Vector Ltd
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import Foundation
|
||||
|
||||
/// An analytics settings event from the user's account data.
|
||||
struct AnalyticsSettings {
|
||||
static let eventType = "im.vector.analytics"
|
||||
|
||||
enum Constants {
|
||||
static let idKey = "id"
|
||||
static let webOptInKey = "pseudonymousAnalyticsOptIn"
|
||||
}
|
||||
|
||||
/// A randomly generated analytics token for this user.
|
||||
/// This is suggested to be a UUID string.
|
||||
let id: String?
|
||||
|
||||
/// Whether the user has opted in on web or not. This is unused on iOS but necessary
|
||||
/// to store here so that it's value is preserved when updating the account data if we
|
||||
/// generated an ID on iOS.
|
||||
///
|
||||
/// `true` if opted in on web, `false` if opted out on web and `nil` if the web prompt is not yet seen.
|
||||
private let webOptIn: Bool?
|
||||
}
|
||||
|
||||
extension AnalyticsSettings {
|
||||
// Private as AnalyticsSettings should only be created from an MXSession
|
||||
private init(dictionary: Dictionary<AnyHashable, Any>?) {
|
||||
self.id = dictionary?[Constants.idKey] as? String
|
||||
self.webOptIn = dictionary?[Constants.webOptInKey] as? Bool
|
||||
}
|
||||
|
||||
/// A dictionary representation of the settings.
|
||||
var dictionary: Dictionary<AnyHashable, Any> {
|
||||
var dictionary = [AnyHashable: Any]()
|
||||
dictionary[Constants.idKey] = id
|
||||
dictionary[Constants.webOptInKey] = webOptIn
|
||||
|
||||
return dictionary
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - Public initializer
|
||||
|
||||
extension AnalyticsSettings {
|
||||
/// Create the analytics settings from account data.
|
||||
/// - Parameter accountData: The account data to read the event from.
|
||||
init(accountData: MXAccountData) {
|
||||
self.init(dictionary: accountData.accountData(forEventType: AnalyticsSettings.eventType))
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user