Interface AppInstallation

interface AppInstallation {
    parameters?: FreeFormParameters;
    sys: Omit<BasicMetaSysProps, "id"> & {
        appDefinition: SysLink;
        environment: SysLink;
        organization: SysLink;
        space: SysLink;
    };
    delete(): Promise<void>;
    toPlainObject(): AppInstallationProps;
    update(): Promise<AppInstallation>;
}

Hierarchy (view full)

Properties

parameters? sys

Methods

delete toPlainObject update

Properties

Optionalparameters

parameters?: FreeFormParameters

Free-form installation parameters (API limits stringified length to 32KB)

sys

sys: Omit<BasicMetaSysProps, "id"> & {
    appDefinition: SysLink;
    environment: SysLink;
    organization: SysLink;
    space: SysLink;
}

Methods

delete

  • delete(): Promise<void>

  • Deletes this object on the server.

    Returns Promise<void>

    Promise for the deletion. It contains no data, but the Promise error case should be handled.

    Example: ```javascript 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.delete()) .then(() => console.log(`App installation deleted.`)) .catch(console.error) ```

toPlainObject

update

  • update(): Promise<AppInstallation>

  • Sends an update to the server with any changes made to the object's properties

    Returns Promise<AppInstallation>

    Object returned from the server with updated changes.

    Example: ```javascript 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) ```

Settings

Member Visibility

On This Page

Properties
Methods