MoEngageSDKAnalytics

@objc
public class MoEngageSDKAnalytics : NSObject

Class to track data on the MoEngage Platform.


                    
                    
                    sharedInstance

Singleton class instance

Declaration

Swift

@objc
public static let sharedInstance: MoEngageSDKAnalytics

Track App Status


                    
                    
                    appStatus(_:forAppID:)

This method tells the SDK whether it is a fresh install or an existing application was updated.

Declaration

Swift

@objc
public func appStatus(_ appStatus: MoEngageAppStatus, forAppID appID: String? = nil)

Parameters

`appStatus`	Enum of type `MoEngageAppStatus`
`appID`	MoEngage Account Identifier.


                    
                    
                    appStatus(_:)

This method tells the default SDK instance whether it is a fresh install or an existing application was updated.

Declaration

Swift

@objc
public func appStatus(_ appStatus: MoEngageAppStatus)

Parameters


                                appStatus

Enum of type MoEngageAppStatus

Track Event


                    
                    
                    trackEvent(_:withProperties:)

Track Event for Default MoEngage Instance.

Declaration

Swift

@objc
public func trackEvent(_ name: String, withProperties properties: MoEngageProperties? = nil)

Parameters

`name`	name of the event
`properties`	instance of type `MoEngageProperties` that contains attributes related to event


                    
                    
                    trackEvent(_:withProperties:forAppID:)

Track Event for Secondary instance

Declaration

Swift

@objc
public func trackEvent(_ name: String, withProperties properties: MoEngageProperties? = nil, forAppID appID: String? = nil)

Parameters

`name`	event name
`properties`	instance of type `MoEngageProperties` that contains attributes related to event
`appID`	MoEngage Account Identifier.

Flush Events


                    
                    
                    flush(forAppID:withCompletionBlock:)

Sync the tracked events instantaneously for Secondary instance

Declaration

Swift

@objc
public func flush(forAppID appID: String? = nil, withCompletionBlock completionBlock: ((Bool) -> Void)? = nil)

Parameters

`appID`	MoEngage Account Identifier.
`completionBlock`	completion block to be called after events are flushed out

flush()
Sync the tracked events instantaneously for Default instance
Declaration
Swift

@objc public func flush()


                    
                    
                    flush(forAppID:)

Sync the tracked events instantaneously for Secondary instance

Declaration

Swift

@objc
public func flush(forAppID appID: String? = nil)

Parameters


                                appID

MoEngage Account identifier


                    
                    
                    flush(withCompletionBlock:)

Sync the tracked events instantaneously for Default instance

Declaration

Swift

@objc
public func flush(withCompletionBlock completionBlock: ((Bool) -> Void)? = nil)

Parameters


                                completionBlock

completion block to be called after events are flushed out

Track Locale

trackLocale()
Tracks device locale.
Declaration
Swift

@objc public func trackLocale()


                    
                    
                    trackLocale(forAppID:)

Tracks device locale.

Declaration

Swift

@objc
public func trackLocale(forAppID appID: String? = nil)

Parameters


                                appID

MoEngage Account identifier

Reset User


                    
                    
                    resetUser(forAppID:withCompletionBlock:)

Invalidates the existing sessions and user attributes and treats all actions performed by the user as a new user after this method is called

Declaration

Swift

@objc
public func resetUser(forAppID appID: String? = nil, withCompletionBlock completionBlock: ((Bool) -> Void)? = nil)

Parameters

`appID`	optional account identifier.
`completionBlock`	Returns true if reset is successful else false

resetUser()
Invalidates the existing sessions and user attributes and treats all actions performed by the user as a new user after this method is called
Declaration
Swift

@objc public func resetUser()


                    
                    
                    resetUser(withCompletionBlock:)

Invalidates the existing sessions and user attributes and treats all actions performed by the user as a new user after this method is called

Declaration

Swift

@objc
public func resetUser(withCompletionBlock completionBlock: ((Bool) -> Void)? = nil)

Parameters


                                completionBlock

Returns true if reset is successful else false


                    
                    
                    resetUser(forAppID:)

Invalidates the existing sessions and user attributes and treats all actions performed by the user as a new user after this method is called

Declaration

Swift

@objc
public func resetUser(forAppID appID: String? = nil)

Parameters


                                appID

MoEngage Account identifier

OptOut Methods


                    
                    
                    enableDataTracking(forAppID:)

API to enable data tracking.

Declaration

Swift

@objc
public func enableDataTracking(forAppID appID: String? = nil)

