IonicPortals/io.ionic.portals/PortalMethod

PortalMethod

annotation class PortalMethod(val topic: String = "")

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.

Example usage:

class MyPortalFragment : PortalFragment() {
    // ...
    public fun onCreate(savedInstanceState: Bundle?): Unit {
        super.onCreate(savedInstanceState)
        // ...
        this.linkMessageReceivers(this)
    }

    @PortalMethod
    public fun nativeFunction(payload: String): Unit {
        // run native code here
    }
}

class MyPortalFragment extends PortalFragment {
    // ...
    public void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        // ...
        this.linkMessageReceivers(this);
    }

    @PortalMethod
    public void nativeFunction(String payload) {
        // run native code here
    }
}

import { Portals } from "@native-portal/portals";

Portals.sendMessage({ message: "nativeFunction", payload: result });

Properties

topic

val topic: String