TrackingParameters

public struct TrackingParameters

A struct to hold all the values to be sent to the trackers.

  • The event name

    Declaration

    Swift

    public let eventName: String

  • Item Id

    Declaration

    Swift

    public var itemId: String?

  • Name

    Declaration

    Swift

    public var name: String?

  • Description

    Declaration

    Swift

    public var description: String?

  • Category

    Declaration

    Swift

    public var category: String?

  • Content Type

    Declaration

    Swift

    public var contentType: String?

  • Define custom parameters here

    Declaration

    Swift

    public var customParameters: [String : Any]

  • Init with event name only. The remaining parameters are all set to nil.

    Declaration

    Swift

    public init(eventName: String)

    Parameters

    eventName

    event name

  • Init with all the parameters. Event name is required, the remaining parameters are optionals.

    Declaration

    Swift

    public init(eventName: String,
            itemId: String?,
            name: String?,
            description: String?,
            category: String?,
            contentType: String?)

    Parameters

    eventName

    event name
    itemId

    item id
    name

    name
    description

    description
    category

    category
    contentType

    content type

  • Init with event name and content type only. The remaining parameters are all set to nil.

    Declaration

    Swift

    public init(eventName: String,
            contentType: String?)

    Parameters

    eventName

    event name
    contentType

    content type

  • Init with event name and name only. The remaining parameters are all set to nil.

    Declaration

    Swift

    public init(eventName: String,
            name: String?)

    Parameters

    eventName

    event name
    name

    name

  • The info displayed for the local notification when debugging tracking.

    Declaration

    Swift

    public func debugInfo() -> String

    Return Value

    A string with each non-nil parameter