Manifest
Get client manifest
Retrieve client manifest file.
Request
Example
Parameters
| Name | Description |
|---|---|
| app | Required Short application name (defined in ApplikationDel.ExternReferens) eg. external. |
| instance | Required Instance identifier, e.g. EAP-123456. Use 'default' for development or if multiple deployments of the same app-part will not be used. |
| theme | Required Browser theme. The only supported themes are "light" and "dark". |
Response
- The parameter descriptions below are copied from the MDN web docs guide for Web app manifests found here.
Example
{
"name": "MinKund01",
"short_name": false,
"start_url": "my.name@test.test",
"display": "my.name@test.test",
"background_color": "my.name@test.test",
"theme_color": "my.name@test.test",
"scope": "my.name@test.test",
icons:
{
"src": "http://localhost/Momentum.Pm.PortalApi.WebHost/files/595469",
"sizes": "537x489",
"type": "image/png",
"purpose": "any maskable"
}
}
Parameters
| Name | Description |
|---|---|
| name | The name member is a string that represents the name of the web application as it is usually displayed to the user (e.g., amongst a list of other applications, or as a label for an icon). name is directionality-capable, which means it can be displayed left-to-right or right-to-left based on the values of the dir and lang manifest members. |
| short_name | The short_name member is a string that represents the name of the web application displayed to the user if there is not enough space to display name (e.g., as a label for an icon on the phone home screen). short_name is directionality-capable, which means it can be displayed left-to-right or right-to-left based on the value of the dir and lang manifest members. |
| start_url | The start_url member is a string that represents the start URL of the web application — the prefered URL that should be loaded when the user launches the web application (e.g., when the user taps on the web application's icon from a device's application menu or homescreen). |
| display | The display member is a string that determines the developers’ preferred display mode for the website. The display mode changes how much of browser UI is shown to the user and can range from browser (when the full browser window is shown) to fullscreen (when the app is full-screened). |
| background_colour | Defines a placeholder background color for the application page to display before its stylesheet is loaded. |
| theme_colour | Defines a placeholder background color for the application page to display before its stylesheet is loaded. |
| scope | The scope member is a string that defines the navigation scope of this web application's application context. It restricts what web pages can be viewed while the manifest is applied. If the user navigates outside the scope, it reverts to a normal web page inside a browser tab or window. If the scope is a relative URL, the base URL will be the URL of the manifest. |
| icons | Specifies an array of objects representing image files that can serve as application icons for different contexts. |
.icons
| Name | Description |
|---|---|
| src | The path to the image file. If src is a relative URL, the base URL will be the URL of the manifest. |
| sizes | A string containing space-separated image dimensions |
| type | A hint as to the media type of the image. |
| purpose | Defines the purpose of the image, for example if the image is intended to serve some special purpose in the context of the host OS (i.e., for better integration). |
Get client manifest asset
Retrieve client manifest asset e.g. appicon or favicon.
Request
Example
Parameters
| Name | Description |
|---|---|
| app | Required Short application name (defined in ApplikationDel.ExternReferens) eg. external. |
| instance | Required Instance identifier, e.g. EAP-123456. Use 'default' for development or if multiple deployments of the same app-part will not be used. |
| theme | Required Browser theme. The only supported themes are "light" and "dark". |
| externalReference | Required External reference name given to the required icon e.g. appicon or favicon etc. |
| size | Required Pixel size of requested icon e.g. 512 or 192 etc. |
Response
-If the file exists on the server the file is returned as a byte array otherwise an error is returned informing the user that the file could not be found.