feat(ios): Support custom scheme event for iOS by kumo01GitHub · Pull Request #1112 · apache/cordova-plugin-inappbrowser

kumo01GitHub · 2026-02-08T19:14:11Z

Platforms affected

iOS

Motivation and Context

Implements CB-14187, which adds support for the AllowedSchemes preference and customscheme event for iOS. #274 is same context and I referred but the PR is not updated for years.

Description

Add support for the AllowedSchemes preference and customscheme event for iOS.

Testing

Tested with iOS simulator.

Checklist

I've run the tests to see all new and existing tests pass
I added automated test coverage as appropriate for this change
Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct keyword to close issues using keywords)
I've updated the documentation if necessary

GitToTheHub · 2026-02-08T21:33:49Z

This replicates #274 for the WKWebView

GitToTheHub · 2026-02-08T21:37:42Z

    return NO;
 }

+- (BOOL)isAllowedScheme:(NSString*)scheme


Please keep the code formatting, there should be a space between the type and pointer asterisk:

- (BOOL)isAllowedScheme:(NSString *)scheme

I fixed it following the other lines.

GitToTheHub · 2026-02-08T21:39:44Z


+- (BOOL)isAllowedScheme:(NSString*)scheme
+{
+    NSString* allowedSchemesPreference = [self.commandDelegate.settings objectForKey:@"AllowedSchemes"];


Keep the formatting:

NSString *allowedSchemesPreference

Use the _settings property to get a setting:

[_settings cordovaSettingForKey:@"AllowedSchemes"]

I fixed it following the other lines.

GitToTheHub · 2026-02-08T21:41:02Z

+        // Preference missing.
+        return NO;
+    }
+    for (NSString* allowedScheme in [allowedSchemesPreference componentsSeparatedByString:@","]) {


Keep the formatting:

NSString *allowedScheme

I fixed it following the other lines.

GitToTheHub · 2026-02-08T21:45:27Z

        [theWebView stopLoading];
        [self openInSystem:url];
+        shouldStart = NO;
+    } else if ((self.callbackId != nil) && ![[ url scheme] isEqualToString:@"http"] && ![[ url scheme] isEqualToString:@"https"] && [self isAllowedScheme:[url scheme]]) {


You don't need braces for (self.callbackId != nil) just write self.callbackId != nil

scheme is a property of url, write url.scheme instead of [ url scheme]

Add documentation to the condition, what's happening here

Add documentation to the condition, what's happening here

I added comment and clarify the condition.

GitToTheHub · 2026-02-08T21:46:32Z

+    } else if ((self.callbackId != nil) && ![[ url scheme] isEqualToString:@"http"] && ![[ url scheme] isEqualToString:@"https"] && [self isAllowedScheme:[url scheme]]) {
+        // Send a customscheme event.
+        CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK
+                                                      messageAsDictionary:@{@"type":@"customscheme", @"url":[url absoluteString]}];


absoluteString is a property of url, write url.absoluteString instead of [url absoluteString]

GitToTheHub · 2026-02-08T21:48:34Z

+        // Send a customscheme event.
+        CDVPluginResult* pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK
+                                                      messageAsDictionary:@{@"type":@"customscheme", @"url":[url absoluteString]}];
+        [pluginResult setKeepCallback:[NSNumber numberWithBool:YES]];


Write here pluginResult.keepCallback = [NSNumber numberWithBool:YES];

GitToTheHub · 2026-02-08T21:49:49Z

    return NO;
 }

+- (BOOL)isAllowedScheme:(NSString*)scheme


Document this method

kumo01GitHub · 2026-02-09T05:29:41Z

@GitToTheHub
Thank you for your review. The comments you pointed out primarily concern code formatting, and I determined that most of them should be corrected.
However, considering the overall structure, making these corrections would also change the formatting of other lines. Therefore, if proceeding with the corrections, consistency must be ensured across the entire codebase. And it is out of this PR's purpose.

I have a few suggestions.:

Only correct obvious errors and make another PR to fix the others.
Fix all of them only in InAppBrowser.m.

kumo01GitHub · 2026-02-09T14:42:07Z

Only correct obvious errors and make another PR to fix the others.

I think above choice is better so that I fixed following this policy for now.

GitToTheHub · 2026-02-09T15:42:53Z

Can you make up to date with the master?

kumo01GitHub · 2026-02-09T16:06:47Z

Can you make up to date with the master?

I updated my branch.

kumo01GitHub · 2026-02-10T02:53:14Z

@GitToTheHub
I got the build error reason. The _settings is a property of CDVWKInAppBrowserViewController but I defined isAllowedScheme as private method of CDVWKInAppBrowser. It's my trivial mistake...

I think the point is who should check scheme. I think CDVWKInAppBrowser should do as other schemes. So that I restored it.

GitToTheHub · 2026-02-10T11:38:23Z

You are right, _settings is a property of CDVWKInAppBrowserViewController and isAllowedScheme a method CDVWKInAppBrowser. Looks good now.

GitToTheHub reviewed Feb 8, 2026

View reviewed changes

kumo01GitHub force-pushed the feat/customurlscheme-ios branch from ac7b046 to da984b0 Compare February 9, 2026 15:55

kumo01GitHub added 4 commits February 10, 2026 01:03

feat(ios): custom scheme

0d81d36

doc: update readme

fe85886

fix(ios): fix code style

ae1a256

chore: Add comment

80b38ed

kumo01GitHub force-pushed the feat/customurlscheme-ios branch from da984b0 to 80b38ed Compare February 9, 2026 16:05

fix(ios): fix build error

56a079c

GitToTheHub merged commit 03831d7 into apache:master Feb 10, 2026

GitToTheHub mentioned this pull request Feb 10, 2026

CB-14187: (ios) Change the InAppBrowser to allow custom schemes #274

Closed

3 tasks

kumo01GitHub deleted the feat/customurlscheme-ios branch February 10, 2026 15:19

Uh oh!

Conversation

kumo01GitHub commented Feb 8, 2026

Platforms affected

Motivation and Context

Description

Testing

Checklist

Uh oh!

GitToTheHub commented Feb 8, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kumo01GitHub Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kumo01GitHub commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kumo01GitHub commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GitToTheHub commented Feb 9, 2026

Uh oh!

kumo01GitHub commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kumo01GitHub commented Feb 10, 2026

Uh oh!

GitToTheHub commented Feb 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kumo01GitHub Feb 9, 2026 •

edited

Loading

kumo01GitHub commented Feb 9, 2026 •

edited

Loading

kumo01GitHub commented Feb 9, 2026 •

edited

Loading

kumo01GitHub commented Feb 9, 2026 •

edited

Loading