IExtensionInitializationOptions

Last Update: 9/26/2016

Defined in vss.d.ts

Options for the extension's initialization method

Members

  • explicitNotifyLoaded: boolean. Optional. Set to true if the extension will explicitly call notifyLoadSucceeded or notifyLoadFailed itself to indicate that the extension is done loading (stops UI loading indicator in the host). If false (the default) the extension is considered ready as soon as init is called.

  • usePlatformScripts: boolean. Optional. Set to true if the extension is going to consume any VSS script libraries. For example, controls, REST clients, services, etc. This pulls in the script loader and configuration data from the host frame so that 'require' statements can be used to load VSTS modules. A call to VSS.require will effectively turn this option on, even if not specified in the VSS.init handshake.

  • usePlatformStyles: boolean. Optional. Set to true if the extension desires to use VSS platform CSS styles. If not explicitly set, the default value is the value of 'usePlatformScripts'.

  • moduleLoaderConfig: ModuleLoaderConfiguration. Optional. Extension-specific AMD module loader configuration. This configuration will be merged with the VSTS-specific configuration.

  • extensionReusedCallback: (contribution: Contribution): void. Optional. Optional callback method that gets invoked when this extension frame is reused by another contribution which shares the same URI of the contribution that originally caused this extension frame to be loaded.