iOS – API Reference


This page lists all public classes, enumerations and other resources available when using the Kochava iOS/tvOS SDKs and is intended to be used only as a developer quick reference guide. For examples and discussion surrounding SDK usage please refer to our Using the SDK support documentation.


KochavaTracker

Class
The class KochavaTracker provides an interface between a host application and Kochava’s Attribution and Analytics Servers. A tracker manages the exchange of data between these two entities, along with the associated tasks and network transactions.

 

Getting the Shared Tracker:

A shared instance, for convenience.
Usage:
Starting the Tracker

 

Configure a Tracker:

The designated initialization method for an instance of class KochavaTracker. This method is used to configure a newly instantiated KochavaTracker for use when you are not using the provided shared instance.
Usage:
Starting the Tracker
Custom Tracker Configuration

Invalidates an instance of class KochavaTracker.

 

Consent:

An instance of class KVAConsent, providing intelligent consent management.
Usage:
Checking Consent Status
Prompting For Consent

 

Core Functionality:

Sends a standard event using an EventParameters object.
Usage:
Tracking Events

Creates an instance of class KochavaEvent which has a nameString and an optional infoDictionary, and then sends it to the Kochava Server. A convenience method.
Usage:
Tracking Events

Creates an instance of class KochavaEvent which has a nameString and an optional infoString, and then sends it to the Kochava Server. A convenience method.
Usage:
Tracking Events

Sets a boolean switch which indicates whether a user of the app wants to limit advertising tracking.
Usage:
Enabling App Limit Ad Tracking

A boolean which tells the tracker that it should sleep.
Usage:
Sleeping The Tracker

 

Retrieving Information:

Gets the attribution results as a dictionary.
Usage:
Retrieving Attribution

Gets the device identification string used by the tracker.
Usage:
Getting the Device ID

Gets the version string of the SDK.
Example: “libKochavaTrackeriOS 3.7.0”
Usage:
Getting the SDK Version

 

Push Notifications:

Add a remote notifications device token.
Usage:
Push Notifications

Remove a remote notifications device token.
Usage:
Push Notifications


trackerParametersDictionary

Dictionary
A dictionary with standardized keys used to configure an instance of class KochavaTracker.
Usage:
For information about using this class, see: Custom Tracker Configuration

constant kKVAParamAppGUIDStringKey
constant kKVAParamAppLimitAdTrackingBoolKey
constant kKVAParamConsentIntelligentManagementBoolKey
constant kKVAParamConsentManualManagedRequirementsBoolKey
constant kKVAParamIdentityLinkDictionaryKey
constant kKVAParamLogLevelEnumKey
constant kKVAParamLogMultiLineBoolKey
constant kKVAParamRetrieveAttributionBoolKey
constant kKVAParamStorageIdStringKey


Log Levels

Constants
A set of constants for log levels which may be provided when configuring the tracker.
Usage:
Enabling Logging

kKVALogLevelEnumNone
kKVALogLevelEnumError
kKVALogLevelEnumWarn
kKVALogLevelEnumInfo
kKVALogLevelEnumDebug
kKVALogLevelEnumTrace


KochavaTrackerDelegate

Protocol
A delegate protocol for class KochavaTracker.

Notifies the delegate that attribution data has been retrieved from the server, and provides the data in a dictionary.
Usage:
Retrieving Attribution Results


KVAConsent

Class
The class KVAConsent provides a means of managing user consent in relationship to GDPR.

 

Prompting for Consent

A string containing a high level description concerning consent.
Usage:
Prompting For Consent

A function to be called when there has been a prompt for consent.
Usage:
Reporting Consent Results

An array of instances of class KVAPartner.
Usage:
Prompting For Consent

Returns a boolean indicating if a prompt for consent should be made.
Usage:
Prompting For Consent

A function which may be called to notify that a prompt for consent will be made.
Usage:
Prompting For Consent

 

Checking Consent Status:

A block which is called when there is an update to consent.
Usage:
Checking Consent Status
Prompting For Consent

Returns a boolean indicating if consent is granted.
Usage:
Checking Consent Status

Returns a boolean indicating if consent is granted, denied, or there is no response.
Usage:
Checking Consent Status

Returns a date for when consent was granted.
Usage:
Checking Consent Status

Returns a boolean indicating if the app may calculate (or gather) data which may be subject to consent.
Usage:
Checking Consent Status

Returns a boolean indicating if the app may keep (or retain in memory) data which may be subject to consent.
Usage:
Checking Consent Status

Returns a boolean indicating if the app may persist (or retain in persistent storage) data which may be subject to consent.
Usage:
Checking Consent Status

Returns a boolean indicating if the app may share (or export) data which may be subject to consent.
Usage:
Checking Consent Status

 

Other Functionality:

A boolean indicating if consent is required.
Usage:
Intelligent Consent Management – Other Functionality

A boolean indicating if consent is required, consent not required, or if it is not known whether or not consent is required.
Usage:
Intelligent Consent Management – Other Functionality

A boolean indicating the user’s response to a prompt for consent.
Usage:
Intelligent Consent Management – Other Functionality

A date representing the last time the user did respond concerning consent.
Usage:
Intelligent Consent Management – Other Functionality


KVAPartner

Class
The class KVAPartner defines a partner in the context of managing user consent in relationship to GDPR.

 

Prompting for Consent:

A string containing a description of the partner.
Usage:
Prompting For Consent

A string containing the name of the partner.
Usage:
Prompting For Consent

Returns a boolean indicating if this partner should be included in a prompt for consent.
Usage:
Prompting For Consent

 

Checking Consent Status:

Returns a date indicating when the user did grant consent.
Usage:
Prompting For Consent

A boolean indicating the user’s response.
Usage:
Prompting For Consent

The date when the user did respond to consent.
Usage:
Prompting For Consent


KochavaEventTypeEnum

Enumeration
An enumerated type for an instance of class KochavaEvent.
Usage:
Tracking Events

  • Achievement
  • AddToCart
  • AddToWishList
  • AdView
  • CheckoutStart
  • ConsentGranted
  • Custom
  • DeepLink
  • Gameplay
  • LevelComplete
  • Purchase
  • Rating
  • RegistrationComplete
  • Search
  • TutorialComplete
  • View

Usage:
Tracking Events


KocahvaEvent

Class
The class KochavaEvent provides a means of defining a post-install event, providing standardized parameters.
Usage:
Tracking Events

 

Creating an Event:

The designated initialization method for an instance of class KochavaEvent.
Usage:
Tracking Events

  • appleWatchBool
  • appleWatchIdString
  • appStoreReceiptBase64EncodedString
  • checkoutAsGuestString
  • contentIdString
  • contentTypeString
  • currencyString
  • customEventNameString
  • date
  • dateString
  • descriptionString
  • destinationString
  • durationTimeIntervalNumber
  • endDate
  • endDateString
  • infoDictionary
  • infoString
  • itemAddedFromString
  • levelString
  • maxRatingValueDoubleNumber
  • nameString
  • orderIdString
  • originString
  • priceDoubleNumber
  • quantityDoubleNumber
  • ratingValueDoubleNumber
  • receiptIdString
  • referralFromString
  • registrationMethodString
  • resultsString
  • scoreString
  • searchTermString
  • sourceString
  • spatialXDoubleNumber
  • spatialYDoubleNumber
  • spatialZDoubleNumber
  • startDate
  • startDateString
  • successString
  • uriString
  • userIdString
  • userNameString
  • validatedString

 
 

Last Modified: Nov 30, 2018 at 11:36 am