VisitorIdSettingsBuilder

public class VisitorIdSettingsBuilder : CollectorSettingsBuilder

A builder used to enforce VisitorIdSettings.

  • Set the key to look for in the data layer when identifying a user.

    When a value is stored at this key in the data layer, it is taken as the identity of the current user and is used to automatically switch the visitor ID: a previously seen identity restores the visitor ID it was last associated with, a new identity is associated with a visitor ID of its own.

    Visitor Switching is disabled while no key is configured.

    Declaration

    Swift

    public func setVisitorIdentityKey(_ key: String) -> Self

    Parameters

    key

    The data layer key that holds the identity of the current user.

    Return Value

    The builder instance for method chaining.