// // CleverTapPlugin.h // Copyright (C) 2015 CleverTap // // This code is provided under a comercial License. // A copy of this license has been distributed in a file called LICENSE // with this source code. // // #import static NSString * const CTDidReceiveNotification = @"CTDidReceiveNotification"; static NSString * const CTRemoteNotificationDidRegister = @"CTRemoteNotificationDidRegister"; static NSString * const CTRemoteNotificationRegisterError = @"CTRemoteNotificationRegisterError"; static NSString * const CTHandleOpenURLNotification = @"CTHandleOpenURLNotification"; static NSString * const CTSendEvent = @"CTSendEvent"; @interface CleverTapPlugin : CDVPlugin # pragma mark - Developer Options /** Set CleverTap debug logging 0 = off, 1 = on; */ - (void)setDebugLevel:(CDVInvokedUrlCommand *)command; # pragma mark - Launch /** call to be notified of launch Push Notification or Deep Link */ - (void)notifyDeviceReady:(CDVInvokedUrlCommand *)command; # pragma mark - Enable Personalization API /** Enable the Personalization API must be invoked before calling most Event, Profile, or Session getters, see below */ - (void)enablePersonalization:(CDVInvokedUrlCommand *)command; /** Disable the Personalization API */ - (void)disablePersonalization:(CDVInvokedUrlCommand *)command; # pragma mark - Offline api /** Disables/Enables sending events to the server. */ - (void)setOffline:(CDVInvokedUrlCommand *)command; # pragma mark - Unmute api /*! Clears any active mute state set by the backend, allowing the SDK to resume normal event tracking and network operations immediately. */ - (void)unmute:(CDVInvokedUrlCommand *)command; #pragma mark - OptOut API /** Enabling tracking opt out for the currently active user */ - (void)setOptOut:(CDVInvokedUrlCommand *)command; /** Enables the reporting of device network-related information, including IP address. This reporting is disabled by default. */ - (void)enableDeviceNetworkInfoReporting:(CDVInvokedUrlCommand *)command; #pragma mark - Push Notifications /** Request user push notification permission */ - (void)registerPush:(CDVInvokedUrlCommand *)command; /** Set the user push token */ - (void)setPushTokenAsString:(CDVInvokedUrlCommand *)command; - (void)setPushToken:(NSData*)pushToken; /** Push Token Changes other than FCM */ -(void)registerTokenAsString:(CDVInvokedUrlCommand *)command; /** Let CleverTap handle the push notification CleverTap will insure your AppDelege OpenUrl: sourceApplication: is called with a deep link, if included in notification */ - (void)handleNotification:(id)notification; /** Let CleverTap handle sending the deep link into the Cordova WebView */ - (void)handleDeepLink:(NSURL *)url; #pragma mark - Push Notification Delegate - (void)pushNotificationTappedWithCustomExtras:(NSDictionary *)customExtras; #pragma mark - InApp Notification Controls /** Suspends and saves inApp notifications until 'resumeInAppNotifications' is called for current session. Automatically resumes InApp notifications display on CleverTap shared instance creation. Pending inApp notifications are displayed only for current session. */ - (void)suspendInAppNotifications; /** Discards inApp notifications until 'resumeInAppNotifications' is called for current session. Automatically resumes InApp notifications display on CleverTap shared instance creation. Pending inApp notifications are not displayed. */ - (void)discardInAppNotifications; /** Resumes displaying inApps notifications and shows pending inApp notifications if any. */ - (void)resumeInAppNotifications; /** Dismisses the currently visible Picture-in-Picture (PIP) In-App notification, if any. Safe to call from any thread; a no-op when no PIP is visible. */ - (void)dismissPipInApp:(CDVInvokedUrlCommand *)command; #pragma mark - CleverTapInAppNotificationDelegate /** This method gives call back for In App Notification Action */ - (void)inAppNotificationDismissedWithExtras:(NSDictionary *)extras andActionExtras:(NSDictionary *)actionExtras; /** This method gives call back for In App Notification Action */ - (void)inAppNotificationButtonTappedWithCustomExtras:(NSDictionary *)customExtras; #pragma mark - Event API /** Record a Screen View */ - (void)recordScreenView:(CDVInvokedUrlCommand *)command; /** Record an event */ - (void)recordEventWithName:(CDVInvokedUrlCommand *)command; /** Record an event with event properties */ - (void)recordEventWithNameAndProps:(CDVInvokedUrlCommand *)command; /** Record special "Charged" event with event details and array of purchased item objects see https://support.clevertap.com/profiles/recording-actions/#user-action-best-practices */ - (void)recordChargedEventWithDetailsAndItems:(CDVInvokedUrlCommand *)command; /** Get event first time recorded in seconds requires prior enablePersonalization call */ - (void)eventGetFirstTime:(CDVInvokedUrlCommand *)command __attribute__((deprecated("Deprecated as of version 3.4.0, use getUserEventLog instead"))); /** Get event last time recorded in seconds requires prior enablePersonalization call */ - (void)eventGetLastTime:(CDVInvokedUrlCommand *)command __attribute__((deprecated("Deprecated as of version 3.4.0, use getUserEventLog instead"))); /** Get num times an event has been recorded requires prior enablePersonalization call */ - (void)eventGetOccurrences:(CDVInvokedUrlCommand *)command __attribute__((deprecated("Deprecated as of version 3.4.0, use getUserEventLogCount instead")));; /** Get event details summary - first time, last time, occurrences requires prior enablePersonalization call */ - (void)eventGetDetails:(CDVInvokedUrlCommand *)command __attribute__((deprecated("Deprecated as of version 3.4.0, use getUserEventLog instead"))); /** Get history of events recorded with details requires prior enablePersonalization call */ - (void)getEventHistory:(CDVInvokedUrlCommand *)command __attribute__((deprecated("Deprecated as of version 3.4.0, use getUserEventLogHistory instead")));; /** Get event details summary - event name, normalized name, first time, last time, count, device id, requires prior enablePersonalization call */ - (void)getUserEventLog:(CDVInvokedUrlCommand *)command; /** Get num times an event has been recorded requires prior enablePersonalization call */ - (void)getUserEventLogCount:(CDVInvokedUrlCommand *)command; /** Get history of events recorded with details requires prior enablePersonalization call */ - (void)getUserEventLogHistory:(CDVInvokedUrlCommand *)command; /** Get user last visit time in epoch seconds requires prior enablePersonalization call */ - (void)getUserLastVisitTs:(CDVInvokedUrlCommand *)command; /** Get total user visits requires prior enablePersonalization call */ - (void)getUserAppLaunchCount:(CDVInvokedUrlCommand *)command; #pragma mark - Profile API /** Get the device location if available. Calling this will prompt the user location permissions dialog. Please be sure to include the NSLocationWhenInUseUsageDescription key in your Info.plist. See https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW26 Uses desired accuracy of kCLLocationAccuracyHundredMeters. If you need background location updates or finer accuracy please implement your own location handling. Please see https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/index.html for more info. Optional. You can use location to pass it to CleverTap via the setLocation API for, among other things, more fine-grained geo-targeting and segmentation purposes. */ - (void)getLocation:(CDVInvokedUrlCommand *)command; /** Set location */ - (void)setLocation:(CDVInvokedUrlCommand *)command; /** Creates a separate and distinct user profile identified by one or more of Identity, Email, FBID or GPID values, and populated with the key-values included in the profile dictionary. If your app is used by multiple users, you can use this method to assign them each a unique profile to track them separately. If instead you wish to assign multiple Identity, Email, FBID and/or GPID values to the same user profile, use profileSet rather than this method. If none of Identity, Email, FBID or GPID is included in the profile dictionary, all properties values will be associated with the current user profile. When initially installed on this device, your app is assigned an "anonymous" profile. The first time you identify a user on this device (whether via onUserLogin or profileSet), the "anonymous" history on the device will be associated with the newly identified user. Then, use this method to switch between subsequent separate identified users. Please note that switching from one identified user to another is a costly operation in that the current session for the previous user is automatically closed and data relating to the old user removed, and a new session is started for the new user and data for that user refreshed via a network call to CleverTap. In addition, any global frequency caps are reset as part of the switch. */ - (void)onUserLogin:(CDVInvokedUrlCommand *)command; /** Set properties on the CleverTap device user profile */ - (void)profileSet:(CDVInvokedUrlCommand *)command; /** Get property from the CleverTap device user profile requires prior enablePersonalization call */ - (void)profileGetProperty:(CDVInvokedUrlCommand *)command; /** Get the CleverTap ID of the User Profile. The CleverTap ID is the unique identifier assigned to the User Profile by CleverTap. */ - (void)profileGetCleverTapID:(CDVInvokedUrlCommand *)command __attribute__((deprecated("This method is deprecated in v2.3.5. Use getCleverTapID() instead"))); /** Returns a unique CleverTap identifier suitable for use with install attribution providers. */ - (void)profileGetCleverTapAttributionIdentifier:(CDVInvokedUrlCommand *)command __attribute__((deprecated("This method is deprecated in v2.3.5. Use getCleverTapID() instead"))); /** Returns a unique CleverTap identifier suitable for use with install attribution providers. */ - (void)getCleverTapID:(CDVInvokedUrlCommand *)command; /** Remove the property specified by key from the user profile. */ - (void)profileRemoveValueForKey:(CDVInvokedUrlCommand *)command; /** Method for setting a multi-value user profile property. Any existing value(s) for the key will be overwritten. Key must be String. Values must be Strings, max 40 bytes. Longer will be truncated. Max 100 values, on reaching 100 cap, oldest value(s) will be removed. */ - (void)profileSetMultiValues:(CDVInvokedUrlCommand *)command; /** Method for adding a unique value to a multi-value profile property (or creating if not already existing). If the key currently contains a scalar value, the key will be promoted to a multi-value property with the current value cast to a string and the new value(s) added. Key must be String. Values must be Strings, max 40 bytes. Longer will be truncated. Max 100 values, on reaching 100 cap, oldest value(s) will be removed. */ - (void)profileAddMultiValue:(CDVInvokedUrlCommand *)command; /** Method for adding multiple unique values to a multi-value profile property (or creating if not already existing). If the key currently contains a scalar value, the key will be promoted to a multi-value property with the current value cast to a string and the new value(s) added. Key must be String. Values must be Strings, max 40 bytes. Longer will be truncated. Max 100 values, on reaching 100 cap, oldest value(s) will be removed. */ - (void)profileAddMultiValues:(CDVInvokedUrlCommand *)command; /** Method for removing a unique value from a multi-value profile property. If the key currently contains a scalar value, prior to performing the remove operation the key will be promoted to a multi-value property with the current value cast to a string. If the multi-value property is empty after the remove operation, the key will be removed. */ - (void)profileRemoveMultiValue:(CDVInvokedUrlCommand *)command; /** Method for removing multiple unique values from a multi-value profile property. If the key currently contains a scalar value, prior to performing the remove operation the key will be promoted to a multi-value property with the current value cast to a string. If the multi-value property is empty after the remove operation, the key will be removed. */ - (void)profileRemoveMultiValues:(CDVInvokedUrlCommand *)command; /** Method for incrementing a value for a single-value profile property (if it exists). */ - (void)profileIncrementValueBy:(CDVInvokedUrlCommand *)command; /** Method for decrementing a value for a single-value profile property (if it exists). */ - (void)profileDecrementValueBy:(CDVInvokedUrlCommand *)command; #pragma mark - Session API /** Get CleverTap session time in seconds */ - (void)sessionGetTimeElapsed:(CDVInvokedUrlCommand *)command; /** Get total user visits requires prior enablePersonalization call */ - (void)sessionGetTotalVisits:(CDVInvokedUrlCommand *)command __attribute__((deprecated("Deprecated as of version 3.4.0, use getUserAppLaunchCount instead"))); /** Get CleverTap session screens viewed count */ - (void)sessionGetScreenCount:(CDVInvokedUrlCommand *)command; /** Get previous user visit time in epoch seconds requires prior enablePersonalization call */ - (void)sessionGetPreviousVisitTime:(CDVInvokedUrlCommand *)command __attribute__((deprecated("Deprecated as of version 3.4.0, use getUserLastVisitTs instead")));; /** Get session referrer utm source, campaign and medium, if applicable */ - (void)sessionGetUTMDetails:(CDVInvokedUrlCommand *)command; /** Manually track incoming install referrers. Call this to manually track the utm details for an incoming install referrer. */ - (void)pushInstallReferrer:(CDVInvokedUrlCommand *)command; # pragma mark - App Inbox /** Initialized the inbox controller. Call this method to initialize the inbox controller. You must call this method separately for each instance of CleverTap. */ - (void)initializeInbox:(CDVInvokedUrlCommand *)command; /** Get the total number of unread inbox messages for the user. */ - (void)getInboxMessageUnreadCount:(CDVInvokedUrlCommand *)command; /** Get the total number of inbox messages for the user. */ - (void)getInboxMessageCount:(CDVInvokedUrlCommand *)command; /** This method opens the controller to display the inbox messages. */ - (void)showInbox:(CDVInvokedUrlCommand *)command; /** This method fetches all Inbox Messages */ - (void)getAllInboxMessages:(CDVInvokedUrlCommand *)command; /** This method fetches all Unread Inbox Messages */ - (void)getUnreadInboxMessages:(CDVInvokedUrlCommand *)command; /** This method fetches the Message for Given Message Id */ - (void)getInboxMessageForId:(CDVInvokedUrlCommand *)command; /** This method deletes the Inbox Message for Given Message Id */ - (void)deleteInboxMessageForId:(CDVInvokedUrlCommand *)command; /** This method delete bulk Inbox Messages for Given Message Ids */ - (void)deleteInboxMessagesForIds:(CDVInvokedUrlCommand *)command; /** This method Mark a message as Read for Given Message Id */ - (void)markReadInboxMessageForId:(CDVInvokedUrlCommand *)command; /** This method Mark bulk messages as Read for Given Message Ids */ - (void)markReadInboxMessagesForIds:(CDVInvokedUrlCommand *)command; /** Dismisses Appinbox */ - (void)dismissInbox:(CDVInvokedUrlCommand *)command; /** This method Marks Inbox Notification Viewed for Given Message Id */ - (void)pushInboxNotificationViewedEventForId:(CDVInvokedUrlCommand *)command; /** This method Marks Inbox Notification Clicked for Given Message Id */ - (void)pushInboxNotificationClickedEventForId:(CDVInvokedUrlCommand *)command; /** Triggers an on-demand App Inbox refresh from the server (throttled to once every 5 minutes). */ - (void)fetchInbox:(CDVInvokedUrlCommand *)command; # pragma mark - Native Display /** This method is called to fetch all Display Units */ - (void)getAllDisplayUnits:(CDVInvokedUrlCommand *)command; /** This method is called to Fetch Display Unit For ID */ - (void)getDisplayUnitForId:(CDVInvokedUrlCommand *)command; /** This method is called to record Rendering of Display Unit */ - (void)pushDisplayUnitViewedEventForID:(CDVInvokedUrlCommand *)command; /** This method is called to record Click on Display Unit */ - (void)pushDisplayUnitClickedEventForID:(CDVInvokedUrlCommand *)command; /** This method is called to record a Click on a specific element within a Display Unit */ - (void)pushDisplayUnitElementClickedEventForID:(CDVInvokedUrlCommand *)command; # pragma mark - Feature Flags & Product Config //Feature Flags /** This method fetches the Value of Feature Flag */ - (void)getFeatureFlag: (CDVInvokedUrlCommand *)command; //Product Config /** This method Sets the default value for given set of keys */ - (void)setDefaultsMap: (CDVInvokedUrlCommand *)command; /** This method fetches the Product Config */ - (void)fetch: (CDVInvokedUrlCommand *)command; /** This method fetches Product Config with a defined minimum time interval */ - (void)fetchWithMinimumFetchIntervalInSeconds: (CDVInvokedUrlCommand *)command; /** This method activates the fetched Product Config */ - (void)activate: (CDVInvokedUrlCommand *)command; /** This method fetches and activated the Product Config */ - (void)fetchAndActivate: (CDVInvokedUrlCommand *)command; /** This method allows you to set minimum time interval for consecutive Product Config call */ - (void)setMinimumFetchIntervalInSeconds: (CDVInvokedUrlCommand *)command; /** This method allows you to fetch last config fetched time */ - (void)getLastFetchTimeStampInMillis: (CDVInvokedUrlCommand *)command; # pragma mark - Product experiences /** Uploads variables to the server. Requires Development/Debug build/configuration. */ - (void)syncVariables: (CDVInvokedUrlCommand *)command; /** Uploads variables to the server. @param {boolean} isProduction Provide `true` if variables must be sync in Productuon build/configuration. */ - (void)syncVariablesinProd: (CDVInvokedUrlCommand *)command; /** Forces variables to update from the server. */ - (void)fetchVariables:(CDVInvokedUrlCommand *)command; /** Create variables. @param {object} variables The JSON Object specifying the varibles to be created. */ - (void)defineVariables: (CDVInvokedUrlCommand *)command; /** Create file variables. @param {object} variables The list specifying the file variables to be created. */ - (void)defineFileVariable: (CDVInvokedUrlCommand *)command; /** Get a variable or a group for the specified name. @param {string} name - name. */ - (void)getVariable:(CDVInvokedUrlCommand *)command; /** Get all variables via a JSON object. */ - (void)getVariables:(CDVInvokedUrlCommand *)command; /** Adds a callback to be invoked when variables are initialised with server values. Will be called each time new values are fetched. */ - (void)onVariablesChanged:(CDVInvokedUrlCommand *)command; /** Adds a callback to be invoked when variables are initialised with server values. Will be called only once on app start, or when added if server values are already received */ - (void)onOneTimeVariablesChanged:(CDVInvokedUrlCommand *)command; /** Adds a callback to be invoked when no files need to be downloaded or all downloads have been completed. It is called each time new values are fetched and downloads are completed. */ - (void)onVariablesChangedAndNoDownloadsPending:(CDVInvokedUrlCommand *)command; /** Adds a callback to be invoked only once for when new values are fetched and downloaded. */ - (void)onceVariablesChangedAndNoDownloadsPending:(CDVInvokedUrlCommand *)command; /** Called when the value of the variable changes. */ - (void)onValueChanged:(CDVInvokedUrlCommand *)command; /** Called when the file variable changes. */ - (void)onFileValueChanged:(CDVInvokedUrlCommand *)command; /** This method fetches String Value for a given key */ - (void)getString: (CDVInvokedUrlCommand *)command; /** This method fetches Bool Value for a given key */ - (void)getBoolean: (CDVInvokedUrlCommand *)command; /** This method fetches Long Value for a given key */ - (void)getLong: (CDVInvokedUrlCommand *)command; /** This method fetches Double Value for a given key */ - (void)getDouble: (CDVInvokedUrlCommand *)command; /** This method resets the product Config stored locally */ - (void)reset; #pragma mark - InApp Controls - (void)clearInAppResources:(CDVInvokedUrlCommand *)command; - (void)fetchInApps:(CDVInvokedUrlCommand *)command; - (void)clearFileResources:(CDVInvokedUrlCommand *)command; # pragma mark - Custom Code Templates - (void)syncCustomTemplates: (CDVInvokedUrlCommand *)command; - (void)syncCustomTemplatesInProd: (CDVInvokedUrlCommand *)command; - (void)customTemplateSetDismissed: (CDVInvokedUrlCommand *)command; - (void)customTemplateSetPresented: (CDVInvokedUrlCommand *)command; - (void)customTemplateRunAction: (CDVInvokedUrlCommand *)command; - (void)customTemplateGetStringArg: (CDVInvokedUrlCommand *)command; - (void)customTemplateGetNumberArg: (CDVInvokedUrlCommand *)command; - (void)customTemplateGetBooleanArg: (CDVInvokedUrlCommand *)command; - (void)customTemplateGetFileArg: (CDVInvokedUrlCommand *)command; - (void)customTemplateGetObjectArg: (CDVInvokedUrlCommand *)command; - (void)customTemplateContextToString: (CDVInvokedUrlCommand *)command; @end