added iOS source code

[wl-app.git] / iOS / Pods / MatomoTracker / MatomoTracker / Event.swift

diff --git a/iOS/Pods/MatomoTracker/MatomoTracker/Event.swift b/iOS/Pods/MatomoTracker/MatomoTracker/Event.swift
new file mode 100644 (file)
index 0000000..14e274d
--- /dev/null
+++ b/iOS/Pods/MatomoTracker/MatomoTracker/Event.swift
@@ -0,0 +1,121 @@
+//
+//  Event.swift
+//  PiwikTracker
+//
+//  Created by Cornelius Horstmann on 21.12.16.
+//  Copyright © 2016 PIWIK. All rights reserved.
+//
+
+import Foundation
+import CoreGraphics
+
+/// Represents an event of any kind.
+///
+/// - Note: Should we store the resolution in the Event (cleaner) or add it before transmission (smaller)?
+/// - Todo: 
+///     - Add Campaign Parameters: _rcn, _rck
+///     - Add Action info
+///     - Event Tracking info
+///     - Add Content Tracking info
+///     - Add Ecommerce info
+///
+/// # Key Mapping:
+/// Most properties represent a key defined at: [Tracking HTTP API](https://developer.piwik.org/api-reference/tracking-api). Keys that are not supported for now are:
+///
+/// - idsite, rec, rand, apiv, res, cookie,
+/// - All Plugins: fla, java, dir, qt, realp, pdf, wma, gears, ag
+/// - cid: We will use the uid instead of the cid.
+public struct Event {
+    let siteId: String
+    let uuid: NSUUID
+    let visitor: Visitor
+    let session: Session
+    
+    /// The Date and Time the event occurred.
+    /// api-key: h, m, s
+    let date: Date
+    
+    /// The full URL for the current action. 
+    /// api-key: url
+    let url: URL?
+    
+    /// api-key: action_name
+    let actionName: [String]
+    
+    /// The language of the device.
+    /// Should be in the format of the Accept-Language HTTP header field.
+    /// api-key: lang
+    let language: String
+    
+    /// Should be set to true for the first event of a session.
+    /// api-key: new_visit
+    let isNewSession: Bool
+    
+    /// Currently only used for Campaigns
+    /// api-key: urlref
+    let referer: URL?
+    let screenResolution : CGSize = Device.makeCurrentDevice().screenSize
+    
+    /// api-key: _cvar
+    let customVariables: [CustomVariable]
+    
+    /// Event tracking
+    /// https://piwik.org/docs/event-tracking/
+    let eventCategory: String?
+    let eventAction: String?
+    let eventName: String?
+    let eventValue: Float?
+    
+    /// Campaign tracking
+    /// https://matomo.org/docs/tracking-campaigns/
+    let campaignName: String?
+    let campaignKeyword: String?
+
+    /// Search tracking
+    /// api-keys: search, search_cat, search_count
+    let searchQuery: String?
+    let searchCategory: String?
+    let searchResultsCount: Int?
+    
+    let dimensions: [CustomDimension]
+    
+    let customTrackingParameters: [String:String]
+    
+    /// Content tracking
+    /// https://matomo.org/docs/content-tracking/
+    let contentName: String?
+    let contentPiece: String?
+    let contentTarget: String?
+    let contentInteraction: String?
+}
+
+extension Event {
+    public init(tracker: MatomoTracker, action: [String], url: URL? = nil, referer: URL? = nil, eventCategory: String? = nil, eventAction: String? = nil, eventName: String? = nil, eventValue: Float? = nil, customTrackingParameters: [String:String] = [:], searchQuery: String? = nil, searchCategory: String? = nil, searchResultsCount: Int? = nil, dimensions: [CustomDimension] = [], variables: [CustomVariable] = [], contentName: String? = nil, contentInteraction: String? = nil, contentPiece: String? = nil, contentTarget: String? = nil) {
+        self.siteId = tracker.siteId
+        self.uuid = NSUUID()
+        self.visitor = tracker.visitor
+        self.session = tracker.session
+        self.date = Date()
+        self.url = url ?? tracker.contentBase?.appendingPathComponent(action.joined(separator: "/"))
+        self.actionName = action
+        self.language = Locale.httpAcceptLanguage
+        self.isNewSession = tracker.nextEventStartsANewSession
+        self.referer = referer
+        self.eventCategory = eventCategory
+        self.eventAction = eventAction
+        self.eventName = eventName
+        self.eventValue = eventValue
+        self.searchQuery = searchQuery
+        self.searchCategory = searchCategory
+        self.searchResultsCount = searchResultsCount
+        self.dimensions = tracker.dimensions + dimensions
+        self.campaignName = tracker.campaignName
+        self.campaignKeyword = tracker.campaignKeyword
+        self.customTrackingParameters = customTrackingParameters
+        self.customVariables = tracker.customVariables + variables
+        self.contentName = contentName
+        self.contentPiece = contentPiece
+        self.contentTarget = contentTarget
+        self.contentInteraction = contentInteraction
+    }
+}