-
Notifications
You must be signed in to change notification settings - Fork 262
/
OSInAppMessageViewController.m
905 lines (750 loc) · 40.7 KB
/
OSInAppMessageViewController.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
/**
* Modified MIT License
*
* Copyright 2017 OneSignal
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* 1. The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* 2. All copies of substantial portions of the Software may only be used in connection
* with services provided by OneSignal.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#import "OSInAppMessageViewController.h"
#import "OSInAppMessageView.h"
#import "OSInAppMessageController.h"
#import "OSInAppMessageBridgeEvent.h"
#import <OneSignalOutcomes/OneSignalOutcomes.h>
#import "OSSessionManager.h"
#define HIGHEST_CONSTRAINT_PRIORITY 999.0f
#define HIGH_CONSTRAINT_PRIORITY 990.0f
#define MEDIUM_CONSTRAINT_PRIORITY 950.0f
#define LOW_CONSTRAINT_PRIORITY 900.0f
@interface OSInAppMessageViewController ()
// The actual message subview
@property (nonatomic, nullable) OSInAppMessageView *messageView;
// Before the top and bottom banner IAMs display, this constrains the Y position
// of the message to be off-screen
@property (strong, nonatomic, nonnull) NSLayoutConstraint *initialYConstraint;
// This constrains the Y position once the initial animation is finished
@property (strong, nonatomic, nonnull) NSLayoutConstraint *finalYConstraint;
// This constraint enforces an aspect ratio for the given message type (ie. banner)
@property (strong, nonatomic, nonnull) NSLayoutConstraint *heightConstraint;
// This recognizer lets the user pan (swipe) the message up and down
@property (weak, nonatomic, nullable) UIPanGestureRecognizer *panGestureRecognizer;
// This tap recognizer lets us dismiss the message if the user taps the background
@property (weak, nonatomic, nullable) UITapGestureRecognizer *tapGestureRecognizer;
// Previous orinetation which is assigned at the end of a device orinetation change
@property (nonatomic) ViewOrientation previousOrientation;
@property (nonatomic) ViewOrientation orientationOnBackground;
// This point represents the X/Y location of where the most recent
// pan gesture started. Used to determine the offset
@property (nonatomic) CGPoint initialGestureRecognizerLocation;
// This constraint determines the Y position when panning the message up or down
@property (strong, nonatomic, nullable) NSLayoutConstraint *panVerticalConstraint;
// This timer is used to dismiss in-app messages if the "max_display_time" is set
// We start the timer once the message is displayed (not during loading the content)
@property (nonatomic) double maxDisplayTime;
// This timer is used to dismiss in-app messages if the "max_display_time" is set
// We start the timer once the message is displayed (not during loading the content)
@property (weak, nonatomic, nullable) NSTimer *dismissalTimer;
// BOOL to track when an IAM has started UI setup so we know when to bypass UI changes on dismissal or not
// This is a fail safe for cases where global contraints are nil and we try to modify them on dismissal of an IAM
@property (nonatomic) BOOL didPageRenderingComplete;
// BOOL to track if the message content has loaded before tags have finished loading for liquid templating
@property (nonatomic, nullable) NSString *pendingHTMLContent;
@property (nonatomic) BOOL useHeightMargin;
@property (nonatomic) BOOL useWidthMargin;
@property (nonatomic) BOOL isFullscreen;
@end
@implementation OSInAppMessageViewController
OSInAppMessageInternal *_dismissingMessage = nil;
- (instancetype _Nonnull)initWithMessage:(OSInAppMessageInternal *)inAppMessage delegate:(id<OSInAppMessageViewControllerDelegate>)delegate {
if (self = [super init]) {
self.message = inAppMessage;
self.delegate = delegate;
self.useHeightMargin = YES;
self.useWidthMargin = YES;
_dismissingMessage = nil;
}
return self;
}
- (BOOL)prefersStatusBarHidden {
// Only the full-bleed IAM should remove status bar
return self.isFullscreen;
}
- (void)viewDidLoad {
[super viewDidLoad];
// Add observers for BecomeActive and EnterBackground state so that the IAM can be shown correctly when leaving and entering the app (background)
[self addAppBecomeActiveObserver];
[self addAppEnterBackgroundObserver];
self.messageView = [[OSInAppMessageView alloc] initWithMessage:self.message withScriptMessageHandler:self];
self.messageView.delegate = self;
// Loads the HTML content for the IAM
if (self.message.isPreview)
[self loadPreviewMessageContent];
else
[self loadMessageContent];
}
- (void)viewWillAppear:(BOOL)animated {
[super viewWillAppear:animated];
}
- (void)viewWillDisappear:(BOOL)animated {
[super viewWillDisappear:animated];
[self.dismissalTimer invalidate];
[self.messageView removeScriptMessageHandler];
}
- (void)applicationIsActive:(NSNotification *)notification {
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Application Active"];
// Animate the showing of the IAM when opening the app from background
[self animateAppearance:NO];
}
- (void)applicationIsInBackground:(NSNotification *)notification {
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Application Entered Background"];
// Get current orientation of the device
UIDeviceOrientation currentDeviceOrientation = UIDevice.currentDevice.orientation;
self.orientationOnBackground = [OneSignalCoreHelper validateOrientation:currentDeviceOrientation];
// Make sure pan constraint is no longer active so IAM does not stay in panned location
self.panVerticalConstraint.active = false;
self.messageView.hidden = true;
}
- (void)addAppBecomeActiveObserver {
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(applicationIsActive:) name:UIApplicationDidBecomeActiveNotification object:nil];
}
- (void)addAppEnterBackgroundObserver {
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(applicationIsInBackground:) name:UIApplicationDidEnterBackgroundNotification object:nil];
}
/*
Sets up the message UI, while it is still hidden
Wait until the actual HTML content is loaded before animating appearance
*/
- (void)setupInitialMessageUI {
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Setting up In-App Message"];
self.messageView.delegate = self;
[self.messageView setupWebViewConstraints];
[self.view addSubview:self.messageView];
[self addConstraintsForMessage];
[self setupGestureRecognizers];
// Only the center modal and full screen (both centered) IAM should have a dark background
// So get the alpha based on the IAM being a banner or not
double alphaBackground = [self.message isBanner] ? 0.0 : 0.5;
// the plist value specifies whether the user wants to add a gray overlay to the In App Message
NSDictionary *bundleDict = [[NSBundle mainBundle] infoDictionary];
BOOL hideGrayOverlay = [bundleDict[ONESIGNAL_IN_APP_HIDE_GRAY_OVERLAY] boolValue];
if (hideGrayOverlay) {
self.view.backgroundColor = [UIColor clearColor];
} else {
self.view.backgroundColor = [UIColor colorWithRed:0.0 green:0.0 blue:0.0 alpha:alphaBackground];
}
[UIView animateWithDuration:0.3 animations:^{
self.view.alpha = 1.0;
} completion:^(BOOL finished) {
if (!finished)
return;
[self animateAppearance:YES];
}];
}
- (void)updateDropShadow {
// the plist value specifies whether the user wants to add drop shadow to the In App Message
NSDictionary *bundleDict = [[NSBundle mainBundle] infoDictionary];
BOOL hideDropShadow = [bundleDict[ONESIGNAL_IN_APP_HIDE_DROP_SHADOW] boolValue];
if (hideDropShadow) {
return;
}
self.messageView.layer.shadowOffset = CGSizeMake(0, 3);
self.messageView.layer.shadowColor = [[UIColor blackColor] CGColor];
self.messageView.layer.shadowRadius = 3.0f;
self.messageView.layer.shadowOpacity = 0.55f;
}
- (void)displayMessage {
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Displaying In-App Message"];
// Sets up the message view in a hidden position while we wait
[self setupInitialMessageUI];
// If the message has a max display time, set up the timer now
if (self.maxDisplayTime > 0.0f)
self.dismissalTimer = [NSTimer scheduledTimerWithTimeInterval:self.maxDisplayTime
target:self
selector:@selector(maxDisplayTimeTimerFinished)
userInfo:nil
repeats:false];
}
- (void)maxDisplayTimeTimerFinished {
[self dismissCurrentInAppMessage:0.0f];
}
- (OSResultSuccessBlock)messageContentOnSuccess {
return ^(NSDictionary *data) {
[OneSignalCoreHelper dispatch_async_on_main_queue:^{
if (!data) {
[self encounteredErrorLoadingMessageContent:nil];
return;
}
let message = [NSString stringWithFormat:@"In App Messaging htmlContent.html: %@", data[@"html"]];
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:message];
if (!self.message.isPreview)
[[OSSessionManager sharedSessionManager] onInAppMessageReceived:self.message.messageId];
let baseUrl = [NSURL URLWithString:OS_IAM_WEBVIEW_BASE_URL];
[self parseContentData:data];
if (self.waitForTags) {
return;
}
[self updateDropShadow];
[self.delegate messageWillDisplay:self.message];
[self.messageView loadedHtmlContent:self.pendingHTMLContent withBaseURL:baseUrl];
self.pendingHTMLContent = nil;
}];
};
}
- (void)parseContentData:(NSDictionary *)data {
self.pendingHTMLContent = data[@"html"];
self.maxDisplayTime = [data[@"display_duration"] doubleValue];
NSDictionary *styles = data[@"styles"];
if (styles) {
// We are currently only allowing default margin or no margin.
// If we receive a number that isn't 0 we want to use default margin for now.
if (styles[@"remove_height_margin"]) {
self.useHeightMargin = ![styles[@"remove_height_margin"] boolValue];
}
if (styles[@"remove_width_margin"]) {
self.useWidthMargin = ![styles[@"remove_width_margin"] boolValue];
}
}
self.isFullscreen = !self.useHeightMargin;
if (self.isFullscreen) {
self.pendingHTMLContent = [self setContentInsetsInHTML:self.pendingHTMLContent];
}
[self.messageView setIsFullscreen:self.isFullscreen];
}
- (NSString *)setContentInsetsInHTML:(NSString *)html {
NSMutableString *newHTML = [[NSMutableString alloc] initWithString:html];
if (@available(iOS 11, *)) {
UIWindow *keyWindow = UIApplication.sharedApplication.keyWindow;
if (!keyWindow) {
return newHTML;
}
CGFloat top = keyWindow.safeAreaInsets.top;
CGFloat bottom = keyWindow.safeAreaInsets.bottom;
CGFloat right = keyWindow.safeAreaInsets.right;
CGFloat left = keyWindow.safeAreaInsets.left;
NSString *safeAreaInsetsObjectString = [NSString stringWithFormat:OS_JS_SAFE_AREA_INSETS_OBJ,top, bottom, right, left];
NSString *insetsString = [NSString stringWithFormat:@"\n\n\
<script> \
setSafeAreaInsets(%@);\
</script>",safeAreaInsetsObjectString];
[newHTML appendString: insetsString];
}
return newHTML;
}
- (void)setWaitForTags:(BOOL)waitForTags {
_waitForTags = waitForTags;
if (!waitForTags && self.pendingHTMLContent) {
dispatch_async(dispatch_get_main_queue(), ^{
[self.messageView loadedHtmlContent:self.pendingHTMLContent withBaseURL:[NSURL URLWithString:OS_IAM_WEBVIEW_BASE_URL]];
self.pendingHTMLContent = nil;
});
}
}
- (void)loadMessageContent {
[self.message loadMessageHTMLContentWithResult:[self messageContentOnSuccess] failure:^(NSError *error) {
[self encounteredErrorLoadingMessageContent:error];
}];
}
- (void)loadPreviewMessageContent {
[self.message loadPreviewMessageHTMLContentWithUUID:self.message.messageId
success:[self messageContentOnSuccess]
failure:^(NSError *error) {
[self encounteredErrorLoadingMessageContent:error];
}];
}
- (void)encounteredErrorLoadingMessageContent:(NSError * _Nullable)error {
let message = [NSString stringWithFormat:@"An error occurred while attempting to load message content: %@", error.description ?: @"Unknown Error"];
if (error.code == 410 || error.code == 404) {
[self.delegate messageIsNotActive:self.message];
}
[OneSignalLog onesignalLog:ONE_S_LL_ERROR message:message];
}
/*
Sets up the message view in its initial (hidden) position
Adds constraints so that the message view has the correct size
Once the HTML content is loaded, we call animateAppearance() to show the message view
*/
- (void)addConstraintsForMessage {
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Setting up In-App Message Constraints"];
if (![self.view.subviews containsObject:self.messageView]) {
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"addConstraintsForMessage: messageView is not a subview of OSInAppMessageViewController"];
[self.view addSubview:self.messageView];
}
// Initialize the anchors that describe the edges of the view, such as the top, bottom, etc.
NSLayoutAnchor *top = self.view.topAnchor,
*bottom = self.view.bottomAnchor,
*leading = self.view.leadingAnchor,
*trailing = self.view.trailingAnchor,
*center = self.view.centerXAnchor;
NSLayoutDimension *height = self.view.heightAnchor;
// The safe area represents the anchors that are not obscurable by UI such
// as a notch or a rounded corner on newer iOS devices like iPhone X
// Note that Safe Area layout guides were only introduced in iOS 11
if (@available(iOS 11, *)) {
if (!self.isFullscreen) {
let safeArea = self.view.safeAreaLayoutGuide;
top = safeArea.topAnchor;
bottom = safeArea.bottomAnchor;
leading = safeArea.leadingAnchor;
trailing = safeArea.trailingAnchor;
center = safeArea.centerXAnchor;
height = safeArea.heightAnchor;
}
}
CGRect mainBounds = [OneSignalCoreHelper getScreenBounds];
CGFloat marginSpacing = [OneSignalCoreHelper sizeToScale:MESSAGE_MARGIN];
let screenHeight = [NSString stringWithFormat:@"Screen Bounds Height: %f", mainBounds.size.height];
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:screenHeight];
let screenWidth = [NSString stringWithFormat:@"Screen Bounds Width: %f", mainBounds.size.width];
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:screenWidth];
let screenScale = [NSString stringWithFormat:@"Screen Bounds Scale: %f", UIScreen.mainScreen.scale];
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:screenScale];
let heightMessage = [NSString stringWithFormat:@"In App Message Height: %f", self.message.height.doubleValue];
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:heightMessage];
// Height constraint based on the IAM being full screen or any others with a specific height
// NOTE: full screen IAM payload has no height, so match screen height minus margins
if (self.message.position == OSInAppMessageDisplayPositionFullScreen)
self.heightConstraint = [self.messageView.heightAnchor constraintEqualToAnchor:height multiplier:1.0 constant:(self.useHeightMargin ? (2*-marginSpacing) : 0)];
else
self.heightConstraint = [self.messageView.heightAnchor constraintEqualToConstant:self.message.height.doubleValue];
// The aspect ratio for each type (ie. Banner) determines the height normally
// However the actual height of the HTML content takes priority.
// Makes sure our webview is never taller than our screen.
[self.messageView.heightAnchor constraintLessThanOrEqualToAnchor:height multiplier:1.0 constant:(self.useHeightMargin ? (2*-marginSpacing) : 0)].active = true;
// Pins the message view to the left & right
let leftConstraint = [self.messageView.leadingAnchor constraintEqualToAnchor:leading constant:(self.useWidthMargin ? marginSpacing : 0)];
let rightConstraint = [self.messageView.trailingAnchor constraintEqualToAnchor:trailing constant:(self.useWidthMargin ? -marginSpacing : 0)];
// Ensure the message view is always centered horizontally
[self.messageView.centerXAnchor constraintEqualToAnchor:center].active = true;
// Set Y constraints
// Since we animate the appearance of the message (ie. slide in from top),
// there are two constraints: initial and final. At initialization, the initial
// constraint has a higher priority. The pan constraint is used only when panning
double bannerWidth = mainBounds.size.width;
double bannerHeight = self.message.height.doubleValue + (2.0f * marginSpacing);
double bannerMessageY = mainBounds.size.height - bannerHeight;
switch (self.message.position) {
case OSInAppMessageDisplayPositionTop:
if (@available(iOS 11, *)) {
UIEdgeInsets safeAreaInsets = self.view.window.safeAreaInsets;
bannerHeight += safeAreaInsets.top + safeAreaInsets.bottom;
}
double statusBarHeight = UIApplication.sharedApplication.statusBarFrame.size.height;
bannerHeight += statusBarHeight;
self.view.window.frame = CGRectMake(0, 0, bannerWidth, bannerHeight);
self.initialYConstraint = [self.messageView.bottomAnchor constraintEqualToAnchor:self.view.topAnchor constant:-8.0f];
self.finalYConstraint = [self.messageView.topAnchor constraintEqualToAnchor:top
constant:(self.useHeightMargin ? marginSpacing : 0)];
self.panVerticalConstraint = [self.messageView.topAnchor constraintEqualToAnchor:top
constant:(self.useHeightMargin ? marginSpacing : 0)];
break;
case OSInAppMessageDisplayPositionBottom:
if (@available(iOS 11, *)) {
UIEdgeInsets safeAreaInsets = self.view.window.safeAreaInsets;
bannerHeight += safeAreaInsets.top + safeAreaInsets.bottom;
bannerMessageY = mainBounds.size.height - bannerHeight;
}
self.view.window.frame = CGRectMake(0, bannerMessageY, bannerWidth, bannerHeight);
self.initialYConstraint = [self.messageView.topAnchor constraintEqualToAnchor:self.view.bottomAnchor constant:8.0f];
self.finalYConstraint = [self.messageView.bottomAnchor constraintEqualToAnchor:bottom
constant:(self.useHeightMargin ? -marginSpacing : 0)];
self.panVerticalConstraint = [self.messageView.bottomAnchor constraintEqualToAnchor:bottom
constant:(self.useHeightMargin ? -marginSpacing : 0)];
break;
case OSInAppMessageDisplayPositionFullScreen:
case OSInAppMessageDisplayPositionCenterModal:
self.view.window.frame = mainBounds;
NSLayoutAnchor *centerYanchor = self.view.centerYAnchor;
if (@available(iOS 11, *)) {
if (!self.isFullscreen) {
let safeArea = self.view.safeAreaLayoutGuide;
centerYanchor = safeArea.centerYAnchor;
}
}
self.initialYConstraint = [self.messageView.centerYAnchor constraintEqualToAnchor:centerYanchor constant:0.0f];
self.finalYConstraint = [self.messageView.centerYAnchor constraintEqualToAnchor:centerYanchor constant:0.0f];
self.panVerticalConstraint = [self.messageView.centerYAnchor constraintEqualToAnchor:centerYanchor constant:0.0f];
self.messageView.transform = CGAffineTransformMakeScale(0, 0);
break;
}
// We use different constraint priorities so that, by changing them, we can do stuff
// like animating the dismissal of the message view by simply changing one of the
// Y constraint's priority. Constraints with higher priority take precedence over
// constraints with lower priorities.
// Sets the proper intro animation constraints
self.heightConstraint.priority = HIGH_CONSTRAINT_PRIORITY;
self.initialYConstraint.priority = HIGH_CONSTRAINT_PRIORITY;
self.finalYConstraint.priority = MEDIUM_CONSTRAINT_PRIORITY;
self.panVerticalConstraint.priority = HIGHEST_CONSTRAINT_PRIORITY;
leftConstraint.priority = MEDIUM_CONSTRAINT_PRIORITY;
rightConstraint.priority = MEDIUM_CONSTRAINT_PRIORITY;
// Constraints should all be active except for the panVerticalConstraint, which
// is only active when the user is panning (swiping)
self.panVerticalConstraint.active = false;
self.heightConstraint.active = true;
self.initialYConstraint.active = true;
self.finalYConstraint.active = true;
leftConstraint.active = true;
rightConstraint.active = true;
// Adding all of these constraints has caused the view's needsLayout property
// to become true, so when we call layoutIfNeeded, it causes the view
// hierarchy to be updated and our constraints get applied.
[self.view layoutIfNeeded];
}
// Calls dismissCurrentInAppMessage with velocity at 0.0f
- (void)dismissCurrentInAppMessage {
BOOL isTopBanner = self.message.position == OSInAppMessageDisplayPositionTop;
[self dismissCurrentInAppMessage:isTopBanner
withVelocity:0.0f];
}
// Calls dismissCurrentInAppMessage with specified velocity
- (void)dismissCurrentInAppMessage:(double)velocity {
BOOL isTopBanner = self.message.position == OSInAppMessageDisplayPositionTop;
[self dismissCurrentInAppMessage:isTopBanner
withVelocity:velocity];
}
/*
Dismisses the message view with a given direction (up or down) and velocity
If velocity == 0.0, the default dismiss velocity will be used
*/
- (void)dismissCurrentInAppMessage:(BOOL)up withVelocity:(double)velocity {
// Since the user dimsissed the IAM, cancel the dismissal timer
if (self.dismissalTimer)
[self.dismissalTimer invalidate];
// If the rendering event never occurs any constraints being adjusted for dismissal will be nil
// and we should bypass dismissal adjustments and animations and skip straight to the OSMessagingController callback for dismissing
if (!self.didPageRenderingComplete) {
[self dismissViewControllerAnimated:false completion:nil];
[self.delegate messageViewControllerWasDismissed:self.message displayed:NO];
return;
}
if (_dismissingMessage == self.message) {
return;
}
[self.delegate messageViewControllerWillDismiss:self.message];
// Inactivate the current Y constraints
self.finalYConstraint.active = false;
self.initialYConstraint.active = false;
// The distance that the dismissal animation will travel
var distance = 0.0f;
// Add new Y constraints
if (up) {
distance = self.messageView.frame.origin.y + self.messageView.frame.size.height + 8.0f;
[self.messageView.bottomAnchor constraintEqualToAnchor:self.view.topAnchor constant:-8.0f].active = true;
} else {
distance = self.view.frame.size.height - self.messageView.frame.origin.y + 8.0f;
[self.messageView.topAnchor constraintEqualToAnchor:self.view.bottomAnchor constant:8.0f].active = true;
}
var dismissAnimationDuration = velocity != 0.0f ? distance / fabs(velocity) : 0.3f;
var animationOption = UIViewAnimationOptionCurveLinear;
// Impose a minimum animation speed (max duration)
if (dismissAnimationDuration > MAX_DISMISSAL_ANIMATION_DURATION) {
animationOption = UIViewAnimationOptionCurveEaseIn;
dismissAnimationDuration = MAX_DISMISSAL_ANIMATION_DURATION;
} else if (dismissAnimationDuration < MIN_DISMISSAL_ANIMATION_DURATION) {
animationOption = UIViewAnimationOptionCurveEaseIn;
dismissAnimationDuration = MIN_DISMISSAL_ANIMATION_DURATION;
}
_dismissingMessage = self.message;
[UIView animateWithDuration:dismissAnimationDuration delay:0.0f options:animationOption animations:^{
self.view.backgroundColor = [UIColor clearColor];
self.view.alpha = 0.0f;
[self.view layoutIfNeeded];
} completion:^(BOOL finished) {
if (!finished)
return;
self.didPageRenderingComplete = false;
[self.delegate messageViewControllerWasDismissed:self.message displayed:YES];
}];
}
/*
Once HTML is loaded, the message should be presented
This method animates the actual appearance of the message view
For banners the initialYConstraint is set to LOW_CONSTRAINT_PRIORITY
For center modal and full screen, the transform is set to CGAffineTransformIdentity (original scale)
*/
- (void)animateAppearance:(BOOL)firstDisplay {
self.initialYConstraint.priority = LOW_CONSTRAINT_PRIORITY;
[UIView animateWithDuration:0.3f animations:^{
self.messageView.hidden = false;
self.messageView.transform = CGAffineTransformIdentity;
[self.view layoutIfNeeded];
} completion:^(BOOL finished) {
if (firstDisplay) {
[self.delegate messageViewControllerDidDisplay:self.message];
}
}];
}
- (void)beginPanAtLocation:(CGPoint)location {
self.panVerticalConstraint.constant = self.finalYConstraint.constant;
self.initialGestureRecognizerLocation = location;
self.panVerticalConstraint.active = true;
}
/*
Adds the pan recognizer (for swiping up and down) and the tap recognizer (for dismissing)
*/
- (void)setupGestureRecognizers {
if (!self.message.dragToDismissDisabled) {
// Pan gesture recognizer for swiping
let recognizer = [[UIPanGestureRecognizer alloc] initWithTarget:self action:@selector(panGestureRecognizerDidMove:)];
[self.messageView addGestureRecognizer:recognizer];
recognizer.maximumNumberOfTouches = 1;
recognizer.minimumNumberOfTouches = 1;
self.panGestureRecognizer = recognizer;
}
// Only center modal and full screen should dismiss on background click
// Banners will allow interacting with the view behind it still
if (![self.message isBanner]) {
// Tap gesture recognizer for tapping background (dismissing)
let tapRecognizer = [[UITapGestureRecognizer alloc] initWithTarget:self action:@selector(tapGestureRecognizerDidTap:)];
tapRecognizer.numberOfTapsRequired = 1;
[self.view addGestureRecognizer:tapRecognizer];
self.tapGestureRecognizer = tapRecognizer;
}
}
/*
Called when the user pans (swipes) the message view
*/
- (void)panGestureRecognizerDidMove:(UIPanGestureRecognizer *)sender {
// Tells us the location of the gesture inside the entire view
let location = [sender locationInView:self.view];
// Tells us the velocity of the dismissal gesture in points per second
let velocity = [sender velocityInView:self.view].y;
// Return early if we are just beginning the pan interaction
// Set up the pan constraints to move the view
if (sender.state == UIGestureRecognizerStateBegan) {
[self beginPanAtLocation:location];
// Since the user interacted with the content, cancel the
// Max display time timer if it is scheduled
if (self.dismissalTimer)
[self.dismissalTimer invalidate];
return;
}
// Tells us the offset from the message view's normal position
let offset = self.initialGestureRecognizerLocation.y - location.y;
if (sender.state == UIGestureRecognizerStateEnded) {
// Inactivate the pan constraint since we are no longer panning
self.panVerticalConstraint.active = false;
// Indicates if the in-app message was swiped away
if ([self shouldDismissMessageWithPanGestureOffset:offset withVelocity:velocity]) {
if ([self.message isBanner]) {
// Top messages can only be dismissed by swiping up
// Bottom messages can only be dismissed swiping down
[self dismissCurrentInAppMessage:velocity];
} else {
// Centered messages can be dismissed in either direction (up/down)
[self dismissCurrentInAppMessage:offset > 0 withVelocity:velocity];
}
} else {
// The pan constraint is now inactive, calling layoutIfNeeded() will cause the message to snap back to normal position
[UIView animateWithDuration:0.3 animations:^{
[self.view layoutIfNeeded];
}];
}
} else if (sender.state == UIGestureRecognizerStateChanged) {
switch (self.message.position) {
case OSInAppMessageDisplayPositionTop:
if (self.panVerticalConstraint.constant < self.finalYConstraint.constant + offset) {
// The pan interaction is in progress, move the view to match the offset
self.panVerticalConstraint.constant = self.finalYConstraint.constant - offset;
} else {
self.panVerticalConstraint.constant = self.finalYConstraint.constant;
}
break;
case OSInAppMessageDisplayPositionBottom:
if (self.panVerticalConstraint.constant > self.finalYConstraint.constant + offset) {
// The pan interaction is in progress, move the view to match the offset
self.panVerticalConstraint.constant = self.finalYConstraint.constant - offset;
} else {
self.panVerticalConstraint.constant = self.finalYConstraint.constant;
}
break;
case OSInAppMessageDisplayPositionFullScreen:
case OSInAppMessageDisplayPositionCenterModal:
self.panVerticalConstraint.constant = self.finalYConstraint.constant - offset;
break;
}
[self.view layoutIfNeeded];
}
}
/*
Called when the user taps on the background view
*/
- (void)tapGestureRecognizerDidTap:(UITapGestureRecognizer *)sender {
[self dismissCurrentInAppMessage];
}
/*
Returns a boolean indicating if the message view should be dismissed for the given pan offset (ie. if the user has panned far enough up or down)
*/
- (BOOL)shouldDismissMessageWithPanGestureOffset:(double)offset withVelocity:(double)velocity {
// For Centered notifications, only true if the user was swiping in the same direction as the dismissal
BOOL dismissDirection = (offset > 0 && velocity <= 0) || (offset < 0 && velocity >= 0);
switch (self.message.position) {
case OSInAppMessageDisplayPositionTop:
return (offset > self.messageView.bounds.size.height / 2.0f);
case OSInAppMessageDisplayPositionBottom:
return (fabs(offset) > self.messageView.bounds.size.height / 2.0f) && offset < 0;
case OSInAppMessageDisplayPositionFullScreen:
case OSInAppMessageDisplayPositionCenterModal:
return dismissDirection && ((fabs(offset) > self.messageView.bounds.size.height / 2.0f) || (fabs(offset) > 100));
}
}
/*
This delegate function gets called when in-app html is load or action button is tapped
*/
- (void)jsEventOccurredWithBody:(NSData *)body {
let event = [OSInAppMessageBridgeEvent instanceWithData:body];
NSString *eventMessage = [NSString stringWithFormat:@"Action Occured with Event: %@", event];
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:eventMessage];
NSString *eventTypeMessage = [NSString stringWithFormat:@"Action Occured with Event Type: %lu", (unsigned long)event.type];
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:eventTypeMessage];
if (event) {
switch (event.type) {
case OSInAppMessageBridgeEventTypePageRenderingComplete: {
// BOOL set to true since the JS event fired, meaning the WebView was populated properly with the IAM code
self.didPageRenderingComplete = true;
self.message.dragToDismissDisabled = event.renderingComplete.dragToDismissDisabled;
self.message.position = event.renderingComplete.displayLocation;
self.message.height = event.renderingComplete.height;
// The page is fully loaded and should now be displayed
// This is only fired once the javascript on the page sends the "rendering_complete" type event
dispatch_async(dispatch_get_main_queue(), ^{
[self.delegate webViewContentFinishedLoading:self.message];
[OneSignalCoreHelper performSelector:@selector(displayMessage) onMainThreadOnObject:self withObject:nil afterDelay:0.0f];
});
break;
}
case OSInAppMessageBridgeEventTypePageResize: {
// resize event for IAM during actions like orientation changes and displaying an IAM
// Currently used for fullscreen IAMs to account for safe area changes
// self.message.height = event.resize.height;
if (self.isFullscreen) {
[self.messageView updateSafeAreaInsets];
}
break;
}
case OSInAppMessageBridgeEventTypeActionTaken: {
if (event.userAction.clickType)
[self.delegate messageViewDidSelectAction:self.message withAction:event.userAction];
if (event.userAction.urlTarget == OSInAppMessageActionUrlTypeReplaceContent)
[self.messageView loadReplacementURL:[NSURL URLWithString:event.userAction.url]];
if (event.userAction.closingMessage)
[self dismissCurrentInAppMessage];
break;
}
case OSInAppMessageBridgeEventTypePageChange: {
[self.delegate messageViewDidDisplayPage:self.message withPageId: event.pageChange.page.pageId];
break;
}
default:
break;
}
}
}
/*
Unity overrides orientation behavior and enables all orientations in supportedInterfaceOrientations, regardless of
the values set in the info.plist. It then uses its own internal logic for restricting the Application's views to
the selected orientations. This view controller inherits the behavior of all orientations being allowed so we need
to manually set the supported orientations based on the values in the plist.
If no values are selected for the orientation key in the plist then we will default to super's behavior.
*/
- (UIInterfaceOrientationMask)supportedInterfaceOrientations {
NSUInteger orientationMask = 0;
NSArray *supportedOrientations = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"UISupportedInterfaceOrientations"];
if (!supportedOrientations) {
return [super supportedInterfaceOrientations];
}
if ([supportedOrientations containsObject:@"UIInterfaceOrientationLandscapeLeft"]) {
orientationMask += UIInterfaceOrientationMaskLandscapeLeft;
}
if ([supportedOrientations containsObject:@"UIInterfaceOrientationLandscapeRight"]) {
orientationMask += UIInterfaceOrientationMaskLandscapeRight;
}
if ([supportedOrientations containsObject:@"UIInterfaceOrientationPortrait"]) {
orientationMask += UIInterfaceOrientationMaskPortrait;
}
if ([supportedOrientations containsObject:@"UIInterfaceOrientationPortraitUpsideDown"]) {
orientationMask += UIInterfaceOrientationMaskPortraitUpsideDown;
}
return orientationMask;
}
/*
Override method for handling orientation change within a view controller on iOS 8 or higher
This specifically handles the resizing and reanimation of a currently showing IAM
*/
- (void)viewWillTransitionToSize:(CGSize)size withTransitionCoordinator:(id <UIViewControllerTransitionCoordinator>)coordinator {
[super viewWillTransitionToSize:size withTransitionCoordinator:coordinator];
/*
Code here will execute before the orientation change begins
*/
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Screen Orientation Change Detected"];
UIApplicationState appState = UIApplication.sharedApplication.applicationState;
// Get current orientation of the device
UIDeviceOrientation currentDeviceOrientation = UIDevice.currentDevice.orientation;
ViewOrientation currentOrientation = [OneSignalCoreHelper validateOrientation:currentDeviceOrientation];
// Ignore changes in device orientation if or coming from same orientation or orientation is invalid
if (currentOrientation == OrientationInvalid &&
(appState == UIApplicationStateInactive || appState == UIApplicationStateBackground)) {
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Orientation Change Ended: Orientation same as previous or invalid orientation"];
self.previousOrientation = currentOrientation;
return;
}
self.previousOrientation = currentOrientation;
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Orientation Change Started: Hiding IAM"];
// Deactivate the pan constraint while changing the screen orientation
self.panVerticalConstraint.active = false;
// Hide the IAM and prepare animation based on display location
self.messageView.hidden = true;
[coordinator animateAlongsideTransition:^(id<UIViewControllerTransitionCoordinatorContext> context) {
/*
Code here will execute during the rotation
*/
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Orientation Change Occurring: Removing all previous IAM constraints"];
// Remove all of the constraints connected to the messageView
[self.messageView removeConstraints:[self.messageView constraints]];
} completion:^(id<UIViewControllerTransitionCoordinatorContext> context) {
/*
Code here will execute after the rotation has finished
*/
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Orientation Change Complete: Getting new height from JS getPageMetaData()"];
// Evaluate the JS getPageMetaData() to obtain the new height for the webView and use it within the completion callback to set the new height
[self.messageView resetWebViewToMaxBoundsAndResizeHeight:^(NSNumber *newHeight) {
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Orientation Change Complete with New Height: Adding constraints again and showing IAM"];
// Assign new height to message
self.message.height = newHeight;
// Add all of the constraints using the new message height obtained from JS code
[self addConstraintsForMessage];
// Reanimate and show IAM
[self animateAppearance:NO];
}];
}];
}
#pragma mark OSInAppMessageViewDelegate Methods
- (void)messageViewFailedToLoadMessageContent {
[self.delegate messageViewControllerWasDismissed:self.message displayed:NO];
}
- (void)messageViewDidFailToProcessAction {
[self dismissCurrentInAppMessage];
}
- (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message {
[OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"Received in-app script message: %@", message.body]];
[self jsEventOccurredWithBody:[message.body dataUsingEncoding:NSUTF8StringEncoding]];
}
@end