IonicPortals/io.ionic.portals/PortalBuilder

PortalBuilder

A class used to create Portal instances. It follows a Builder Pattern and can be used in situations where you want to programmatically create a Portal at runtime instead of using one directly in an XML layout.

Example usage (kotlin):

val portal: Portal = PortalBuilder("myPortal")
    .addPlugin(MyCapacitorPlugin::class.java)
    .setPortalFragmentType(MyFadeInOutPortalFragment::class.java)
    .setInitialContext(mapOf("myVariableFromAndroid" to 42))
    .setStartDir("web_app")
    .create()

Example usage (java):

Portal portal = new PortalBuilder("myPortal")
    .addPlugin(MyCapacitorPlugin.class)
    .setPortalFragmentType(MyFadeInOutPortalFragment.class)
    .setInitialContext(Map.of("myVariableFromAndroid", 42))
    .setStartDir("web_app")
    .create();

Constructors

PortalBuilder

fun PortalBuilder(name: String)

Functions

addAssetMap

fun addAssetMap(assetMap: AssetMap): PortalBuilder

Add an Asset Map to the Portal used with shared assets.

addPlugin

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

Add a plugin to be loaded with the Portal.

addPluginInstance

fun addPluginInstance(plugin: Plugin): PortalBuilder

Add a plugin instance to be loaded with the Portal.

create

fun create(): Portal

Creates the Portal instance from the current state of the PortalBuilder provided. This finishes building the Portal.

setAssetMaps

fun setAssetMaps(assetMaps: LinkedHashMap<String, AssetMap>): PortalBuilder

Set a list of AssetMap to the Portal used with shared assets.

setDevMode

fun setDevMode(devMode: Boolean): PortalBuilder

Set development mode on the Portal which will look for a server URL set by the Portals CLI. This is set to true by default but can be turned off manually if desired.

setInitialContext

fun setInitialContext(initialContext: Any): PortalBuilder

Sets the initial context to pass to the web view. You can pass in either a Map or a String that will be parsed into a JSON object.

setLiveUpdateConfig

@JvmOverloads

fun setLiveUpdateConfig(context: Context, liveUpdateConfig: LiveUpdate, updateOnAppLoad: Boolean = true): PortalBuilder

Set the LiveUpdate config if using the Live Updates SDK with Portals.

setPlugins

fun setPlugins(plugins: MutableList<Class<out Plugin?>>): PortalBuilder

Set a list of Capacitor Plugin to be loaded with the Portal.

setPortalFragmentType

fun setPortalFragmentType(portalFragmentType: Class<out PortalFragment?>): PortalBuilder

Set the PortalFragment class used with displaying the Portal when added to an XML layout.

setStartDir

fun setStartDir(startDir: String): PortalBuilder

Set the directory of the Portal. This directory is the on device directory of where your web application is located.

Properties

name

val name: String

the name of the Portal