IonicPortals/io.ionic.portals/Portal

Portal

class Portal(val name: String)

A class representing a Portal that contains information about the web content to load and any associated plugins used by the Portal. It is discouraged to use this class directly to create a Portal and instead use PortalBuilder or PortalManager to construct a new instance.

Example usage (kotlin):

val name: String = "Hello World"
val portal: Portal = Portal(name)

Example usage (java):

String name = "Hello World";
Portal portal = new Portal(name);

Constructors

Portal

constructor(name: String)

Types

LiveUpdateProvider

sealed class LiveUpdateProvider

The live update provider for a Portal.

Properties

devMode

var devMode: Boolean

If the Portal should be loaded in development mode and look for a server URL.

initialContext

var initialContext: Any?

The initial context to pass to the web view.

liveUpdateOnAppLoad

var liveUpdateOnAppLoad: Boolean

Whether to run a live update sync when the portal is added to the manager.

liveUpdateProvider

var liveUpdateProvider: Portal.LiveUpdateProvider?

The live update source responsible for locating and syncing the latest web application assets.

name

val name: String

the name of the Portal

portalFragmentType

var portalFragmentType: Class<out PortalFragment?>

The PortalFragment type used by a PortalView when using Portals directly in Android layouts/XML.

startDir

var startDir: String

The start directory of the portal web app. Portals will use the name of the Portal by default if this value is not set.

Functions

addAssetMaps

fun addAssetMaps(assetMaps: <Error class: unknown class><String, AssetMap>)

Add multiple AssetMap instances to be loaded with this Portal.

addPlugin

fun addPlugin(plugin: Class<out Plugin?>)

Add a Capacitor Plugin to be loaded with this Portal.

addPluginInstance

fun addPluginInstance(plugin: Plugin)

Add a Capacitor Plugin instance to be loaded with this Portal.

addPluginInstances

fun addPluginInstances(plugins: List<Plugin>)

Add multiple Capacitor Plugin instances to be loaded with this Portal.

addPlugins

fun addPlugins(plugins: List<Class<out Plugin?>>)

Add multiple Capacitor Plugin to be loaded with this Portal.

latestAppDirectory

fun latestAppDirectory(context: Context): File?

The directory of the latest synced web application assets for this portal. Returns null when no live update source is configured or no sync has completed.

setInitialContext

fun setInitialContext(initialContext: String)

fun setInitialContext(initialContext: Map<String, Any>)

Sets the initial context to pass to the web view.

syncProvider

@JvmOverloads

fun syncProvider(callback: LiveUpdateProviderSyncCallback? = null)

Sync the external live update provider configured for this Portal.