Parameters


                                appID

MoEngage Account identifier

enableDataTracking()
API to enable data tracking.
Declaration
Swift

@objc public func enableDataTracking()


                    
                    
                    disableDataTracking(forAppID:)

Optionally opt-out of data tracking. When data tracking is opted out no custom event or user attribute is tracked on MoEngage Platform.

Declaration

Swift

@objc
public func disableDataTracking(forAppID appID: String? = nil)

Parameters


                                appID

MoEngage Account identifier

disableDataTracking()
Optionally opt-out of data tracking. When data tracking is opted out no custom event or user attribute is tracked on MoEngage Platform.
Declaration
Swift

@objc public func disableDataTracking()


                    
                    
                    enableIDFATracking(forAppID:)

Enable IDFA tracking

Declaration

Swift

@objc
public func enableIDFATracking(forAppID appID: String? = nil)

Parameters


                                appID

MoEngage Account identifier

enableIDFATracking()
Enable IDFA tracking
Declaration
Swift

@objc public func enableIDFATracking()


                    
                    
                    disableIDFATracking(forAppID:)

Disable IDFA tracking

Declaration

Swift

@objc
public func disableIDFATracking(forAppID appID: String? = nil)

Parameters


                                appID

MoEngage Account identifier

disableIDFATracking()
Disable IDFA tracking
Declaration
Swift

@objc public func disableIDFATracking()


                    
                    
                    enableIDFVTracking(forAppID:)

Enable IDFV tracking

Declaration

Swift

@objc
public func enableIDFVTracking(forAppID appID: String? = nil)

Parameters


                                appID

MoEngage Account identifier

enableIDFVTracking()
Enable IDFV tracking
Declaration
Swift

@objc public func enableIDFVTracking()


                    
                    
                    disableIDFVTracking(forAppID:)

Disable IDFV tracking

Declaration

Swift

@objc
public func disableIDFVTracking(forAppID appID: String? = nil)

Parameters


                                appID

MoEngage Account identifier

disableIDFVTracking()
Disable IDFV tracking
Declaration
Swift

@objc public func disableIDFVTracking()

Process URL


                    
                    
                    processURL(_:)

Update source based on query params of the URL

Declaration

Swift

@objc
public func processURL(_ url: URL?)

Parameters

url

URL that contains source information in query params

Set Delegate


                    
                    
                    setDelegate(delegate:forAppID:)

Set the Analytics delegate to get the callback for various Analytics events

Declaration

Swift

@objc
public func setDelegate(delegate: MoEngageAnalyticsCallBack, forAppID appID: String? = nil)

Parameters

`delegate`	Instance that confirms to `MoEngageAnalyticsProtocol`
`appID`	Optional Account Identifier


                    
                    
                    setDeviceAttribute(_:withName:forWorkspaceId:)

Set custom device attribute for workspace.

Supported value data types are:

Number (Int, Double, Float)
String
Boolean

Date

Date (ISO 8601 String)

Declaration

Swift

@available(iOSApplicationExtension, unavailable)
func setDeviceAttribute(
    _ value: Any, withName attributeName: String, forWorkspaceId workspaceId: String? = nil
)

Parameters

`value`	attribute value
`attributeName`	attribute name
`workspaceId`	MoEngage Workspace identifier


                    
                    
                    setDeviceAttribute(_:withName:)

Set custom device attribute for Default instance.

Supported value data types are:

Number (Int, Double, Float)
String
Boolean

Date

Date (ISO 8601 String)

Declaration

Swift

@available(iOSApplicationExtension, unavailable)
func setDeviceAttribute(
    _ value: Any, withName attributeName: String
)

Parameters

`value`	attribute value
`attributeName`	attribute name


                    
                    
                    identifyUser(identities:workspaceId:)

Add unique identities to current user.

Declaration

Swift

func identifyUser(identities: [String : String], workspaceId: String? = nil)

Parameters

`identities`	The identities uniquely identifying current user.
`workspaceId`	MoEngage Workspace Identifier.


                    
                    
                    identifyUser(identity:workspaceId:)

Add unique identifier uid to current user.

Declaration

Swift

func identifyUser(identity: String, workspaceId: String? = nil)

Parameters

`identity`	The identifier uniquely identifying current user.
`workspaceId`	MoEngage Workspace Identifier.


                    
                    
                    getUserIdentities(workspaceId:completion:)

Get all the identities set for current user.

Declaration

Swift

