Interface EnvironmentAlias

Hierarchy

Properties

environment sys

Methods

delete toPlainObject update

Properties

environment

environment: {
    sys: MetaLinkProps;
}

Type declaration

sys

sys: BasicMetaSysProps & {
    space: SysLink;
}

System meta data

Methods

delete

  • Deletes this object on the server.

    Memberof

    EnvironmentAlias

    Func

    delete

    Returns

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

    const contentful = require('contentful-management')

    const client = contentful.createClient({
      accessToken: '<content_management_api_key>'
    })

    client.getSpace('<space_id>')
    .then((space) => space.getEnvironmentAlias('<environment_alias_id>'))
    .then((alias) => {
      return alias.delete()
    })
    .then(() => console.log(`Alias deleted.`))
    .catch(console.error)

    Returns Promise<void>

toPlainObject

update

  • Sends an update to the server with any changes made to the object's properties. Currently, you can only change the id of the alias's underlying environment. See the example below.

    Memberof

    EnvironmentAlias

    Func

    update

    Returns

    Object returned from the server with updated changes.

    const contentful = require('contentful-management')

    const client = contentful.createClient({
      accessToken: '<content_management_api_key>'
    })

    client.getSpace('<space_id>')
    .then((space) => space.getEnvironmentAlias('<environment_alias_id>'))
    .then((alias) => {
      alias.environment.sys.id = '<environment_id>'
      return alias.update()
    })
    .then((alias) => console.log(`alias ${alias.sys.id} updated.`))
    .catch(console.error)

    Returns Promise<EnvironmentAlias>

Settings

Member Visibility

Theme