// // PushIOManager.h // PushIOManager // // Copyright (c) 2018 Oracle Inc. All rights reserved. // #import #import #import "PIOPreference.h" #ifndef __IPHONE_10_0 # define __IPHONE_10_0 100000 #endif #if defined(__IPHONE_10_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0 #import #endif FOUNDATION_EXPORT NSString * const PIOMCRawResponseCaptureNotification; FOUNDATION_EXPORT NSString * const PIOMCRawResponseValue; FOUNDATION_EXPORT NSString * const PIOMCRequestURL; @class PIOMCMessage; /**----------------------------------------------------------------------------- * @name Metadata Handler APIs * ----------------------------------------------------------------------------- */ /** PushIOPushMetaHandler delegate implementation indicates that application will handle the metadata from the push and the SDK should take no further action. */ @protocol PushIOPushMetaHandler @optional /** If application doesn't implement, nothing will be done when audio names are present. If application return NO, the SDK will attempt to load and play the given audio file, searching for it by name in the application bundle. NOTE: To play the sound, application must include the AVFoundation framework. @param audioFileName The name of the audio file that has been passed in the push notification. @return returns YES if application handled the audio play, NO otherwise. */ - (BOOL) handlePushAudio:(NSString *) audioFileName; /** If application doesn't implement, nothing will happen when alert text is available in push. If application returns NO, then an alert will be presented with the given alert text and no title. @param alertText The text for an alert passed in the push. @return returns YES if application handled the alert text, NO otherwise. */ - (BOOL) handlePushAlert:(NSString *) alertText; /** If application doesn't implement, nothing will happen when badge value is present. If application returns NO, then the SDK will update the application badge with the badge value. @param updatedApplicatonBadge The badge included updated values for the application badge. @return returns YES if application handled the badge value, NO otherwise. */ - (BOOL) handlePushBadgeUpdate:(NSString *)updatedApplicatonBadge; /** If you do not implement this method, or return NO, then a full-screen UIWebView will be brought up and load the contents of the URL. If the URL had been shortened by the PushIO servers, this will pass the expanded URL. @param urlString URL sent as part of the push notification. @return returns YES if application handled the URL, NO otherwise. */ - (BOOL) handlePushURL:(NSString *) urlString; /** This will additionally pass along a push token if included, which can be used to identify what data has been fetched If this method is not implemented no remote data will be fetched. @param remoteData The push included a link to some external data - that data has been loaded, and is included in the remoteData. @param token device token @return If application return NO, the SDK will not take any action. */ - (BOOL) handlePushExtendedData:(NSData *)remoteData withCustomPushToken:(NSString *)token; /** The push notification payload including a token string for further processing. @param token device token string. @return If you return NO, the library will not take action. */ - (BOOL) handleCustomPushToken:(NSString *)token; @end /** Help setting the logging level for PushIOManager. - PIOLogLevelNone: Log level showing no logs. - PIOLogLevelError: Log level showing only errors. - PIOLogLevelWarn: Log level showing errors and warnings. - PIOLogLevelInfo: Log level showing informational messages, errors and warnings (default). - PIOLogLevelDebug: Log level showing debugging statements intended for app developers, informational messages, errors and warnings. - PIOLogLevelVerbose: Log level showing debugging statements intended for SDK developers & app developers, informational messages, errors and warnings. */ typedef NS_ENUM(NSInteger, PIOLogLevel) { PIOLogLevelNone = 0, PIOLogLevelError = 1, PIOLogLevelWarn = 2, PIOLogLevelInfo = 3, PIOLogLevelDebug = 4, PIOLogLevelVerbose = 5 }; /** Helps setting the application build configuration type (Debug/Release). - PIOConfigTypeNone: Configuration type None. - PIOConfigTypeDebug: Configuration type Debug. - PIOConfigTypeRelease: Configuration type Release. */ typedef NS_ENUM(NSInteger, PIOConfigType) { PIOConfigTypeNone = 0, PIOConfigTypeDebug = 1, PIOConfigTypeRelease = 2 }; /** Encapsulate the list of engagements. - PUSHIO_ENGAGEMENT_METRIC_LAUNCH: Engagement type Launch. - PUSHIO_ENGAGEMENT_METRIC_PREMIUM_CONTENT: Engagement type Premium. - PUSHIO_ENGAGEMENT_METRIC_SOCIAL: Engagement type Social. - PUSHIO_ENGAGEMENT_METRIC_ACTION: Engagement type Action. */ typedef enum { PUSHIO_ENGAGEMENT_METRIC_LAUNCH = 0, // Push IO internal use PUSHIO_ENGAGEMENT_METRIC_ACTIVE_SESSION = 1, // Push IO internal use PUSHIO_ENGAGEMENT_METRIC_INAPP_PURCHASE = 2, PUSHIO_ENGAGEMENT_METRIC_PREMIUM_CONTENT = 3, PUSHIO_ENGAGEMENT_METRIC_SOCIAL = 4, PUSHIO_ENGAGEMENT_METRIC_ACTION = 5, // Push IO internal use PUSHIO_ENGAGEMENT_METRIC_OTHER = 6, // Push IO internal use PUSHIO_ENGAGEMENT_METRIC_PURCHASE = 7, // Push IO internal use }PushIOEngagementMetrics; //Error Domains FOUNDATION_EXPORT NSString * const PIOErrorDomainNoNetwork; FOUNDATION_EXPORT NSString * const PIOErrorDomainMaximumRetryReach; FOUNDATION_EXPORT NSString * const PIOErrorDomainInvalidURL; /** Error code enum - PIOErrorCodeNoNetwork: No network available. - PIOErrorCodeMaximumRetryReached: Maximum retry for the web communication reached. - PIOErrorCodeInvalidURL: Invalid URL. */ typedef NS_ENUM(NSInteger, PIOErrorCode) { PIOErrorCodeNoNetwork = 5001, PIOErrorCodeMaximumRetryReached, PIOErrorCodeInvalidURL, PIOErrorCodeInvalidPayload, PIOErrorCodeEmptyResponse, PIOErrorCodePurchaseNotSupported, PIOErrorCodeConversionInfoNotAvailable }; //Multiple Inbox Error Domains FOUNDATION_EXPORT NSString * const PIOErrorDomainMCFailure; FOUNDATION_EXPORT NSString * const PIOErrorDomainHTTPFailure; /** Multiple Inbox error codes - PIOHTTTPStatusCodeInvalidAppOrAccountToken:Invalid Account Token/Invalid App Token - PIOHTTTPStatusCodeMCFailure:Message Center not enabled for App/Not RI-App(not migrated App)/ Invalid message center/Message Center deleted - PIOHTTTPStatusCodeMCDisabled:Message Center Feature disabled at RI pod/account */ #define PIOHTTTPStatusCodeInvalidAppOrAccountToken 400 #define PIOHTTTPStatusCodeMCFailure 404 #define PIOHTTTPStatusCodeMCDisabled 403 /** Callback used for asynchronous communication between application and PushIO SDK. @param error placeholder to populate the error code/reason when operation completed. @param response detailed response message. */ typedef void (^PIOCompletionHandler)(NSError *error, NSString *response); /** MessageCenter callback used for asynchronous communication between application and PushIO SDK. @param error placeholder to populate the error code/reason when operation completed. @param messages List of messages fetched. If messages are empty check the error for more details. */ typedef void (^PIOMessageCenterCompletionHandler)(NSError *error, NSArray *messages); /** Messages richcontent callback used to fetch the rich content for the application. @param error Placeholder to populate the error code/reason when operation completed. @param messageID Rich content requested message indentifier. @param richContent Richcontent fetched from server. */ typedef void (^PIOMessageCenterRichcontentCompletionHandler)(NSError *error, NSString *messageID, NSString *richContent); /** Block (callback) to provide extra event properties at run time. @param event dictionary containing event's information. */ typedef NSDictionary* (^PIOGlobalPropertiesBlock)(NSDictionary *event); /** A `PushIOManagerDelegate` implementation ensures to get called back with the progress/completion of registration. Also, lets application know if Newsstand content is available. */ @protocol PushIOManagerDelegate @optional /** Called when PushIO SDK has valid token and ready to send a registration to PushIO server. */ - (void)readyForRegistration; /** Called when App has registered with PushIO server successfully. */ - (void)registrationSucceeded; /** Called when App failed to register with PushIO server. @param error placeholder to populate the error code/reason if registration fails. @param statusCode contains the integer value of status code received from server. */ - (void)registrationFailedWithError:(NSError *)error statusCode:(int)statusCode; /** Called when PushIO SDK found that Newsstand content is ready. */ - (void)newNewsstandContentAvailable; /** SDK has extracted a push dictionary, the metadata is ready to be retrieved. */ - (void)pushProcessed; @end /** `PushIOManager` provides primary interface for application to interact with PushIO SDK. Once registration is complete all Push related operations unlocked to use . i.e.: inApp messaging, Notification preferences, categories handling, engagement reporting etc. */ @interface PushIOManager : NSObject /**----------------------------------------------------------------------------- * @name Initializing and Delegation * ----------------------------------------------------------------------------- */ /** Initialize `PushIOManager` (as singleton) @return instance of PushIOManager */ + (PushIOManager *)sharedInstance; /** Event properties that are provided by application which becomes part of every event created. */ @property(nonatomic, strong) NSDictionary *globalEventProperties; /** Custom callback to access event properties at run time. Called every time new event is created and provides window for application to determine and provide event properties. */ @property (nonatomic, copy) PIOGlobalPropertiesBlock globalEventPropertiesBlock; /** @deprecated This method is deprecated starting from version 6.32.0 @note Please use registration method with completionHandler and error placeholder as parameter instead. 'PushIOManagerDelegate' keeps application informed about the status of registration as: - when SDK is ready for registration 'readyForRegistration' notified. - when registration successfully completes 'registrationSucceeded' notified. - when registration fails to register 'registrationFailedWithError' is called with error object and status code received from PushIO server. */ @property (nonatomic, weak) id delegate __attribute__((deprecated)); /** Status of application registration with SDK. */ @property (nonatomic, assign) BOOL registrationStored; /** Defines the behavior when user interact with the hyperlink inside inApp message view. Default is set to NO. If set YES, pub-web hyperlinks are resolved and deeplink url, web url is notified to the application by notification boradcast to `PIORsysWebURLResolvedNotification`. If set NO, user redirected to safari when s/he interact with hyper link. */ @property (nonatomic, assign) BOOL executeRsysWebURL; /** Notification constant to notify the application with resolved pub web information. */ FOUNDATION_EXPORT NSString * const PIORsysWebURLResolvedNotification; FOUNDATION_EXPORT NSString * const PIOResolvedDeeplinkURL; FOUNDATION_EXPORT NSString * const PIOResolvedWeblinkURL; FOUNDATION_EXPORT NSString * const PIORequestedWebURL; FOUNDATION_EXPORT NSString * const PIOErrorResolveWebURL; FOUNDATION_EXPORT NSString * const PIORequestedWebURLIsPubWebType; /** Allows the application to specify an External Device Tracking ID. Stored in persistence storage. Set nil to remove the external device tracking identifier. */ @property (nonatomic, strong) NSString *externalDeviceTrackingID; /** Allows the application to specify an IDFA programatically. Stored in persistence storage. Set nil to remove the advertising identifier. */ @property (nonatomic, strong) NSString *advertisingIdentifier; /** Allows the application to get the callback when SDK is ready for registration. Called when SDK receives the device token successfully. */ @property (nonatomic, strong) PIOCompletionHandler readyForRegistrationCompHandler; /** When the value is set to PIOConfigTypeRelease, the SDK performs the 'release' type API key validation. When the value is set to PIOConfigTypeDebug, the SDK performs the 'debug' type API key validation. When the value is set to PIOConfigTypeNone, the SDK tries to determine the current config and read the configurations from respective pushio_config_debug.json or pushio_config.json and performs the API Key validation. */ @property (nonatomic, assign) PIOConfigType configType; #if defined(__IPHONE_10_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0 /** UNUserNotificationDelegates userNotificationCenter:willPresentNotification:withCompletionHandler need the presentation options to complete the notification. If not provided developer needs to call completion handler in userNotificationCenter:willPresentNotification:withCompletionHandler with notification presentation value. */ @property (nonatomic, assign) UNNotificationPresentationOptions notificationPresentationOptions; #endif /**----------------------------------------------------------------------------- * @name Console Log Printing * ----------------------------------------------------------------------------- */ /** @deprecated This method is deprecated starting from version 6.33.0 @note Please use @code setLoggingEnabled: instead. Start printing log in debug console. Different level of logging can be enabled with this. @param enable determines if SDK needs to enable logging. */ - (void) enableLogging:(BOOL)enable __attribute__((deprecated)); /** Enable/Disable logging. By default logging is enabled with default PIOLogLevelInfo. Developer can change the log level by calling setLogLevel method. @param enable If `YES`, enable console log printing. If `NO`, disable console log printing. */ - (void) setLoggingEnabled:(BOOL)enable; /** @deprecated This method is deprecated starting from version 6.33.0 @note Please use @code setLoggingEnabled: instead. Stop console log printing. */ - (void) disableLogging __attribute__((deprecated)); /** Sets the log level. @param logLevel log level */ -(void) setLogLevel:(PIOLogLevel)logLevel; /** Check if log printing is enabled in debug console.. @return TRUE if log printing enabled, FALSE otherwise. */ - (BOOL)isLoggingEnabled; /**----------------------------------------------------------------------------- * @name SDK setup methods * ----------------------------------------------------------------------------- */ /** @deprecated This method is deprecated starting from version 6.41.0 @note Please use @code configureWithFileName: @endcode or @code configureWithAPIKey:(NSString *)apiKey accountToken:(NSString *)accountToken conversionUrl:(NSString *)conversionUrl riAppId:(NSString *)riAppId accountName:(NSString *)accountName completionHandler:(PIOCompletionHandler)completionHandler: @endcode instead. Validates the key against the current configuration and makes SDK ready for registration for valid API-Key. @param apiKey generated in RI portal and used to configure SDK. @param accountToken generated in RI portal and used to configure SDK. @param error placeholder to populate the error code/reason if provided API-key is invalid. @return TRUE if SDK configured successfully (or provided APIKey is valid), FALSE otherwise. */ - (BOOL)configureWithAPIKey:(NSString *)apiKey accountToken:(NSString *)accountToken error:(NSError *__autoreleasing *)error __attribute__((deprecated)); /** @deprecated This method is deprecated starting from version 6.41.0 @note Please use @code configureWithFileName: @endcode or @code configureWithAPIKey:(NSString *)apiKey accountToken:(NSString *)accountToken conversionUrl:(NSString *)conversionUrl riAppId:(NSString *)riAppId accountName:(NSString *)accountName completionHandler:(PIOCompletionHandler)completionHandler: @endcode instead. Configure the application and register with server, for given APIKey and AccountToken. @param apiKey generated in RI portal and used to configure SDK. @param accountToken generated in RI portal and used to configure SDK. @param completionHandler Called when application finish registration. @return TRUE if SDK configured successfully (or provided APIKey is valid), FALSE otherwise. Registration status communicated through completion handler. */ - (BOOL)configureAndRegisterWithAPIKey:(NSString *)apiKey accountToken:(NSString *)accountToken completionHandler:(PIOCompletionHandler)completionHandler __attribute__((deprecated)); /**----------------------------------------------------------------------------- * @name Registration * ----------------------------------------------------------------------------- */ /** After application is configured successfully, it has to register to let server know about the application's metadata/properties. @param error placeholder to populate the error code/reason if registration fails. @param completionHandler callback to notify when registration is completed with the server. @return TRUE if register event created and stored successfully, FALSE otherwise. @warning return value indicates the registration event creation locally, and completion handler gets called when sync of registration happen with server. */ - (BOOL)registerApp:(NSError *__autoreleasing *)error completionHandler:(PIOCompletionHandler)completionHandler; /** @deprecated This method is deprecated starting from version 6.32.0 @note Please use @code registerApp: completionHandler: @endcode instead. Register application with server. Loads the API key from pushio_config or pushio_config_debug for production or development respectively. Call registerForAllRemoteNotificationTypes internally to get notification access permissions. */ - (void)registerWithPushIO __attribute__((deprecated)); /** Asks user permissions for all push notifications types. i.e.: Sound/Badge/Alert types. If readyForRegistrationCompHandler is not set, then provided completionHandler is assigned to it, to let application have access when SDK receives deviceToken. @param completionHandler callback with response for notification permission prompt. */ - (void)registerForAllRemoteNotificationTypes:(PIOCompletionHandler)completionHandler; /** Register for all available notification types and with categories. @param categories Array of categories to register with. @param completionHandler Notify when registration complete. */ - (void)registerForAllRemoteNotificationTypesWithCategories:(NSArray *)categories completionHandler:(PIOCompletionHandler)completionHandler; /** @deprecated This method is deprecated starting from version 6.32.0 @note Please use @code registerForAllRemoteNotificationTypes: completionHandler: @endcode instead. Ask user to provide the permissions for different notifications i.e.: Sound/Badge/Alert types. */ - (void)registerForAllRemoteNotificationTypes __attribute__((deprecated)); /** Unregisters the application (create the unregister event and sync with server) from PushIO SDK and no further events are tracked till application register again. @param error placeholder to populate the error code/reason if unregister fail. @param completionHandler callback to notify when unregister complete with server. @return TRUE if unregister event created and stored successfully, FALSE otherwise. @warning return value indicates the unregister event creation locally, and completion handler gets called when sync of unregister happen with server. */ - (BOOL)unregisterApp:(NSError *__autoreleasing *)error completionHandler:(PIOCompletionHandler)completionHandler; /** @deprecated This method is deprecated starting from version 6.32.0 @note Please use @code unregisterApp: completionHandler: @endcode instead. Unregister (delete) application from server. */ - (void)unregisterFromPushIO __attribute__((deprecated)); /**----------------------------------------------------------------------------- * @name Event Trackers * ----------------------------------------------------------------------------- */ /** Captures custom events. Application can set extra values related to the custom event via globalEventProperties and globalEventPropertiesCallback. @param eventName name of the event to be tracked. */ - (void)trackEvent:(NSString *)eventName; /** Captures custom events. Application can set extra properties specific to this event via the properties parameter. @param eventName name of the event to be tracked. @param properties event properties to attach with the given event name. */ - (void)trackEvent:(NSString *)eventName properties:(NSDictionary *)properties; /** Tracks the engagement for the provided engagement metric type. @param metric type of engagement to track i.e.: launch, active,iam,premium,social,action etc. */ - (void) trackEngagementMetric:(PushIOEngagementMetrics)metric; /** Tracks the engagement for the provided engagement metric type with additional properties @param metric Engagement metric. @param properties Engagement metric properties. @param completionHandler CompletionHandler. */ - (void) trackEngagementMetric:(PushIOEngagementMetrics)metric withProperties:(NSDictionary *)properties completionHandler:(PIOCompletionHandler)completionHandler; /**----------------------------------------------------------------------------- * @name Application Lifecycle (UIApplicationDelegate hooks) * ----------------------------------------------------------------------------- */ /** Method to be invoked from the application delegate's `didFinishLaunchingWithOptions:` method. @param launchOptions contains the application launch information. */ - (void)didFinishLaunchingWithOptions:(NSDictionary *)launchOptions; /** Method to be invoked from the application delegate's `didReceiveRemoteNotification:` method. @param userInfo contains the remote notification information. */ - (void)didReceiveRemoteNotification:(NSDictionary *)userInfo; /** Method to be invoked from application delegate's `didRegisterForRemoteNotificationsWithDeviceToken:` method. @param deviceToken contains value of devicetoken data. */ - (void) didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken; /** Method to be invoked from the application delegate's `didFailToRegisterForRemoteNotificationsWithError:` method. @param error contains the error details occur while try to register with APNS. */ - (void)didFailToRegisterForRemoteNotificationsWithError:(NSError *)error; /** Method meant to be invoked from the application delegate's `application:openURL:sourceApplication:annotation:` method. @param URL URL scheme with which application is invoked. @param sourceApplication source application name. @param annotation annotation. @return TRUE if URL is processed successfully, FALSE otherwise. */ - (BOOL)openURL:(NSURL *)URL sourceApplication:(NSString *)sourceApplication annotation:(id)annotation; /** Method meant to be invoked from the application delegate's `didReceiveRemoteNotification:fetchCompletionResult:fetchCompletionHandler:` @param userInfo remote notification information. @param fetchResult fetchResult. @param handler need to be called to let iOS know that remote notification processed successfully. */ - (void)didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionResult:(UIBackgroundFetchResult)fetchResult fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))handler; /** Method meant to be invoked from the application delegate's `handleActionWithIdentifier: forRemoteNotification: completionHandler:`. When the PushIOManager version is called, the userInfo push dictionary will be processed, an engagement will be triggered, and the completion handler called. @param identifier identifier. @param userInfo remote notification information. @param completionHandler completionHandler. */ - (void)handleActionWithIdentifier:(NSString *)identifier forRemoteNotification:(NSDictionary *)userInfo completionHandler:(void (^)(void))completionHandler; /** Method meant to be invoked from the application delegate's `handleActionWithIdentifier: forRemoteNotification: withResponseInfo: completionHandler:`. When the PushIOManager version is called, the userInfo push dictionary will be processed, an engagement will be triggered, and the completion handler called. @param identifier identifier. @param userInfo remote notification information. @param responseInfo notification response information. @param completionHandler completionHandler. */ -(void) handleActionWithIdentifier:(NSString *)identifier forRemoteNotification:(NSDictionary *)userInfo withResponseInfo:(NSDictionary *)responseInfo completionHandler:(void (^)(void))completionHandler; /** When application invoked from the URL and it want SDK to resove the URL. @param userActivity containing userActivity information. @param restorationHandler restorationHandler. NOTE: It's only used for SDK internal purpose. Application still need to call it to complete the userActicity. */ - (void)continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray *))restorationHandler; /**----------------------------------------------------------------------------- * @name Notification Preferences * ----------------------------------------------------------------------------- */ /** Declares a preference. A preference is not stored until a value has been assigned by a setter method. @see setBoolPreference:forKey: @see setNumberPreference:forKey: @see setStringPreference:forKey: @param key preference unique identifier. @param label human readable preference detail. @param type preference type. @param error placeholder to populate the error code/reason if preference declare fail. */ - (void)declarePreference:(NSString *)key label:(NSString *)label type:(PIOPreferenceType)type error:(NSError **)error; /** Assigns a boolean value to a previously declared preference. @param value boolean preference value to assign. @param key unique identifier of preference. @return TRUE if boolean preference value assigned, FALSE otherwise. */ - (BOOL)setBoolPreference:(BOOL)value forKey:(NSString *)key; /** Assigns a numeric value to a previously declared preference. @param value numeric preference value to assign. @param key unique identifier of preference. @return TRUE if numeric preference value assigned, FALSE otherwise. */ - (BOOL)setNumberPreference:(NSNumber *)value forKey:(NSString *)key; /** Assigns a string value to a previously declared preference. @param value string preference value to assign. @param key unique identifier of preference. @return TRUE if string preference value assigned, FALSE otherwise. */ - (BOOL)setStringPreference:(NSString *)value forKey:(NSString *)key; /** Retrieve a preference from local persistence storage. @param key unique identifier of preference. @return PIOPreference instance if preference is found for the key, NULL otherwise. */ - (PIOPreference *)getPreference:(NSString *)key; /** Retrieves all preferences stored. @return list of instance of PIOPreference found in persistence storage. nil if no preference found. */ - (NSArray *)getPreferences; /** Remove a preference identified by provided key. Preferences must be redeclared before assigning again. @param key unique identifier of preference. @param error placeholder to populate the error code/reason if removePreference fail. */ - (void)removePreference:(NSString *)key error:(NSError **)error; /** Removes all preferences. Preferences must be redeclared before assigning again. */ - (void)clearAllPreferences; /**----------------------------------------------------------------------------- * @name UserID Handlers * ----------------------------------------------------------------------------- */ /** Contains verifiedUserID. * */ @property(nonatomic, strong) NSString *verifiedUserID; /** An optional UserID can be set to target individual users for push notifications, sent along with push registration. @param userID string value contains the userID to store and sync. */ - (void)registerUserID:(NSString *)userID; /** @deprecated This method is deprecated starting from version 6.32.0 @note Please use @code registerUserID: @endcode by passing nil or empty string to unregister userID instead. Removes registered userID and re-registers with PushIO server. */ - (void)unregisterUserID __attribute__((deprecated)); /** @deprecated This method is deprecated starting from version 6.32.0 @note Please use @code getUserID @endcode to get the userID and match with your version of userID. Check if a given userID is registered with SDK. @param userID string value contains the userID to check against already registered one. @return TRUE if given userID match with already registered userID, FALSE otherwise. */ - (BOOL)isRegisteredForUserID:(NSString *)userID __attribute__((deprecated)); /** Returns The current registered userID. @return string value of registered userID. nil of no userID registered. */ - (NSString *)getUserID; /** @deprecated This method is deprecated starting from version 6.32.0 @note Please use @code getUserID @endcode instead. Returns The current registered userID. @return string value of registered userID. nil of no userID registered. */ - (NSString *)registeredUserID __attribute__((deprecated)); /**----------------------------------------------------------------------------- * @name Categories Handlers * ----------------------------------------------------------------------------- */ /** Register a list of categories for this device with Push IO. Categories let application to opt into specific groups. Any category not present in the array will be unregistered if already registered with the PushIO server. @param categories list of categories (string values) to get registered. */ - (void)registerCategories:(NSArray *)categories; /** Registers a single category, leaving any other categories still registered. @param category string value of category to register with PushIO server. */ - (void)registerCategory:(NSString *)category; /** Unregister a single category, leaving all other categories in place. @param category string value of category to unregister from PushIO server. */ - (void)unregisterCategory:(NSString *)category; /** Unregisters a list of categories, leaving any categories not in the passed in array still registered. @param categories list of categories to unregister from PushIO server. */ - (void)unregisterCategories:(NSArray *)categories; /** Unregister all categories for this device from Push IO. */ - (void)unregisterAllCategories; /** Check if given category already registered with PushIO SDK. @param category string value of category to check if already registered. @return TRUE if given category is already registered, FALSE otherwise. */ - (BOOL)isRegisteredForCategory:(NSString *)category; /** Returns all registered categories. @return array of category(strings) if there are one or more categories registered, NULL otherwise. */ - (NSArray *)allRegisteredCategories; /** @warning This override will make it inconsistent IAM and RichPush. Don't use this until consequences are fully analyzed. */ @property (nonatomic, strong) NSString *overrideURLScheme; /** @unavailable This method is deprecated starting from version 6.32.0 @note Please use @code configuewithAPIKey: @endcode instead. Override the configured APIKey. @param overridePushIOAPIKey string value of new API Key. */ - (void)setOverridePushIOAPIKey:(NSString *)overridePushIOAPIKey __attribute__((deprecated)); /** @unavailable This method is deprecated starting from version 6.32.0 @note Please use @code configuewithAPIKey: @endcode instead. Override the configured AccountToken. @param overrideAccountToken string value of new Account Token. */ - (void)setOverrideAccountToken:(NSString *)overrideAccountToken __attribute__((deprecated)); /** @deprecated This method is deprecated starting from version 6.41.0 @note Please use @code configureWithFileName: @endcode or @code configureWithAPIKey:(NSString *)apiKey accountToken:(NSString *)accountToken conversionUrl:(NSString *)conversionUrl riAppId:(NSString *)riAppId accountName:(NSString *)accountName completionHandler:(PIOCompletionHandler)completionHandler: @endcode instead. Copy the value of `conversionUrl` from config.json, and pass it in this method. It's better to provide coversionURL as part of setup, it will avoid drop-reporting. @param conversionURL URL value of `conversionUrl` from config.json. */ - (void)setConversionURL:(NSURL *)conversionURL __attribute__((deprecated)); /** @deprecated This method is deprecated starting from version 6.41.0 @note Please use @code configureWithFileName: @endcode or @code configureWithAPIKey:(NSString *)apiKey accountToken:(NSString *)accountToken conversionUrl:(NSString *)conversionUrl riAppId:(NSString *)riAppId accountName:(NSString *)accountName completionHandler:(PIOCompletionHandler)completionHandler: @endcode instead. Copy the value of `riAppId` from config.json, and pass it in this method. It's better to provide RIAppID as part of SDK setup, it will avoid drop-reporting. @param riAppID RIAppID value of `riAppId` from config.json */ - (void)setRIAppID:(NSString *)riAppID __attribute__((deprecated)); /** A unique ID used by SDK to configure the application. @note Uses CFUUID internally to generate the deviceID. @return non-null string value of device ID generated and used by SDK. */ - (NSString *)getDeviceID; /** @deprecated This method is deprecated starting from version 6.32.0 @note Please use @code getDeviceID @endcode instead. A unique ID used by SDK to configure the application. @return non-null string value of device ID generated and used by SDK. */ - (NSString *)pushIOUUID __attribute__((deprecated)); /** Configured API key. @return string value of configured APIKey. nil if no apikey configured. */ - (NSString *)getAPIKey; /** Configured AccountToken value. @return string value of configured AccountToken. nil if no AccountToken configured. */ - (NSString *)getAccountToken; /** @deprecated This method is deprecated starting from version 6.32.0 @note Please use @code getAPIKey @endcode instead. Configured API key. @return string value of configured APIKey. nil if no apikey configured. */ - (NSString *)pushIOAPIKey __attribute__((deprecated)); /** @deprecated This method is deprecated starting from version 6.32.0 @note Please use @code getAccountToken @endcode instead. Configured AccountToken value. @return string value of configured AccountToken. nil if no AccountToken configured. */ - (NSString *)pushIOAccountToken __attribute__((deprecated)); /** Returns the version of this framework in use. @return framework version. */ - (NSString *) frameworkVersion; //Metadata handler /** Gives the PushIO SDK a handler to call back when extended metadata is present in the push. See the description of the PushIOPushMetaHandler protocol for effects if not set or not implementing specific methods. */ @property (nonatomic, assign) id pushMetaHandlerDelegate; /** If there was a URL present in the last push, then this returns the URL sent. If the URL had been shortened by the PushIO servers, this will return the expanded URL string. */ @property (nonatomic, readonly) NSString *lastPushURLString; /**----------------------------------------------------------------------------- * @name iOS10 Notification Methods * ----------------------------------------------------------------------------- */ /** Asks user permissions for provided notifications types i.e.: Sound/Badge/Alert types. If readyForRegistrationCompHandler is not set, then provided completionHandler is assigned to it, to let application have access when SDK receives deviceToken. NOTE: Need to call from iOS10+. @param authOptions Notification auth types i.e.: Sound/Badge/Alert @param categories Contains the notification categories definitions. @param completionHandler callback with response for notification permission prompt. */ -(void) registerForNotificationAuthorizations:(UNAuthorizationOptions)authOptions categories:(NSArray *)categories completionHandler:(PIOCompletionHandler)completionHandler; /** Must be called by the UNUserNotificationDelegate's userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler. @param center The notification center. @param response The notification response. @param completionHandler A completion handler. */ -(void) userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void(^)(void))completionHandler; /** Must be called by UNUserNotificationDelegate's userNotificationCenter:willPresentNotification:withCompletionHandler. @param center The notification center. @param notification The notification response. @param completionHandler A completion handler. */ -(void) userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler; /** @deprecated This method is deprecated starting from version 6.40.1 @note Please use @code registerForNotificationAuthorizations: @endcode instead. Asks user to provide the permissions for provided notifications types i.e.: Sound/Badge/Alert types. If readyForRegistrationCompHandler is not set, then provided completionHandler is assigned to it, to let application have access when SDK receives deviceToken. @param notificationType Notification types i.e.: Sound/Badge/Alert @param categories Categories dictionary containing categories and action details. @param completionHandler callback with response for notification permission prompt. */ -(void) registerForNotificationTypes:(UIUserNotificationType)notificationType categories:(NSArray *)categories completionHandler:(PIOCompletionHandler)completionHandler __attribute__((deprecated)); /** @deprecated This method is deprecated starting from version 6.40.1 Method to be invoked from the application delegate's `didRegisterUserNotificationSettings:` method. @param notificationSettings updated notification settings */ -(void) didRegisterUserNotificationSettings:(UIUserNotificationSettings *)notificationSettings __attribute__((deprecated)); //MARK: Message Center Methods /** Fetch the list of Message Center messages for given MessageCenter name. @param messageCenter Name of MessageCenter to fetch the list of messages. @param completionHandler Callback to notify when operation complete. */ -(void) fetchMessagesForMessageCenter:(NSString *)messageCenter CompletionHandler:(PIOMessageCenterCompletionHandler)completionHandler; /** Fetch the rich content for the given message instance. @param messageID of message to identify the rich content. @param completionHandler Callback to notify when rich content fetch complete. */ -(void)fetchRichContentForMessage:(NSString *)messageID CompletionHandler:(PIOMessageCenterRichcontentCompletionHandler)completionHandler; /** Reset all SDK data. i.e.: DeviceID, UserId, Preferences. */ -(void) resetAllData; /** Reset all engagement information (to nil). No more engagement will be reported after calling this method until: either new push notification received or application is invoked from the email. */ -(void) resetEngagementContext; /** Return the string value (date ISO 8601 format), recorded when engagement information fetched from server and stored locally. @return String value of engagement date,time in ISO 8601 format. Return nil if no engagement information fetched or `resetEngagementContext()` called. */ -(NSString *) getEngagementTimeStamp; /** @return double value of server returned max age value (when application invoked from email). Return -1 if no max age (from server) fetched or `resetEngagementContext()` called. */ -(double) getEngagementMaxAge; /** Enable the fetch messages for all message center names from the server. Generally SDK fetches the updated messages when application starts, so `didFinishLaunchingWithOptions` is the correct place to call it. @param enableMessageCenter boolean value to enable the messages fetch. */ -(void) setMessageCenterEnabled:(BOOL)enableMessageCenter; /** Returns the status of MessageCenter enabled. @return YES if message center enabled, NO if not enabled. By default it's NO defined by SDK. */ -(BOOL) isMessageCenterEnabled; /** Tells about if the SDK is configured successfully. @return Return TRUE if configured, FASLE otherwise. */ -(BOOL)isSDKConfigured; /** Enable the crah logging of PushIO sdk. It will not make and capture any crashes of apps. By default it is enable. You can set `NO` if you do not want PushIO sdk to collect crashes. @param enableCrashLogging boolean value to enable the crash logging. */ - (void)setCrashLoggingEnabled:(BOOL)enableCrashLogging; /** Check if crash logging is enabled for PushIO SDk. We capture only crashes related to sdk. @return TRUE if crash logging is enabled for PushIO sdk, FALSe otherwise. */ - (BOOL)isCrashLoggingEnabled; /** Enable/Disable the in-app messages prefetch. If enabled, all the in-app messages are prefetch and stored in the SDK, and triggered from local storage. If disabled then in-app messages are not prefetched, so not available to be triggered for the event i.e.: $ExplicitAppOpen. @param enableInAppMessageFetch TRUE to enable in-App messages prefetch, FALSE to disable it. */ - (void)setInAppMessageFetchEnabled:(BOOL)enableInAppMessageFetch; /** Configures the SDK using the provided config json file name. @param configFileName Name of the json config file. It is of the format - {account_name_}pushio_config.json @param completionHandler Callback to notify the result of configuration. */ - (void)configureWithFileName:(NSString *)configFileName completionHandler:(PIOCompletionHandler)completionHandler; /** Configures the Responsys SDK. @param apiKey API Key provided by responsys platform. @param accountToken Account token provided by responsys platform. @param conversionUrl Conversion url for tracking Email-to-App conversions. @param riAppId App ID as displayed in Responsys Interact Mobile App Console. @param accountName Account name used for logging in to Responsys Interact portal @param completionHandler Callback to notify the result of configuration. */ - (void)configureWithAPIKey:(NSString *)apiKey accountToken:(NSString *)accountToken conversionUrl:(NSString *)conversionUrl riAppId:(NSString *)riAppId accountName:(NSString *)accountName completionHandler:(PIOCompletionHandler)completionHandler; /** Removes all Message center messages. Use this api only switching the configurations i.e with `configure` API's. */ - (void)clearMessageCenterMessages; /** Removes all InApp messages. Use these api only switching the configurations i.e with `configure` API's */ - (void)clearInAppMessages; /** Set the application badge count and also sync with server. In case of error while syncing badge count will not be set. @param badgeCount count needed to set on app icon. @param completionHandler Callback to notify when badge count set operation completes. */ - (void)setBadgeCount:(NSInteger)badgeCount completionHandler:(PIOCompletionHandler)completionHandler; /** Reset the application badge count to 0 and also sync with server. In case of error while syncing badge count will not be reset. This api will remove the badge count icon from app icon. @param completionHandler Callback to notify when reset badge count operation completes. */ - (void)resetBadgeCountWithCompletionHandler:(PIOCompletionHandler)completionHandler; /** Return the current local badge count of app. @return Return the badge count value. */ - (NSInteger)getBadgeCount; /** Checks if the push payload provided is sent by Responsys platform or not. @param userInfo accepts the userinfo dictionary. @return TRUE if push payload is sent by Responsys platform otherwise FALSE. */ - (BOOL)isResponsysPayload:(NSDictionary *)userInfo; /** Checks if the push notification provided is sent by Responsys platform or not. @param notification accepts the notification. @return TRUE if push payload is sent by Responsys platform otherwise FALSE. */ - (BOOL)isResponsysNotificaton:(UNNotification *)notification; /** Checks if the push notification response provided is sent by Responsys platform or not. @param response accepts the notification response. @return TRUE if push payload is sent by Responsys platform otherwise FALSE. */ - (BOOL)isResponsysNotificationResponse:(UNNotificationResponse *)response; @end