func getUserIdentities(
    workspaceId: String? = nil,
    completion: @escaping ([String: String]) -> Void
)

Parameters

`workspaceId`	MoEngage Workspace Identifier.
`completion`	The block where identties will be provided on main thread.

Portfolio User Attribute APIs with Level Support


                    
                    
                    setUserAttribute(_:withAttributeName:level:forAppID:)

Set custom user attribute for Secondary instance with level

Declaration

Swift

@objc
public func setUserAttribute(
    _ value: Any?, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel, forAppID appID: String?
)

Parameters

`value`	attribute value
`attributeName`	attribute name
`level`	level at which attribute should be set
`appID`	MoEngage account identifier


                    
                    
                    setUserAttribute(_:withAttributeName:level:)

Set custom user attribute for Default instance with level

Declaration

Swift

@objc
public func setUserAttribute(
    _ value: Any?, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel
)

Parameters

`value`	attribute value
`attributeName`	attribute name
`level`	level at which attribute should be set


                    
                    
                    setUserAttributeEpochTime(_:withAttributeName:level:forAppID:)

Set epoch time for Secondary instance with level

Declaration

Swift

@objc
public func setUserAttributeEpochTime(
    _ dateEpoch: Double, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel, forAppID appID: String?
)

Parameters

`dateEpoch`	Epoch date of type double
`attributeName`	attribute name of type String
`level`	level at which attribute should be set
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeEpochTime(_:withAttributeName:level:)

Set epoch time for Default instance with level

Declaration

Swift

@objc
public func setUserAttributeEpochTime(
    _ dateEpoch: Double, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel
)

Parameters

`dateEpoch`	Epoch date of type double
`attributeName`	attribute name of type String
`level`	level at which attribute should be set


                    
                    
                    setUserAttributeDate(_:withAttributeName:level:forAppID:)

Set User attribute date for Secondary instance with level

Declaration

Swift

@objc
public func setUserAttributeDate(
    _ date: Date, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel, forAppID appID: String?
)

Parameters

`date`	attribute value as Date
`attributeName`	attribute name
`level`	level at which attribute should be set
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeDate(_:withAttributeName:level:)

Set User attribute date for Default instance with level

Declaration

Swift

@objc
public func setUserAttributeDate(
    _ date: Date, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel
)

Parameters

`date`	attribute value as Date
`attributeName`	attribute name
`level`	level at which attribute should be set


                    
                    
                    setUserAttributeISODate(_:withAttributeName:level:forAppID:)

Set User attribute ISO date for Secondary instance with level

Note

ISO accepted formats are yyyy-MM-dd’T'HH:mm:ss'Z’/yyyy-MM-dd’T'HH:mm:ss.SSS'Z’

Declaration

Swift

@objc
public func setUserAttributeISODate(
    _ dateString: String, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel, forAppID appID: String?
)

Parameters

`dateStr`	ISO date of type string
`attributeName`	attribute name
`level`	level at which attribute should be set
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeISODate(_:withAttributeName:level:)

Set User attribute ISO date for Default instance with level

Note

ISO accepted formats are yyyy-MM-dd’T'HH:mm:ss'Z’/yyyy-MM-dd’T'HH:mm:ss.SSS'Z’

Declaration

Swift

@objc
public func setUserAttributeISODate(
    _ dateString: String, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel
)

Parameters

`dateString`	ISO date of type string
`attributeName`	attribute name
`level`	level at which attribute should be set


                    
                    
                    setLocation(_:withAttributeName:level:forAppID:)

Set custom user location for Secondary instance with level

Declaration

Swift

@objc
public func setLocation(
    _ location: MoEngageGeoLocation, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel, forAppID appID: String?
)

Parameters

`location`	`MoEngageGeoLocation` instance
`attributeName`	attribute name
`level`	level at which attribute should be set
`appID`	MoEngage Account Identifier


                    
                    
                    setLocation(_:withAttributeName:level:)

Set custom user location for Default instance with level

Declaration

Swift

@objc
public func setLocation(
    _ location: MoEngageGeoLocation, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel
)

Parameters

`location`	`MoEngageGeoLocation` instance
`attributeName`	attribute name
`level`	level at which attribute should be set

User Attributes


                    
                    
                    setUserAttribute(_:withAttributeName:forAppID:)

Set custom user attribute for Secondary instance

Declaration

Swift

@objc
public func setUserAttribute(
    _ value: Any?, withAttributeName attributeName: String, forAppID appID: String?
)

Parameters

