IPrefabAppManifest interface

Package:

@microsoft/sp-module-interfaces

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

This is the manifest for a PREFAB application.

Extends

IClientSideComponentManifest

Properties

actions	Site Script actions.
appInstallationTypes	Describes how the PREFAB app can be installed: NewSite or ExistingSite. If omitted the app supports both.
description	Description of the application represented as a dictionary of locale keys to description values. This value will be displayed to the user in the (page creation) interface.
isConfigured	Specifies if there is a FCR (Finish Run Configuration) available for the app. True if no FCE is available.
siteSettingsLinks	Links to be rendered in the suite nav site settings menu for the PREFAB App.
title	Title of the application as a dictionary of locale keys to title values. This value will be displayed to the user in the (page creation) interface.
toolboxEntries	Toolbox entries for the PREFAB app.

Property Details

actions

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Site Script actions.

actions?: Record<string, PrefabAppSiteScript>;

Property Value

Record<string, PrefabAppSiteScript>

Remarks

• See https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json for a list of actions. - The onInstall actions will be run when the app is installed on a site. - The onDemand actions will not run automatically, but can be referenced by an App developer.

appInstallationTypes

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Describes how the PREFAB app can be installed: NewSite or ExistingSite. If omitted the app supports both.

appInstallationTypes?: Array<'NewSite' | 'ExistingSite'>;

Property Value

Array<'NewSite' | 'ExistingSite'>

description

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Description of the application represented as a dictionary of locale keys to description values. This value will be displayed to the user in the (page creation) interface.

description: ILocalizedString;

Property Value

ILocalizedString

Remarks

Supported values: a dictionary of locale keys to strings. Should always have a 'default' key.

Examples:

"An application for searching for things."

or

         {
           "default": "An application for searching for things.",
           "en-us": "An application for searching for things.",
           "fr-fr": "Une demande pour la recherche de choses.",
           "zh": "申請尋找的東西。"
         }

isConfigured

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies if there is a FCR (Finish Run Configuration) available for the app. True if no FCE is available.

isConfigured: boolean;

Property Value

boolean

siteSettingsLinks

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Links to be rendered in the suite nav site settings menu for the PREFAB App.

siteSettingsLinks?: IPrefabAppSiteSettingsLink[];

Property Value

IPrefabAppSiteSettingsLink[]

title

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Title of the application as a dictionary of locale keys to title values. This value will be displayed to the user in the (page creation) interface.

title: ILocalizedString;

Property Value

ILocalizedString

Remarks

Supported values: a dictionary of locale keys to strings. Should always have a 'default' key.

Example: "My Application"

         {
           "default": "My Application"
           "en-us": "My Application",
           "fr-fr": "Ma demande",
           "zh": "我的應用程式"
         }

toolboxEntries

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Toolbox entries for the PREFAB app.

toolboxEntries?: IPrefabAppToolboxEntry[];

Property Value

IPrefabAppToolboxEntry[]