Super App object

The Super App object is a core element in a Super App application.

It consists of three main parts: Super App Source (API), Properties, and Events.

Super App Source

Here is where you define the Super App API (Application Programming Interface) for a set of functions that you want to make accessible to the Mini Apps. You can create a mapping for each service you want to expose, connecting its external name (used as a service) to the internal implementation within the Knowledge Base. The notation used here is similar to that of the API Object.

The internal objects that the API calls can include Panels, Procedures, and Data Providers.

Properties

The Properties enable you to:

• Identify the Super App in the Mini App Center.
• Define the associated Main Object (Panel or Menu) for that Super App. This ensures that appropriate information is generated during the Main object's generation process to execute the application as a Super App.
• At runtime, they provide information to retrieve the list of its Mini Apps from the Mini App Center and verify the signature when loading a Mini App.

These are the properties that can be set at object level:

• Super App Identifier
• Super App Version
• Provisioning Url
• Android Public Key File
• iOS Public Key File
• Main Object
• Mini Apps Cache
  • Maximum Mini apps count
  • Number of days to keep

Events

For each API function, you can define a 'Before' and 'After' user event, which will be executed before and after each function execution in the Super App.
In addition, for each API function, you can define '<function name>.Before|After' events. So, every time a function is invoked from the Mini App, the following will be executed:

• Event 'Before'
• Event '<function>.Before'
• The object corresponding to the implementation of the function, referenced in the 'Super App Source'
• Event '<function>.After'
• Event 'After'

Sample

Consider the Verdant Bank Super App Sample that emulates a wallet. Mini Apps are activated from within this Super App to facilitate the purchase of various products or services. During the payment process, each Mini App invokes the Super App through the defined API to complete the payment within the Super App, where the user has registered various payment methods.

In the Super App Knowledge Base, there is a Panel named PaymentPanel that presents the user's different payment options. Once a payment option is selected, the corresponding payment is executed.

To expose this Panel via API for invocation from Mini Apps, add the following code to the Super App Source:

Payment {
     NewPayment(in:&ExternalReference, in:&Amount, out:&Success, out:&PaymentId)
               => PaymentPanel(&ExternalReference, &Amount, &Success, &PaymentId);
}

Additionally, if you wish to call a Procedure (e.g., "GetUserInfoProc") that retrieves user information, you can include it in the Super App Source:

Payment {
     GetUserInformation(in:&UserName, out:&UserAddress, out:&UserPhone)
               => GetUserInfoProc(&UserName, &UserAddress, &UserPhone);
}

Alternatively, you can implement this as a Data Provider (e.g., "GetUserInfoDP") that returns an SDT with user information:

Payment {
     GetUserInformationDP(in:&UserName, out:&UserInfoSDT)
               => GetUserInfoDP(&UserName, &UserInfoSDT);
}

Also, you can use Super App Events, for instance, to obtain the Current Mini App ID before calling the SuperApp API.

Event GetPaymentMethods.Before
    &MiniAppId = GeneXusSuperApps.MiniApps.CurrentMiniAppId
EndEvent

In this case, you want to check the different payment methods available for each Mini App.

Payment {
     GetPaymentMethods(out:&PaymentMethodsSDT)
               => GetPaymentMethodsAvailablesForMiniApp(&MiniAppId, &PaymentMethodsSDT);
}

Considerations

• The Super App object must be placed within a module under the Root module, which is packaged and then installed in the KBs where Mini Apps are developed.
• Objects invoked from the API (Super App Source) should be added to the Additional References property in the Main Object associated with the Super App object (Temporary restriction. See SAC #53472).
• If an SDT is used as a parameter when exposing a Data Provider in the API, it must reside within the module.
• In the Mini App KB, API methods can only be invoked from user events (client-side).

Scope

Generators: Android, Apple