`value`	attribute value
`attributeName`	attribute name
`appID`	MoEngage account identifier


                    
                    
                    setUserAttribute(_:withAttributeName:)

Set custom user attribute for Default instance

Declaration

Swift

@objc
public func setUserAttribute(
    _ value: Any?, withAttributeName attributeName: String
)

Parameters

`value`	attribute value
`attributeName`	attribute name


                    
                    
                    setUserAttributeEpochTime(_:withAttributeName:forAppID:)

Set epoch time for Secondary instance

Declaration

Swift

@objc
public func setUserAttributeEpochTime(
    _ dateEpoch: Double, withAttributeName attributeName: String, forAppID appID: String?
)

Parameters

`dateEpoch`	Epoch date of type double
`attributeName`	attribute name of type String
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeEpochTime(_:withAttributeName:)

Set epoch time for Default instance

Declaration

Swift

@objc
public func setUserAttributeEpochTime(
    _ dateEpoch: Double, withAttributeName attributeName: String
)

Parameters

`dateEpoch`	Epoch date of type double
`attributeName`	attribute name of type String


                    
                    
                    setUserAttributeDate(_:withAttributeName:forAppID:)

Set User attribute date for Secondary instance

Declaration

Swift

@objc
public func setUserAttributeDate(
    _ date: Date, withAttributeName attributeName: String, forAppID appID: String?
)

Parameters

`date`	attribute value as Date
`attributeName`	attribute name
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeDate(_:withAttributeName:)

Set User attribute date for Default instance

Declaration

Swift

@objc
public func setUserAttributeDate(
    _ date: Date, withAttributeName attributeName: String
)

Parameters

`date`	attribute value as Date
`attributeName`	attribute name


                    
                    
                    setUserAttributeISODate(_:withAttributeName:forAppID:)

Set User attribute ISO date for Secondary instance

Note

ISO accepted formats are yyyy-MM-dd’T'HH:mm:ss'Z’/yyyy-MM-dd’T'HH:mm:ss.SSS'Z’

Declaration

Swift

@objc
public func setUserAttributeISODate(
    _ dateString: String, withAttributeName attributeName: String, forAppID appID: String?
)

Parameters

`dateStr`	ISO date of type string
`attributeName`	attribute name
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeISODate(_:withAttributeName:)

Set User attribute ISO date

Note

ISO accepted formats are yyyy-MM-dd’T'HH:mm:ss'Z’/yyyy-MM-dd’T'HH:mm:ss.SSS'Z’

Declaration

Swift

@objc
public func setUserAttributeISODate(
    _ dateString: String, withAttributeName attributeName: String
)

Parameters

`dateString`	ISO date of type string
`attributeName`	attribute name


                    
                    
                    setLocation(_:withAttributeName:forAppID:)

Set custom user location for Secondary instance

Declaration

Swift

@objc
public func setLocation(
    _ location: MoEngageGeoLocation, withAttributeName attributeName: String,
    forAppID appID: String?
)

Parameters

`location`	`MoEngageGeoLocation` instance
`attributeName`	attribute name
`appID`	MoEngage Account Identifier


                    
                    
                    setLocation(_:withAttributeName:)

Set custom user location

Declaration

Swift

@objc
public func setLocation(
    _ location: MoEngageGeoLocation, withAttributeName attributeName: String
)

Parameters

`location`	`MoEngageGeoLocation` instance
`attributeName`	attributeName name


                    
                    
                    setAlias(_:forAppID:)

Set an Alias to update the existing Unique Id for Secondary instance

Declaration

Swift

@objc
public func setAlias(_ alias: String, forAppID appID: String?)

Parameters

`alias`	identifier
`appID`	MoEngage Account Identifier


                    
                    
                    setAlias(_:)

Set an Alias to update the existing Unique Id for Default instance

Declaration

Swift

@objc
public func setAlias(_ alias: String)

Parameters


                                alias

identifier


                    
                    
                    setUniqueID(_:forAppID:)

Set unique ID for Secondary instance

Declaration

Swift

@objc
public func setUniqueID(_ uniqueID: String, forAppID appID: String?)

Parameters

`uniqueID`	Unique ID
`appID`	MoEngage Account identifier


                    
                    
                    setUniqueID(_:)

Set unique ID for Default instance

Declaration

Swift

@objc
public func setUniqueID(_ uniqueID: String)

Parameters


                                uniqueID

Unique ID


                    
                    
                    setEmailID(_:forAppID:)

Set Email ID for Secondary instance

Declaration

