UniWebView

Safe Browsing Mode

In this guide, we cover both of the prefab and code use of the Safe Browsing Mode.

In the Safe Browsing Mode, the web content will be displayed full-screen with a default UI on either iOS and Android:

Safe Browsing Mode is a simpler and out-of-the-box solution to show the web page as it is in the browser. For more detail about the difference between the general-purpose web view and the Safe Browsing Mode, refer to this guide.

Checking Availability

Before creating and showing a page, please ensure that the Safe Browsing Mode is available on the device. To do so, call IsSafeBrowsingSupported and check its result:

if (UniWebViewSafeBrowsing.IsSafeBrowsingSupported) {
    // Safe Browsing Mode is available on current device.
}

Target API Level higher than Android 11

If you set your Target API Level to Android 11 (30) or later, you need to add the correct intent query explicitly in your AndroidManifest.xml file, to follow the Package Visibilityopen in new window to add queries as a sub-node of the manifest tag:

<manifest>
  // ...

  </application>

  <queries>
    <intent>
      <action android:name="android.support.customtabs.action.CustomTabsService" />
    </intent>
  </queries>
</manifest>





 
 
 
 
 

Package Visibility from Android 11

If you are setting Target API Level higher than Android 11 (API Level 30), but not setting the queries in your AndroidManifest.xml, the UniWebViewSafeBrowsing related APIs will not work expectedly.

About IsSafeBrowsingSupported

This property always returns true on iOS runtime platform. On Android, it depends on whether there is an Intent can handle the safe browsing request. Usually this ability is provided by Chrome, but there are also other browser apps might implement that. If there is no Intent can open the URL in safe browsing mode, or the handling app is set to disabled in Android system settings, this property returns false.

You can only use the Safe Browsing Mode when the property is true. Otherwise, please let your user know how to enable it by re-installing Chrome and enable it in the system settings.

Prefab

Remember to remove the previous UniWebView.prefab first if you just followed the Web View - Prefab guide. Both prefabs try to show the web page up in the Start method, so you may get into a conflict.

The steps of using the safe browsing prefab are almost the same as above: drag the UniWebViewSafeBrowsing.prefab under UniWebView/Prefab folder to your scene, configure it, and play the scene. UniWebViewSafeBrowsing prefab only provides one property:

Set it to https://uniwebview.com, and build the scene to a device. The web page with a default title and toolbar UI will be displayed:

Code

Create & Show

You can also create a safe browsing view by code:

// Create a UniWebViewSafeBrowsing instance with a URL.
var safeBrowsing = UniWebViewSafeBrowsing.Create("https://docs.uniwebview.com");

// Show it on screen.
safeBrowsing.Show();

HTTP & HTTPS

Only web content hosted by HTTP or HTTPS is supported in Safe Browsing Mode. Attempts to load a local file URL in Safe Browsing Mode causes a runtime error.

Safe Browsing Memory

Once created, the Safe Browsing component in native side will be there and taking memory until dismissed. In other words, you need to at least call Show once you create a Safe Browsing. Otherwise, its memory is leaked.

Customization & Events

Color

You can customize the color of title/tool bar background:

var color = new Color(0.263f, 0.627f, 0.278f);

// Background color.
safeBrowsing.SetToolbarColor(color);

// Controls color. Only for iOS.
safeBrowsing.SetToolbarItemColor(Color.white);

The code above will give you a colorful toolbar:

Controls color on Android

Although in the screenshot above, the controls are rendered with white and it seems that SetToolbarItemColor also applies to Android, that method actually only works for iOS.

On Android, the system will automatically pick from white or black, based on the background color you set by SetToolbarColor, to make sure the text is clearly visible. Check the color palettes in the Material design color guideopen in new window to get detail on which color will be used.

Finish Event

UniWebViewSafeBrowsing delivers an OnSafeBrowsingFinished event when the browsing is done and web page is dismissed by user. It is a good time to restore your game session or reset any reference you are using to the UniWebViewSafeBrowsing object.

safeBrowsing.OnSafeBrowsingFinished += (browsing) => {
    Debug.Log("UniWebViewSafeBrowsing is closed.");
};

Safe Browsing Mode in Editor

On macOS Editor, due to the corresponding native class is not available, there is no such "Safe Browsing Mode". When you create and show a UniWebViewSafeBrowsing, UniWebView falls back to Application.OpenURL. That means:

  • Your URL will be opened in an external browser on system, such as Safari or Chrome.
  • The customization methods and the events do not work. Any logic you write in OnSafeBrowsingFinished will never be called in Editor.