Merged PR 2190: Added a internal handling of a *close* link

sp0x · sp0x · commit 702e0387c2b2 · 2020-09-15T08:23:48.000Z
The SDK now handles special **close** links in the layouts.
When a user clicks on `queueit://close` the webview would be closed.

A method named close was added to both the WebView controller and the QueueITEngine.
This method just dismisses the WebView screen.

Related work items: #6789
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 QueueITLib.xcworkspace/xcuserdata/queut-it.xcuserdatad/xcdebugger/**
+QueueITLib.xcworkspace/xcuserdata
diff --git a/QueueITLib.xcodeproj/project.pbxproj b/QueueITLib.xcodeproj/project.pbxproj
@@ -68,6 +68,7 @@
 		1DE12FBE1B57F3DD00DD3BBE /* IOSUtils.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = IOSUtils.m; sourceTree = "<group>"; };
 		1DE12FC01B57F42500DD3BBE /* QueueITEngine.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = QueueITEngine.h; sourceTree = "<group>"; };
 		1DE12FC11B57F42500DD3BBE /* QueueITEngine.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = QueueITEngine.m; sourceTree = "<group>"; };
+		90564B2E250A54AF009582C2 /* QueueConsts.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = QueueConsts.h; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -125,6 +126,7 @@
 				1DE12FB11B57F29A00DD3BBE /* Services */,
 				1DE12FC01B57F42500DD3BBE /* QueueITEngine.h */,
 				1DE12FC11B57F42500DD3BBE /* QueueITEngine.m */,
+				90564B2E250A54AF009582C2 /* QueueConsts.h */,
 			);
 			path = QueueITLib;
 			sourceTree = "<group>";
diff --git a/QueueITLib.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/QueueITLib.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
diff --git a/QueueITLib.xcworkspace/xcshareddata/QueueITLib.xccheckout b/QueueITLib.xcworkspace/xcshareddata/QueueITLib.xccheckout
diff --git a/QueueITLib.xcworkspace/xcuserdata/prasenkiyana.xcuserdatad/UserInterfaceState.xcuserstate b/QueueITLib.xcworkspace/xcuserdata/prasenkiyana.xcuserdatad/UserInterfaceState.xcuserstate
diff --git a/QueueITLib/QueueConsts.h b/QueueITLib/QueueConsts.h
@@ -0,0 +1,6 @@
+#ifndef QueueConsts_h
+#define QueueConsts_h
+
+#define QueueCloseUrl @"queueit://close"
+
+#endif
diff --git a/QueueITLib/QueueITEngine.h b/QueueITLib/QueueITEngine.h
@@ -1,18 +1,21 @@
 #import <UIKit/UIKit.h>
 #import "QueuePassedInfo.h"
+#import "QueueConsts.h"
 
 @protocol QueuePassedDelegate;
 @protocol QueueViewWillOpenDelegate;
 @protocol QueueDisabledDelegate;
 @protocol QueueITUnavailableDelegate;
 @protocol QueueUserExitedDelegate;
+@protocol QueueViewClosedDelegate;
 
 @interface QueueITEngine : NSObject
 @property (nonatomic)id<QueuePassedDelegate> queuePassedDelegate;
 @property (nonatomic)id<QueueViewWillOpenDelegate> queueViewWillOpenDelegate;
 @property (nonatomic)id<QueueDisabledDelegate> queueDisabledDelegate;
 @property (nonatomic)id<QueueITUnavailableDelegate> queueITUnavailableDelegate;
 @property (nonatomic)id<QueueUserExitedDelegate> queueUserExitedDelegate;