Swift

@objc
public func setEmailID(_ emailID: String, forAppID appID: String?)

Parameters

`emailID`	emailID value.
`appID`	MoEngage Account identifier


                    
                    
                    setEmailID(_:)

Set Email ID

Declaration

Swift

@objc
public func setEmailID(_ emailID: String)

Parameters


                                emailID

emailID value.


                    
                    
                    setName(_:forAppID:)

Set user name for Secondary instance

Declaration

Swift

@objc
public func setName(_ userName: String, forAppID appID: String?)

Parameters

`userName`	User Name value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setName(_:)

Set user name

Declaration

Swift

@objc
public func setName(_ userName: String)

Parameters


                                userName

User Name value passed by user


                    
                    
                    setFirstName(_:forAppID:)

Set User first name for Secondary instance

Declaration

Swift

@objc
public func setFirstName(_ firstName: String, forAppID appID: String?)

Parameters

`firstName`	First Name value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setFirstName(_:)

Set User first name

Declaration

Swift

@objc
public func setFirstName(_ firstName: String)

Parameters


                                firstName

First Name value passed by user


                    
                    
                    setLastName(_:forAppID:)

Set User last name for Secondary instance

Declaration

Swift

@objc
public func setLastName(_ lastName: String, forAppID appID: String?)

Parameters

`lastName`	Last Name value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setLastName(_:)

Set User last name

Declaration

Swift

@objc
public func setLastName(_ lastName: String)

Parameters


                                lastName

Last Name value passed by user


                    
                    
                    setMobileNumber(_:forAppID:)

Set mobile number for Secondary instance

Declaration

Swift

@objc
public func setMobileNumber(_ mobileNum: String, forAppID appID: String?)

Parameters

`mobileNum`	Mobile Number value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setMobileNumber(_:)

Set mobile number

Declaration

Swift

@objc
public func setMobileNumber(_ mobileNum: String)

Parameters


                                mobileNum

Mobile Number value passed by user


                    
                    
                    setGender(_:forAppID:)

Set User gender for Secondary instance

Declaration

Swift

@objc
public func setGender(_ gender: MoEngageUserGender, forAppID appID: String?)

Parameters

`gender`	Gender value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setGender(_:)

Set User gender

Declaration

Swift

@objc
public func setGender(_ gender: MoEngageUserGender)

Parameters


                                gender

Gender value passed by user


                    
                    
                    setDateOfBirth(_:forAppID:)

Set User Date of Birth for Secondary instance

Declaration

Swift

@objc
public func setDateOfBirth(_ dob: Date, forAppID appID: String?)

Parameters

`dob`	Date of Birth passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setDateOfBirth(_:)

Set User Date of Birth

Declaration

Swift

@objc
public func setDateOfBirth(_ dob: Date)

Parameters

dob

Date of Birth passed by user


                    
                    
                    setDateOfBirthInISO(_:forAppID:)

Set user Date of Birth ISO format for Secondary instance

Note

ISO format accepted yyyy-MM-dd’T'HH:mm:ss.SSS'Z’ / yyyy-MM-dd’T'HH:mm:ss'Z’

Declaration

Swift

@objc
public func setDateOfBirthInISO(_ dateString: String, forAppID appID: String?)

Parameters

`dateString`	attribute value accepted in ISO format
`appID`	MoEngage Account identifier


                    
                    
                    setDateOfBirthInISO(_:)

Method to set user date of birth ISO format

Note

ISO format accepted yyyy-MM-dd’T'HH:mm:ss.SSS'Z’ / yyyy-MM-dd’T'HH:mm:ss'Z’

Declaration

Swift

@objc
public func setDateOfBirthInISO(_ dateString: String)

Parameters


                                dateString

attribute value accepted in ISO format


                    
                    
                    setLocation(_:forAppID:)

Set user location for Secondary instance

Declaration

Swift

@objc
public func setLocation(_ location: MoEngageGeoLocation, forAppID appID: String? = nil)

Parameters

`location`	Location passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setLocation(_:)

Set user location

Declaration

Swift

@objc
public func setLocation(_ location: MoEngageGeoLocation)

Parameters


                                location

Location passed by user


                    
                    
                    trackUserPushPreference(_:forAppID:)

Track user attribute push preference

Declaration

Swift

@objc
public func trackUserPushPreference(_ isPushEnabled: Bool, forAppID appID: String?)

Parameters

`isPushEnabled`	true if Push is enabled else false.
`appID`	MoEngage Account identifier