Freshpaint iOS SDK Reference
Last updated
Last updated
You can get your environment id from the Freshpaint sources page.
The FPAnalyticsConfiguration
class provides the following configuration options:
The track
call can be used to manually send data to your destinations.
The identify
call attaches an identity or user properties to the user.
The screen
call triggers a screen event. This is the mobile equivalent of a pageview event. Some destinations will treat this event specially.
The group call associates the user with a user group. Some destinations let you work with groups of users. For example, Amplitude lets you group users together and then perform analytics on the individual groups. Most often, a group of users is all users that work for a single organization.
The alias
call can be used to specify one user id as an alias for another user id. Calling this will alias the current user's identity to the new provided identity. This is needed to implement identify for some destinations, specifically Mixpanel and Kissmetrics.
The reset
call clears any local Freshpaint data attached to this user. This does not clear any local data for any of your destinations. For example this may be useful if a user logs out and logs in to a different account.
Name
Swift/Objective-C Type
Description
Default
flushAt
UInt
/NSUInteger
How many events to queue before flushing the queue.
20
flushInterval
TimeInterval
/NSTimeInterval
The maximum amount of time to wait before flushing queued events.
10 seconds
maxQueueSize
UInt
/NSUInteger
The maximum number of events to queue before starting to drop the oldest ones.
1000
recordScreenViews
Bool
/BOOL
Whether or not screen view changes will automatically be recorded.
NO
trackApplicationLifecycleEvents
Bool
/BOOL
Whether or not the Application Installed
, Application Updated
, and Application Opened
events should be automtically tracked.
NO
Argument
Swift/Objective-C Type
Required
Description
event
String
/NSString *
Yes
The name of the event to send.
properties
[String : Any]
/NSDictionary *
No
Additional properties to attach to the event.
Argument
Swift/Objective-C Type
Required
Description
userId
String
/NSString *
No
The id to attach to the user.
traits
[String : Any]
/NSDictionary *
No
Additional user properties to attach to the user.
Argument
Swift/Objective-C Type
Required
Description
name
String
/NSString*
Yes
The name of the screen.
properties
[String : Any]
/NSDictionary *
No
Additional properties to attach to the event.
Argument
Swift/Objective-C Type
Required
Description
groupId
String
/NSString *
Yes
The id of the group to add the user to.
traits
[String : Any]
/NSDictinoary *
No
Additional properties to attach to the group.
Argument
Swift/Objective-C Type
Required
Description
newId
String
/NSString *
Yes
The id you want to alias the current user's identity to.