Privacy

public class Privacy : NSObject

Toolbox: utility methods

  • Undocumented

    See more

    Declaration

    Swift

    public enum VisitorMode : String

  • Undocumented

    See more

    Declaration

    Swift

    public enum StorageFeature : String

  • Set user OptOut

    Declaration

    Swift

    @objc
public class func setVisitorOptOut()

  • Set user OptIn

    Declaration

    Swift

    @objc
public class func setVisitorOptIn()

  • Set User Privacy mode

    Declaration

    Swift

    public class func setVisitorMode(_ visitorMode: VisitorMode)

    Parameters

    visitorMode

    selected mode from user context

  • Set User Privacy mode

    Declaration

    Swift

    @objc
public class func setVisitorMode(_ visitorMode: String)

    Parameters

    visitorMode

    selected mode from user context

  • Set User Privacy mode

    Declaration

    Swift

    public class func setVisitorMode(_ visitorMode: VisitorMode, duration: Int)

    Parameters

    visitorMode

    selected mode from user context
    duration

    storage validity for privacy information (in days)

  • Set User Privacy custom mode

    Declaration

    Swift

    @objc
public class func setVisitorMode(_ visitorMode: String, duration: Int)

    Parameters

    visitorMode

    selected mode from user context
    duration

    storage validity for privacy information (in days)

  • Set User Privacy custom mode

    Declaration

    Swift

    @objc
public class func setVisitorMode(_ visitorMode: String, visitorConsent: Bool, customUserId: String?)

    Parameters

    visitorMode

    selected mode from user context
    visitorConsent

    visitor consent to tracking
    customUserId

    optional custom user id

  • Set User Privacy mode

    Declaration

    Swift

    @objc
public class func setVisitorMode(_ visitorMode: String, visitorConsent: Bool, customUserId: String?, duration: Int)

    Parameters

    visitorMode

    selected mode from user context
    visitorConsent

    visitor consent to tracking
    customUserId

    optional custom user id
    duration

    storage validity for privacy information (in days)

  • Get current User Privacy mode

    Declaration

    Swift

    @available(*, deprecated, message: "Use 'getVisitorModeString(﹚' method instead")
public class func getVisitorMode() -> VisitorMode

    Return Value

    user privacy mode

  • Get current User Privacy mode

    Declaration

    Swift

    @objc
public class func getVisitorModeString() -> String

    Return Value

    user privacy mode

  • Swift incompatibility to call similar method with variadic arguments (https://bugs.swift.org/browse/SR-128)

    Declaration

    Swift

    public class func extendIncludeBuffer(_ keys: String...)

  • Undocumented

    Declaration

    Swift

    public class func extendIncludeBuffer(_ visitorMode: VisitorMode, keys: String...)

  • Undocumented

    Declaration

    Swift

    public class func extendIncludeBuffer(visitorMode: String, keys: String...)

  • Swift incompatibility to call similar method with variadic arguments (https://bugs.swift.org/browse/SR-128)

    Declaration

    Swift

    @objc
public class func extendIncludeBuffer(_ keys: [String])

  • Undocumented

    Declaration

    Swift

    @objc
public class func extendIncludeBuffer(_ visitorMode: String, keys: [String])

  • Undocumented

    Declaration

    Swift

    public class func extendIncludeStorage(visitorMode: String, storageFeatureKeys: StorageFeature...)

  • Extend include buffer for visitor mode set in parameter (Only for exempt or custom)

    Declaration

    Swift

    @objc
public class func extendIncludeStorage(_ visitorMode: String, storageFeatureKeys: [String])

    Parameters

    visitorMode

    selected mode from user context
    storageFeatureKeys

    data can be stored/kept