AMI Web Framework API > Interface > ISubApp
ami.ISubApp
The AMI sub-application interface
Methods
onReady(userdatanull) ->{$.Promise or $.Deferred or undefined}
Called when the sub-application is ready to run
Parameters:
| Name | Type | Description | Default | Optional | Nullable |
|---|---|---|---|---|---|
| userdata | * | the user data | ✓ |
Returns:
A JQuery promise object, deferred object or nothing
Type: $.Promise or $.Deferred or undefined
onExit(userdatanull) ->{$.Promise or $.Deferred or undefined}
Called when the sub-application is about to exit
Parameters:
| Name | Type | Description | Default | Optional | Nullable |
|---|---|---|---|---|---|
| userdata | * | the user data | ✓ |
Returns:
A JQuery promise object, deferred object or nothing
Type: $.Promise or $.Deferred or undefined
onLogin(userdatanull) ->{$.Promise or $.Deferred or undefined}
Called when logging in
Parameters:
| Name | Type | Description | Default | Optional | Nullable |
|---|---|---|---|---|---|
| userdata | * | the user data | ✓ |
Returns:
A JQuery promise object, deferred object or nothing
Type: $.Promise or $.Deferred or undefined
onLogout(userdatanull) ->{$.Promise or $.Deferred or undefined}
Called when logging out
Parameters:
| Name | Type | Description | Default | Optional | Nullable |
|---|---|---|---|---|---|
| userdata | * | the user data | ✓ |
Returns:
A JQuery promise object, deferred object or nothing
Type: $.Promise or $.Deferred or undefined
- Prev
- IContainer
- Next
- Control