Package-level declarations
Types
This class is used to load the server URL and Capacitor configuration from the assets folder when the app is being run in developer mode with the Portals CLI.
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.
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.
A class used to create and manage Portal instances. It follows a Singleton Pattern to allow access to any ./portal from anywhere in the application.
An Annotation class used to create message receiver functions with the PortalsPlugin. A function annotated with this class can be triggered by using the Portals.sendMessage() with the message parameter on the web code matching the function name in the native code.
A special Capacitor Plugin within the Portals library that allows for bi-directional communication between Android and web code. It is loaded with every Portal automatically and does not need to be added like other plugins if the default behavior is desired.
A class used by PortalFragment to provide instructions to the Capacitor router to load shared assets.
A class that provides the ability to integrate Portals into XML Layout or Jetpack Compose files. PortalView extends FrameLayout and contains a PortalFragment to display the Portal content inside the view. Use this class like any other View class.
Portal View Model
A class used for messages passed to subscriptions.
A class providing Web Vitals functionality. When Web Vitals metrics are desired, this class adds JavaScript to the Portals web view to support measuring the performance of the web application.