Lifecycle

Every AMI Component has a list of events you can listen to.

onReady

When an AMI component is ready to be used, you can use the onReady function.

For example, if you’d like to show a toast when your subapp or control is loaded :

$AMIClass("CommandApp", {
    $extends: ami.SubApp,

    $init: function () {
        this.$super.$init();
    },

    onReady: function () {
        amiWebApp.success("I'm ready!", true);
    },
});

Note that the onReady event can also take a parameter which represents the userdata of the current user.

onRefresh

This event is called when the toolbar needs to be updated.

This function takes as a parameter a Boolean that indicates whether the user is logged or not.

$AMIClass("CommandApp", {
    $extends: ami.SubApp,

    $init: function () {
        this.$super.$init();
    },

    onRemove: function (isAuth) {
        amiWebApp.success(
            isAuth ? "User is authenticated" : "User is not authenticated",
            true
        );
    },
});

onRemove

When an AMI Control is removed, an event is fired, and you can listen to it by implementing an onRemove

$AMIClass("CommandApp", {
    $extends: ami.SubApp,

    $init: function () {
        this.$super.$init();
    },

    onRemove: function () {
        amiWebApp.success("Bye!", true);
    },
});

onLogin

The code contained inside the onLogin event will only be executed when the user is logged in. This allows you to secure parts of your application.

onLogout

The onLogout event allows you to execute run code that should only be executed when the user is not logged in.

$AMIClass("CommandApp", {
    $extends: ami.SubApp,

    $init: function () {
        this.$super.$init();
    },

    onLogout: function () {
        amiWebApp.success("I'm a guest user!", true);
    },
});