+@property (nonatomic)id<QueueViewClosedDelegate> queueViewClosedDelegate;
 @property (nonatomic, strong)NSString* errorMessage;
 
 typedef enum {
@@ -35,6 +38,8 @@ typedef enum {
 -(NSString*) errorTypeEnumToString:(QueueITRuntimeError)errorEnumVal;
 -(void)raiseUserExited;
 -(void)updateQueuePageUrl:(NSString*)queuePageUrl;
+-(void)raiseViewClosed;
+-(void)close: (void (^ __nullable)(void))onComplete;
 
 @end
 
@@ -57,3 +62,7 @@ typedef enum {
 @protocol QueueUserExitedDelegate <NSObject>
 -(void)notifyUserExited;
 @end
+
+@protocol QueueViewClosedDelegate <NSObject>
+-(void)notifyViewClosed;
+@end
diff --git a/QueueITLib/QueueITEngine.m b/QueueITLib/QueueITEngine.m
@@ -25,6 +25,7 @@ @implementation QueueITEngine
 
 static int MAX_RETRY_SEC = 10;
 static int INITIAL_WAIT_RETRY_SEC = 1;
+QueueITWKViewController *currentWebView;
 
 -(instancetype)initWithHost:(UIViewController *)host customerId:(NSString*)customerId eventOrAliasId:(NSString*)eventOrAliasId layoutName:(NSString*)layoutName language:(NSString*)language
 {
@@ -45,6 +46,16 @@ -(instancetype)initWithHost:(UIViewController *)host customerId:(NSString*)custo
     return self;
 }
 
+-(void)close: (void (^ __nullable)(void))onComplete
+{
+    NSLog(@"Closing webview");
+    if(currentWebView!=nil){
+        dispatch_async(dispatch_get_main_queue(), ^{
+            [currentWebView close: onComplete];
+        });
+    }
+}
+
 -(void)setViewDelay:(int)delayInterval {
     self.delayInterval = delayInterval;
 }
@@ -132,6 +143,8 @@ -(void)showQueue:(NSString*)queueUrl targetUrl:(NSString*)targetUrl
                                                                       eventTargetUrl:targetUrl
                                                                           customerId:self.customerId
                                                                              eventId:self.eventId];
+    currentWebView = queueWKVC;
+    
     if (@available(iOS 13.0, *)) {
         [queueWKVC setModalPresentationStyle: UIModalPresentationFullScreen];
     }
@@ -265,6 +278,11 @@ -(void) raiseQueueDisabled
     [self.queueDisabledDelegate notifyQueueDisabled];
 }
 
+-(void) raiseViewClosed
+{
+    [self.queueViewClosedDelegate notifyViewClosed];
+}
+
 -(void) raiseUserExited
 {
     if (self.isInQueue) {
diff --git a/QueueITLib/QueueITWKViewController.h b/QueueITLib/QueueITWKViewController.h
@@ -3,12 +3,16 @@
 
 @interface QueueITWKViewController : UIViewController
 
--(instancetype)initWithHost:(UIViewController *)host
-                queueEngine:(QueueITEngine*) engine
-                   queueUrl:(NSString*)queueUrl
-             eventTargetUrl:(NSString*)eventTargetUrl
-                 customerId:(NSString*)customerId
-                    eventId:(NSString*)eventId;
+-(instancetype _Nullable )initWithHost:(nonnull UIViewController *)host
+                queueEngine:(nonnull QueueITEngine*) engine
+                   queueUrl:(nonnull NSString*)queueUrl
+             eventTargetUrl:(nonnull NSString*)eventTargetUrl
+                 customerId:(nonnull NSString*)customerId
+                    eventId:(nonnull NSString*)eventId;
 
+- (void)close: (void (^ __nullable)(void))completion;
+
+- (BOOL)handleSpecialUrls:(nonnull NSURL*) url
+          decisionHandler:(nonnull void (^)(WKNavigationActionPolicy))decisionHandler;
 @end
 
diff --git a/QueueITLib/QueueITWKViewController.m b/QueueITLib/QueueITWKViewController.m
@@ -37,6 +37,27 @@ -(instancetype)initWithHost:(UIViewController *)host
     return self;
 }
 
+- (void)close: (void (^ __nullable)(void))onComplete {
+    [self.host dismissViewControllerAnimated:YES completion:^{
+        [UIApplication sharedApplication].networkActivityIndicatorVisible = NO;
+        if(onComplete!=nil){
+            onComplete();
+        }
+    }];
+}
+
+- (BOOL)handleSpecialUrls:(NSURL*) url
+    decisionHandler:(nonnull void (^)(WKNavigationActionPolicy))decisionHandler {
+    if([[url absoluteString] isEqualToString: QueueCloseUrl]){
+        [self close: ^{
+            [self.engine raiseViewClosed];
+        }];
+        decisionHandler(WKNavigationActionPolicyCancel);
+        return true;
+    }
+    return NO;
+}
+
 - (void)viewDidLoad {
     [super viewDidLoad];
     
@@ -78,6 +99,10 @@ - (void)webView:(WKWebView*)webView decidePolicyForNavigationAction:(nonnull WKN
             if(urlString != nil && ![urlString isEqualToString:@"about:blank"]) {
                 BOOL isQueueUrl = [self.queueUrl containsString:url.host];
                 BOOL isNotFrame = [[[request URL] absoluteString] isEqualToString:[[request mainDocumentURL] absoluteString]];
+
+                if([self handleSpecialUrls:url decisionHandler:decisionHandler]){
+                    return;
+                }
                 if (isNotFrame) {
                     if (isQueueUrl) {
                         [self.engine updateQueuePageUrl:urlString];
diff --git a/QueueITLibrary.podspec b/QueueITLibrary.podspec
@@ -1,12 +1,12 @@
 Pod::Spec.new do |s|
 s.name = "QueueITLibrary"
-s.version = "3.0.1"
+s.version = "3.0.3"
 s.summary = "Library for integrating Queue-it into an iOS app using web uI"
 s.homepage = "https://github.com/queueit/ios-webui-sdk"
 s.license = 'MIT'
 s.authors  = { 'Queue-It' => 'https://queue-it.com' }
 s.platform = :ios, '9.3'
-s.source   = { :git => 'https://github.com/queueit/ios-webui-sdk.git', :tag => '3.0.1' }
+s.source   = { :git => 'https://github.com/queueit/ios-webui-sdk.git', :tag => '3.0.3' }
 s.requires_arc = true
 s.source_files = "QueueITLib/*.{h,m}"
 end
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ Library for integrating Queue-It's virtual waiting room into an iOS app that is
 
 ## Installation
 
-Before starting please download the whitepaper **Mobile App Integration** from GO Queue-it Platform. 
+Before starting please download the whitepaper **Mobile App Integration** from GO Queue-it Platform.
 This whitepaper contains the needed information to perform a successful integration.
 
 ### Requirements
@@ -34,7 +34,7 @@ platform :ios, '9.3'
 use_frameworks!
 
 target '<Your Target Name>' do
-    pod 'QueueITLibrary', '~> 3.0.0'
+    pod 'QueueITLibrary', '~> 3.0.3'
 end
 ```
 
@@ -54,7 +54,7 @@ In this example we have a `UITableViewController` that we want to protect using
 #import <UIKit/UIKit.h>
 #import "QueueITEngine.h"
 
-@interface TopsTableViewController : UITableViewController<QueuePassedDelegate, QueueViewWillOpenDelegate, QueueDisabledDelegate, QueueITUnavailableDelegate>
+@interface TopsTableViewController : UITableViewController<QueuePassedDelegate, QueueViewWillOpenDelegate, QueueDisabledDelegate, QueueITUnavailableDelegate, QueueViewClosedDelegate>
 -(void)initAndRunQueueIt;
 @end
 ```
@@ -70,18 +70,20 @@ The implementation of the example controller looks like follows:
     NSString* eventOrAliasId = @"yourEventId"; // Required
     NSString* layoutName = @"yourLayoutName"; // Optional (pass nil if no layout specified)
     NSString* language = @"en-US"; // Optional (pass nil if no language specified)
-    
+
     self.engine = [[QueueITEngine alloc]initWithHost:self customerId:customerId eventOrAliasId:eventOrAliasId layoutName:layoutName language:language];
     [self.engine setViewDelay:5]; // Optional delay parameter you can specify (in case you want to inject some animation before Queue-It UIWebView or WKWebView will appear
     self.engine.queuePassedDelegate = self; // Invoked once the user is passed the queue
     self.engine.queueViewWillOpenDelegate = self; // Invoked to notify that Queue-It UIWebView or WKWebview will open
     self.engine.queueDisabledDelegate = self; // Invoked to notify that queue is disabled
     self.engine.queueITUnavailableDelegate = self; // Invoked in case QueueIT is unavailable (500 errors)
     self.engine.queueUserExitedDelegate = self; // Invoked when user chooses to leave the queue
+    self.engine.queueViewClosedDelegate = self; // Invoked after the WebView is closed
     
     NSError* error = nil;
     BOOL success = [self.engine run:&error];
-    if (!success) {            if ([error code] == NetworkUnavailable) {
+    if (!success) {
+        if ([error code] == NetworkUnavailable) {
             // Thrown when Queue-It detects no internet connectivity
             NSLog(@"%ld", (long)[error code]);
             NSLog(@"Network unavailable was caught in DetailsViewController");
@@ -97,40 +99,38 @@ The implementation of the example controller looks like follows:
 }
 
 // This callback will be triggered when the user has been through the queue.
-// Here you should store session information, so user will only be sent to queue again if the session has timed out. 
--(void) notifyYourTurn: (QueuePassedInfo*) queuePassedInfo { 
+// Here you should store session information, so user will only be sent to queue again if the session has timed out.
+-(void) notifyYourTurn: (QueuePassedInfo*) queuePassedInfo {
     NSLog(@"You have been through the queue");
     NSLog(@"QUEUE TOKEN: %@", queuePassedInfo.queueitToken);
 }
 
 // This callback will be triggered just before the webview (hosting the queue page) will be shown.
-// Here you can change some relevant UI elements. 
--(void) notifyQueueViewWillOpen { 
+// Here you can change some relevant UI elements.
+-(void) notifyQueueViewWillOpen {
     NSLog(@"Queue will open");
 }
 
 // This callback will be triggered when the queue used (event alias ID) is in the 'disabled' state.
-// Most likely the application should still function, but the queue's 'disabled' state can be changed at any time, 
+// Most likely the application should still function, but the queue's 'disabled' state can be changed at any time,
 // so session handling is important.
--(void) notifyQueueDisabled { 
+-(void) notifyQueueDisabled {
     NSLog(@"Queue is disabled");
 }
 
 // This callback will be triggered when the mobile application can't reach Queue-it's servers.
 // Most likely because the mobile device has no internet connection.
 // Here you decide if the application should function or not now that is has no queue-it protection.
--(void) notifyQueueITUnavailable: (NSString*) errorMessage { 
+-(void) notifyQueueITUnavailable: (NSString*) errorMessage {
     NSLog(@"QueueIT is currently unavailable");
 }
 
-// This callback will be triggered when user has been on the queue page via the webview
-// but decided to click the 'leave the queue' button/link.
-// Most likely you would want to clear any session and refresh so user will be joining the queue again.
-// We do recommend you to hide 'leave queue' on your queue page so this callback should not be handled in most cases.
--(void) notifyUserExited {
-    NSLog(@"User has left the queue");
+// This callback will be triggered after a user clicks a close link in the layout and the WebView closes.
+-(void)notifyViewClosed {
+    NSLog(@"The queue view was closed.")
 }
 ```
+
 As the App developer you must manage the state (whether user was previously queued up or not) inside the apps storage.
 After you have received the "notifyYourTurn callback", the app must remember this, possibly with a date / time expiration.
 When the user goes to the next page - you check this state, and only call QueueITEngine.run in the case where the user did not previously queue up.

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`QueueITLib.xcworkspace/xcuserdata/queut-it.xcuserdatad/xcdebugger/**`
	`2`	`+QueueITLib.xcworkspace/xcuserdata`