← Back to Documentation Home

CLASS

ContextBuilder

public class ContextBuilder

Fluent builder for creating Context objects

Methods

create()

public static func create() -> ContextBuilder

Create a new context builder - Returns: A new ContextBuilder instance

url(_:)

public func url(_ url: String) -> ContextBuilder

Add URL location parameter - Parameter url: The URL string - Returns: Self for chaining

Parameters

Name	Description
url	The URL string

ip(_:)

public func ip(_ ip: String) -> ContextBuilder

Add IP address parameter - Parameter ip: The IP address string - Returns: Self for chaining

Parameters

Name	Description
ip	The IP address string

deviceType(_:)

public func deviceType(_ deviceType: String) -> ContextBuilder

Add device type parameter - Parameter deviceType: The device type - Returns: Self for chaining

Parameters

Name	Description
deviceType	The device type

resolution(_:)

public func resolution(_ resolution: String) -> ContextBuilder

Add screen resolution parameter - Parameter resolution: The screen resolution - Returns: Self for chaining

Parameters

Name	Description
resolution	The screen resolution

userAgent(_:)

public func userAgent(_ userAgent: String) -> ContextBuilder

Add user agent parameter - Parameter userAgent: The user agent string - Returns: Self for chaining

Parameters

Name	Description
userAgent	The user agent string

browser(_:)

public func browser(_ browser: String) -> ContextBuilder

Add browser parameter - Parameter browser: The browser name - Returns: Self for chaining

Parameters

Name	Description
browser	The browser name

browserLanguage(_:)

public func browserLanguage(_ language: String) -> ContextBuilder

Add browser language parameter - Parameter language: The browser language - Returns: Self for chaining

Parameters

Name	Description
language	The browser language

browserVersion(_:)

public func browserVersion(_ version: String) -> ContextBuilder

Add browser version parameter - Parameter version: The browser version - Returns: Self for chaining

Parameters

Name	Description
version	The browser version

os(_:)

public func os(_ os: String) -> ContextBuilder

Add operating system parameter - Parameter os: The operating system name - Returns: Self for chaining

Parameters

Name	Description
os	The operating system name

language(_:)

public func language(_ language: String) -> ContextBuilder

Add language parameter - Parameter language: The language code - Returns: Self for chaining

Parameters

Name	Description
language	The language code

referrer(_:)

public func referrer(_ referrer: String) -> ContextBuilder

Add referrer parameter - Parameter referrer: The referrer URL - Returns: Self for chaining

Parameters

Name	Description
referrer	The referrer URL

referrerType(_:)

public func referrerType(_ referrerType: String) -> ContextBuilder

Add referrer type parameter - Parameter referrerType: The referrer type - Returns: Self for chaining

Parameters

Name	Description
referrerType	The referrer type

screen(_:)

public func screen(_ screenName: String) -> ContextBuilder

Add screen parameter (for mobile apps) - Parameter screenName: The screen name - Returns: Self for chaining

Parameters

Name	Description
screenName	The screen name

utm(_:)

public func utm(_ utmParams: [String: String]) -> ContextBuilder

Add UTM parameters - Parameter utmParams: Dictionary of UTM parameters - Returns: Self for chaining

Parameters

Name	Description
utmParams	Dictionary of UTM parameters

custom(_:_:)

public func custom(_ key: String, _ value: String) -> ContextBuilder

Add custom parameter - Parameters: - key: The custom parameter key - value: The custom parameter value - Returns: Self for chaining

Parameters

Name	Description
key	The custom parameter key
value	The custom parameter value

build()

public func build() -> Context

Build the final Context object - Returns: The constructed Context