core/plugins/plugins.service.ts
Methods |
|
constructor(applicationService: ApplicationService, appStateService: AppStateService)
|
|||||||||
Parameters :
|
Async addRemotes | ||||||||||||
addRemotes(application: IApplication, plugins: ApplicationPlugin | ApplicationPlugin[])
|
||||||||||||
Updates the remotes field in the application configuration by adding new plugins. Important: if the remotes object is not set on the configuration object, remotes will not be added. Make sure that this object exists in the application configuration.
Parameters :
Returns :
Promise<ApplicationRemotePlugins>
Returns updated application remotes. |
Async getAllMFExports |
getAllMFExports()
|
Extracts a list of exports from each available package.
Returns :
Promise<ApplicationPlugin[]>
Returns a list of all exported plugins. |
Async getCumulocityJsonFile | ||||||||
getCumulocityJsonFile(application: IApplication)
|
||||||||
Fetches the application manifest.
Parameters :
Returns :
unknown
Returns the application manifest. |
getMFExports | ||||||||
getMFExports(application: IApplication)
|
||||||||
Extracts a list of exported plugins from the application object.
Parameters :
Returns :
ApplicationPlugin[]
Returns a list of exported plugins. |
getMFRemotes | ||||||||
getMFRemotes(application: IApplication)
|
||||||||
Extracts a list of remotes from the application object.
Parameters :
Returns :
ApplicationRemotePlugins
Returns list of remotes. |
isPackage | ||||||||
isPackage(application: IApplication)
|
||||||||
Checks if an application is a package.
Parameters :
Returns :
boolean
Returns true if the application is a package. |
Async listPackages | ||||||||||
listPackages(params: any)
|
||||||||||
Fetches a list of available packages.
Parameters :
Returns :
Promise<IApplication[]>
Returns a list of packages. |
Async removeRemotes | ||||||||||||
removeRemotes(application: IApplication, plugins: ApplicationPlugin | ApplicationPlugin[])
|
||||||||||||
Updates the remotes field in the application configuration by removing plugins.
Parameters :
Returns :
Promise<ApplicationRemotePlugins>
Returns updated application remotes. |
Async setInitialRemotes | ||||||||
setInitialRemotes(application: IApplication)
|
||||||||
Sets the initial state of remotes in the configuration (when it's missing), based on the list of remotes being in the application manifest.
Parameters :
Returns :
unknown
Returns a list of remotes that has been assigned to the configuration object. |
sortVersions | |||||||||
sortVersions(source: string[], order: "asc" | "desc")
|
|||||||||
Parameters :
Returns :
string[]
|
sortVersions | |||||||||
sortVersions(source: any, order: "asc" | "desc")
|
|||||||||
Parameters :
Returns :
any
|
Async updateRemotesInAppConfig | ||||||||||||
updateRemotesInAppConfig(application: IApplication, plugins: ApplicationRemotePlugins)
|
||||||||||||
Updates the remotes field in the application configuration.
Parameters :
Returns :
Promise<ApplicationRemotePlugins>
Returns updated application remotes. |