pushwoosh-cordova-plugin 8.3.7 → 8.3.8

package/src/ios/Pushwoosh.framework/Versions/A/Headers/PushNotificationManager.h

@@ -1,574 +0,0 @@
-//
-//  PushNotificationManager.h
-//  Pushwoosh SDK
-//  (c) Pushwoosh 2014
-//
-
-#import <Foundation/Foundation.h>
-
-#if TARGET_OS_IOS
-
-#import <UIKit/UIKit.h>
-#import <StoreKit/StoreKit.h>
-
-#endif
-
-
-@class PushNotificationManager;
-
-#if TARGET_OS_IOS || TARGET_OS_WATCH
-
-#import <UserNotifications/UserNotifications.h>
-
-@class CLLocation;
-
-#endif
-
-typedef void (^PushwooshGetTagsHandler)(NSDictionary *tags);
-typedef void (^PushwooshErrorHandler)(NSError *error);
-
-/**
- `PushNotificationDelegate` protocol defines the methods that can be implemented in the delegate of the `PushNotificationManager` class' singleton object.
- These methods provide information about the key events for push notification manager such as registering with APS services, receiving push notifications or working with the received notification.
- These methods implementation allows to react on these events properly.
- 
- Deprecated. Use PWMessagingDelegate instead.
- */
-@protocol PushNotificationDelegate
-
-@optional
-/**
- Tells the delegate that the application has registered with Apple Push Service (APS) successfully.
- 
- @param token A token used for identifying the device with APS.
- */
-- (void)onDidRegisterForRemoteNotificationsWithDeviceToken:(NSString *)token;
-
-/**
- Sent to the delegate when Apple Push Service (APS) could not complete the registration process successfully.
- 
- @param error An NSError object encapsulating the information about the reason of the registration failure. Within this method you can define application's behaviour in case of registration failure.
- */
-- (void)onDidFailToRegisterForRemoteNotificationsWithError:(NSError *)error;
-
-/**
- Tells the delegate that the push manager has received a remote notification.
- 
- @param pushManager The push manager that received the remote notification.
- @param pushNotification A dictionary that contains information referring to the remote notification, potentially including a badge number for the application icon, an alert sound, an alert message to display to the user, a notification identifier, and custom data.
- The provider originates it as a JSON-defined dictionary that iOS converts to an NSDictionary object; the dictionary may contain only property-list objects plus NSNull.
-@param onStart If the application was not foreground when the push notification was received, the application will be opened with this parameter equal to `YES`, otherwise the parameter will be `NO`.
- */
-- (void)onPushReceived:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification onStart:(BOOL)onStart;
-
-/**
- Tells the delegate that the user has pressed OK on the push notification.
- IMPORTANT: This method is used for backwards compatibility and is deprecated. Please use the `onPushAccepted:withNotification:onStart:` method instead
- 
- @param pushManager The push manager that received the remote notification.
- @param pushNotification A dictionary that contains information referring to the remote notification, potentially including a badge number for the application icon, an alert sound, an alert message to display to the user, a notification identifier, and custom data.
- The provider originates it as a JSON-defined dictionary that iOS converts to an NSDictionary object; the dictionary may contain only property-list objects plus NSNull.
- Push dictionary sample:
- @code
- {
-    aps =     {
-        alert = "Some text.";
-        sound = default;
-    };
-    p = 1pb;
- }
- @endcode
- */
-- (void)onPushAccepted:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification DEPRECATED_ATTRIBUTE;
-
-/**
- Tells the delegate that a custom action was triggered when opening a notification.
- 
- @param identifier NSString containing an ID of a clicked button. This ID is set by a user when creating a category in the Pushwoosh Control Panel
- @param notification NSDictionary with push payload. 
-*/
-- (void)onActionIdentifierReceived:(NSString *)identifier withNotification:(NSDictionary *)notification;
-
-/**
- Tells the delegate that the user has pressed on the push notification banner.
- 
- @param pushManager The push manager that received the remote notification.
- @param pushNotification A dictionary that contains information about the remote notification, potentially including a badge number for the application icon, an alert sound, an alert message to display to the user, a notification identifier, and custom data.
- The provider originates it as a JSON-defined dictionary that iOS converts to an NSDictionary object; the dictionary may contain only property-list objects plus NSNull.
- Push dictionary sample:
- @code
- {
-     aps =     {
-         alert = "Some text.";
-         sound = default;
-     };
-     p = 1pb;
- }
- @endcode
- 
- @param onStart If the application was not foreground when the push notification was received, the application will be opened with this parameter equal to `YES`, otherwise the parameter will be `NO`.
- */
-- (void)onPushAccepted:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification onStart:(BOOL)onStart;
-
-/**
- Tells the delegate that the push manager has received tags from the server.
- 
- @param tags Dictionary representation of received tags.
- Dictionary example:
- @code
- {
-     Country = ru;
-     Language = ru;
- }
- @endcode
- */
-- (void)onTagsReceived:(NSDictionary *)tags;
-
-/**
- Sent to the delegate when push manager could not complete the tags receiving process successfully.
- 
- @param error An NSError object that encapsulates information why receiving tags did not succeed.
- */
-- (void)onTagsFailedToReceive:(NSError *)error;
-
-/**
- Tells the delegate that In-App with specified code has been closed
- 
- @param code In-App code
- */
-- (void)onInAppClosed:(NSString *)code __attribute__((deprecated("Use PWRichMediaPresentingDelegate protocol from PWRichMediaManager.h")));
-
-/**
- Tells the delegate that In-App with specified code has been displayed
- 
- @param code In-App code
- */
-- (void)onInAppDisplayed:(NSString *)code __attribute__((deprecated("Use PWRichMediaPresentingDelegate protocol from PWRichMediaManager.h")));
-
-
-#if TARGET_OS_IOS || TARGET_OS_WATCH
-/**
- The method will be called on the delegate when the application is launched in response to the user's request to view in-app notification settings.
- Add UNAuthorizationOptionProvidesAppNotificationSettings as an option in [PushNotificationManager pushManager].additionalAuthorizationOptions to add a button to inline notification settings view and the notification settings view in Settings.
- The notification will be nil when opened from Settings.
- 
- @param pushManager PushNotificationManager instance
- @param notification Source notification
- */
-- (void)pushManager:(PushNotificationManager *)pushManager openSettingsForNotification:(UNNotification *)notification __IOS_AVAILABLE(12.0);
-
-#endif
-
-@end
-
-/**
- `PWTags` class encapsulates the methods for creating tags parameters for sending them to the server.
- */
-@interface PWTags : NSObject
-
-/**
- Creates a dictionary for incrementing/decrementing a numeric tag on the server.
- 
- Example:
- @code
- NSDictionary *tags = @{
-     @"Alias" : aliasField.text,
-     @"FavNumber" : @([favNumField.text intValue]),
-     @"price": [PWTags incrementalTagWithInteger:5],
- };
- 
- [[PushNotificationManager pushManager] setTags:tags];
- @endcode
- 
- @param delta Difference that needs to be applied to the tag's counter.
- 
- @return Dictionary, that needs to be sent as the value for the tag
- */
-+ (NSDictionary *)incrementalTagWithInteger:(NSInteger)delta;
-
-/**
- Creates a dictionary for extending Tag’s values list with additional values
- 
- Example:
- 
- @code
- NSDictionary *tags = @{
-     @"Alias" : aliasField.text,
-     @"FavNumber" : @([favNumField.text intValue]),
-     @"List" : [PWTags appendValuesToListTag:@[ @"Item1" ]]
- };
- 
- [[PushNotificationManager pushManager] setTags:tags];
- @endcode
- 
- @param array Array of values to be added to the tag.
- 
- @return Dictionary to be sent as the value for the tag
- */
-+ (NSDictionary *)appendValuesToListTag:(NSArray<NSString *> *)array;
-
-@end
-
-/**
- `PushNotificationManager` class offers access to the singleton-instance of the push manager responsible for registering the device with the APS servers, receiving and processing push notifications.
- 
- Deprecated. Use Pushwoosh class instead.
- */
-@interface PushNotificationManager : NSObject {
-}
-
-/**
- Pushwoosh Application ID. Usually retrieved automatically from Info.plist parameter `Pushwoosh_APPID`
- */
-@property (nonatomic, copy, readonly) NSString *appCode;
-
-/**
- Application name. Usually retrieved automatically from Info.plist bundle name (CFBundleDisplayName). Could be used to override bundle name. In addition could be set in Info.plist as `Pushwoosh_APPNAME` parameter.
- */
-@property (nonatomic, copy, readonly) NSString *appName;
-
-/**
- `PushNotificationDelegate` protocol delegate that would receive the information about events for push notification manager such as registering with APS services, receiving push notifications or working with the received notification.
- Pushwoosh Runtime sets it to ApplicationDelegate by default
- */
-@property (nonatomic, weak) NSObject<PushNotificationDelegate> *delegate;
-
-#if TARGET_OS_IOS || TARGET_OS_WATCH
-
-/**
- Show push notifications alert when push notification is received while the app is running, default is `YES`
- */
-@property (nonatomic, assign) BOOL showPushnotificationAlert;
-
-/**
- Authorization options in addition to UNAuthorizationOptionBadge | UNAuthorizationOptionSound | UNAuthorizationOptionAlert | UNAuthorizationOptionCarPlay.
- */
-@property (nonatomic) UNAuthorizationOptions additionalAuthorizationOptions __IOS_AVAILABLE(12.0);
-
-#endif
-
-/**
- Returns push notification payload if the app was started in response to push notification or null otherwise
- */
-@property (nonatomic, copy, readonly) NSDictionary *launchNotification;
-
-#if TARGET_OS_IOS || TARGET_OS_WATCH
-
-/**
- Returns UNUserNotificationCenterDelegate that handles foreground push notifications on iOS10
- */
-@property (nonatomic, strong, readonly) id<UNUserNotificationCenterDelegate> notificationCenterDelegate;
-
-#elif TARGET_OS_OSX
-
-@property (nonatomic, strong, readonly) id<NSUserNotificationCenterDelegate> notificationCenterDelegate;
-
-#endif
-
-/**
- Set custom application language. Must be a lowercase two-letter code according to ISO-639-1 standard ("en", "de", "fr", etc.).
- Device language used by default.
- Set to nil if you want to use device language again.
- */
-@property (nonatomic) NSString *language;
-
-/**
- Initializes PushNotificationManager. Usually called by Pushwoosh Runtime internally.
- @param appCode Pushwoosh App ID.
- @param appName Application name.
- */
-+ (void)initializeWithAppCode:(NSString *)appCode appName:(NSString *)appName;
-
-/**
- Returns an object representing the current push manager.
- 
- @return A singleton object that represents the push manager.
- */
-+ (PushNotificationManager *)pushManager;
-
-/**
- Registers for push notifications. By default registeres for "UIRemoteNotificationTypeBadge | UIRemoteNotificationTypeSound | UIRemoteNotificationTypeAlert" flags.
- Automatically detects if you have "newsstand-content" in "UIBackgroundModes" and adds "UIRemoteNotificationTypeNewsstandContentAvailability" flag.
- */
-- (void)registerForPushNotifications;
-
-/**
- Unregisters from push notifications.
- */
-- (void)unregisterForPushNotificationsWithCompletion:(void (^)(NSError *error))completion;
-
-/**
- Deprecated. Use unregisterForPushNotificationsWithCompletion: method instead
- */
-- (void)unregisterForPushNotifications __attribute__((deprecated));
-
-/**
- Deprecated. Use initializeWithAppCode:appName: method instead
- */
-- (instancetype)initWithApplicationCode:(NSString *)appCode appName:(NSString *)appName __attribute__((deprecated));
-
-#if TARGET_OS_IOS
-
-/**
- Deprecated. Use initializeWithAppCode:appName: method instead
- */
-- (id)initWithApplicationCode:(NSString *)appCode navController:(UIViewController *)navController appName:(NSString *)appName __attribute__((deprecated));
-
-/**
- Start location tracking.
- 
- Deprecated. Use PushwooshGeozones framework.
- */
-- (void)startLocationTracking __attribute__((deprecated("Use PushwooshGeozones framework")));
-
-/**
- Stops location tracking
- 
- Deprecated. Use PushwooshGeozones framework.
- */
-- (void)stopLocationTracking __attribute__((deprecated("Use PushwooshGeozones framework")));
-
-/**
- Explicitly sends geolocation to the server for GeoFencing push technology. Also called internally, please use `startLocationTracking` and `stopLocationTracking` functions.
- 
- @param location Location to be sent.
- 
- Deprecated. Use PushwooshGeozones framework.
- */
-- (void)sendLocation:(CLLocation *)location __attribute__((deprecated("Use PushwooshGeozones framework")));
-
-#endif
-
-/**
- Send tags to server. Tag names have to be created in the Pushwoosh Control Panel. Possible tag types: Integer, String, Incremental (integer only), List tags (array of values).
- 
- Example:
- @code
- NSDictionary *tags =  @{ @"Alias" : aliasField.text,
-                      @"FavNumber" : @([favNumField.text intValue]),
-                          @"price" : [PWTags incrementalTagWithInteger:5],
-                           @"List" : @[ @"Item1", @"Item2", @"Item3" ]
- };
-	
- [[PushNotificationManager pushManager] setTags:tags];
- @endcode
- 
- @param tags Dictionary representation of tags to send.
- */
-- (void)setTags:(NSDictionary *)tags;
-
-/**
- Send tags to server with completion block. If setTags succeeds competion is called with nil argument. If setTags fails completion is called with error.
- */
-- (void)setTags:(NSDictionary *)tags withCompletion:(void (^)(NSError *error))completion;
-
-/**
- Get tags from the server. Calls delegate method `onTagsReceived:` or `onTagsFailedToReceive:` depending on the results.
- */
-- (void)loadTags;
-
-/**
- Get tags from server. Calls delegate method if exists and handler (block).
- 
- @param successHandler The block is executed on the successful completion of the request. This block has no return value and takes one argument: the dictionary representation of the recieved tags.
- Example of the dictionary representation of the received tags:
- {
-     Country = ru;
-     Language = ru;
- }
- @param errorHandler The block is executed on the unsuccessful completion of the request. This block has no return value and takes one argument: the error that occurred during the request.
- */
-- (void)loadTags:(PushwooshGetTagsHandler)successHandler error:(PushwooshErrorHandler)errorHandler;
-
-/**
- Informs the Pushwoosh about the app being launched. Usually called internally by SDK Runtime.
- */
-- (void)sendAppOpen;
-
-+ (NSString *)pushwooshVersion;
-
-#if TARGET_OS_IOS
-/**
- Sends in-app purchases to Pushwoosh. Use in paymentQueue:updatedTransactions: payment queue method (see example).
- 
- Example:
- @code
- - (void)paymentQueue:(SKPaymentQueue *)queue updatedTransactions:(NSArray *)transactions {
-     [[PushNotificationManager pushManager] sendSKPaymentTransactions:transactions];
- }
- @endcode
- 
- @param transactions Array of SKPaymentTransaction items as received in the payment queue.
- */
-- (void)sendSKPaymentTransactions:(NSArray *)transactions;
-
-
-/**
- Tracks individual in-app purchase. See recommended `sendSKPaymentTransactions:` method.
- 
- @param productIdentifier purchased product ID
- @param price price for the product
- @param currencyCode currency of the price (ex: @"USD")
- @param date time of the purchase (ex: [NSDate now])
- */
-- (void)sendPurchase:(NSString *)productIdentifier withPrice:(NSDecimalNumber *)price currencyCode:(NSString *)currencyCode andDate:(NSDate *)date;
-
-#endif
-/**
- Gets current push token.
- 
- @return Current push token. May be nil if no push token is available yet.
- */
-- (NSString *)getPushToken;
-
-/**
- Gets HWID. Unique device identifier that used in all API calls with Pushwoosh.
- This is identifierForVendor for iOS >= 7.
- 
- @return Unique device identifier.
- */
-- (NSString *)getHWID;
-
-- (void)handlePushRegistration:(NSData *)devToken;
-- (void)handlePushRegistrationString:(NSString *)deviceID;
-
-- (void)handlePushRegistrationFailure:(NSError *)error;
-
-//If the push is received while the app is running. Call it only for iOS version < 10. For iOS 10 and higher use notificationCenterDelegate.
-- (BOOL)handlePushReceived:(NSDictionary *)userInfo;
-
-/**
- Gets APN payload from push notifications dictionary.
- 
- Example:
- @code
- - (void)onPushAccepted:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification onStart:(BOOL)onStart {
-     NSDictionary * apnPayload = [[PushNotificationsManager pushManager] getApnPayload:pushNotification];
-     NSLog(@"%@", apnPayload);
- }
- @endcode
- 
- For Push dictionary sample:
- @code
- {
-     aps =     {
-         alert = "Some text.";
-         sound = default;
-     };
-     p = 1pb;
- }
- @endcode
- 
- Result is:
- @code
- {
-     alert = "Some text.";
-     sound = default;
- };
- @endcode
- @param pushNotification Push notifications dictionary as received in `onPushAccepted: withNotification: onStart:`
- */
-- (NSDictionary *)getApnPayload:(NSDictionary *)pushNotification;
-
-/**
- Gets custom JSON string data from push notifications dictionary as specified in Pushwoosh Control Panel.
- 
- Example:
- @code
- - (void)onPushAccepted:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification onStart:(BOOL)onStart {
-     NSString * customData = [[PushNotificationsManager pushManager] getCustomPushData:pushNotification];
-     NSLog(@"%@", customData);
- }
- @endcode
- 
- @param pushNotification Push notifications dictionary as received in `onPushAccepted: withNotification: onStart:`
- */
-- (NSString *)getCustomPushData:(NSDictionary *)pushNotification;
-
-/**
- The same as getCustomPushData but returns NSDictionary rather than JSON string (converts JSON string into NSDictionary).
- */
-- (NSDictionary *)getCustomPushDataAsNSDict:(NSDictionary *)pushNotification;
-
-/**
- Returns dictionary with enabled remove notificaton types.
- 
- Example enabled push:
- @code
- {
-	enabled = 1;
-	pushAlert = 1;
-	pushBadge = 1;
-	pushSound = 1;
-	type = 7;
- }
- @endcode
- where "type" field is UIUserNotificationType
- 
- Disabled push:
- @code
- {
-	enabled = 1;
-	pushAlert = 0;
-	pushBadge = 0;
-	pushSound = 0;
-	type = 0;
- }
- @endcode
- 
- Note: In the latter example "enabled" field means that device can receive push notification but could not display alerts (ex: silent push)
- */
-+ (NSMutableDictionary *)getRemoteNotificationStatus;
-
-/**
- Clears the notifications from the notification center.
- */
-+ (void)clearNotificationCenter;
-
-/**
- Set User indentifier. This could be Facebook ID, username or email, or any other user ID.
- This allows data and events to be matched across multiple user devices.
- 
- Deprecated. Use PWInAppManager setUserId method instead
- */
-- (void)setUserId:(NSString *)userId __attribute__ ((deprecated));;
-
-/**
- Move all events from oldUserId to newUserId if doMerge is true. If doMerge is false all events for oldUserId are removed.
- 
- @param oldUserId source user
- @param newUserId destination user
- @param doMerge if false all events for oldUserId are removed, if true all events for oldUserId are moved to newUserId
- @param completion callback
- 
- Deprecated. Use PWInAppManager mergeUserId method instead
- */
-- (void)mergeUserId:(NSString *)oldUserId to:(NSString *)newUserId doMerge:(BOOL)doMerge completion:(void (^)(NSError *error))completion __attribute__ ((deprecated));
-
-/**
- Post events for In-App Messages. This can trigger In-App message display as specified in Pushwoosh Control Panel.
- 
- Example:
- @code
- [[PushNotificationManager pushManager] setUserId:@"96da2f590cd7246bbde0051047b0d6f7"];
- [[PushNotificationManager pushManager] postEvent:@"buttonPressed" withAttributes:@{ @"buttonNumber" : @"4", @"buttonLabel" : @"Banner" } completion:nil];
- @endcode
- 
- @param event name of the event
- @param attributes NSDictionary of event attributes
- @param completion function to call after posting event
- 
- Deprecated. Use PWInAppManager postEvent method instead
- */
-- (void)postEvent:(NSString *)event withAttributes:(NSDictionary *)attributes completion:(void (^)(NSError *error))completion __attribute__ ((deprecated));
-
-/**
- See `postEvent:withAttributes:completion:`
- 
- Deprecated. Use PWInAppManager postEvent method instead
- */
-- (void)postEvent:(NSString *)event withAttributes:(NSDictionary *)attributes __attribute__ ((deprecated));
-
-+ (BOOL)isPushwooshMessage:(NSDictionary *)userInfo;
-
-@end