From fd93a24ccb644c93b0feb65b12d0624453062110 Mon Sep 17 00:00:00 2001 From: Greg Leonard <45019882+greg-el@users.noreply.github.com> Date: Thu, 28 Sep 2023 09:12:52 +0100 Subject: [PATCH] Add @objc and docstrings to CrossDeviceParameterConfiguration --- .../CrossDeviceParameterConfiguration.swift | 31 ++++++++----------- 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/Sources/Snowplow/Tracker/CrossDeviceParameterConfiguration.swift b/Sources/Snowplow/Tracker/CrossDeviceParameterConfiguration.swift index ac226555a..ea4cee547 100644 --- a/Sources/Snowplow/Tracker/CrossDeviceParameterConfiguration.swift +++ b/Sources/Snowplow/Tracker/CrossDeviceParameterConfiguration.swift @@ -12,26 +12,21 @@ // language governing permissions and limitations there under. import Foundation - -/// + /// Configuration object for ``TrackerController/decorateLink`` -/// -/// Whether to include the following values when decorating a link: -/// - `sessionId`: Value of ``SessionController.sessionId`` -/// - `subjectUserId`: Value of ``Subject.userId`` -/// - `sourceId`: Value of ``Tracker.appId`` -/// - `platform`: Value of ``Tracker.platform`` -/// - `reason`: Optional identifier/information for cross-navigation -/// -/// ``sourceId`` and ``sessionId`` are enabled by default. -public class CrossDeviceParameterConfiguration : NSObject { - var sessionId: Bool - var subjectUserId: Bool - var sourceId: Bool - var sourcePlatform: Bool - var reason: String? +@objc public class CrossDeviceParameterConfiguration : NSObject { + /// Whether to include the value of ``SessionController.sessionId`` when decorating a link (enabled by default) + @objc var sessionId: Bool + /// Whether to include the value of ``Subject.userId`` when decorating a link + @objc var subjectUserId: Bool + /// Whether to include the value of ``Tracker.appId`` when decorating a link (enabled by default) + @objc var sourceId: Bool + /// Whether to include the value of ``Tracker.platform`` when decorating a link + @objc var sourcePlatform: Bool + /// Optional identifier/information for cross-navigation + @objc var reason: String? - init( + @objc init( sessionId: Bool = true, subjectUserId: Bool = false, sourceId: Bool = true,