Skip to content

Commit

Permalink
Add @objc and docstrings to CrossDeviceParameterConfiguration
Browse files Browse the repository at this point in the history
  • Loading branch information
greg-el committed Sep 28, 2023
1 parent 3ccf3a9 commit fd93a24
Showing 1 changed file with 13 additions and 18 deletions.
31 changes: 13 additions & 18 deletions Sources/Snowplow/Tracker/CrossDeviceParameterConfiguration.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit fd93a24

Please sign in to comment.