- Source:
UI Extension instances
Type Definitions
AppInstallation
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
sys |
Meta.Sys | System metadata |
parameters |
object | App Installation specific configuration variables |
toPlainObject() |
function | Returns this App Installation as a plain JS object |
Methods
(static) delete() → {Promise}
- Source:
Deletes this object on the server.
Example
const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getEnvironment('<environment_id>'))
.then((environment) => environment.delete())
.then(() => console.log(`App installation deleted.`))
.catch(console.error)Returns:
Promise for the deletion. It contains no data, but the Promise error case should be handled.
- Type
- Promise
(static) update() → {Promise.<AppInstallation>}
- Source:
Sends an update to the server with any changes made to the object's properties
Example
const contentful = require('contentful-management')
const client = contentful.createClient({
accessToken: '<content_management_api_key>'
})
client.getSpace('<space_id>')
.then((space) => space.getEnvironment('<environment_id>'))
.then((environment) => environment.getAppInstallation('<app_definition_id>'))
.then((appInstallation) => {
appInstallation.parameters.someParameter = 'New Value'
return appInstallation.update()
})
.then((appInstallation) => console.log(`App installation ${appInstallation.sys.id} was updated`))
.catch(console.error)Returns:
Object returned from the server with updated changes.
- Type
- Promise.<AppInstallation>