Hierarchy

Properties

description?: string
name: string
permissions: {
    ContentDelivery: string | string[];
    ContentModel: string[];
    EnvironmentAliases: string | string[];
    Environments: string | string[];
    Settings: string | string[];
    Tags: string | string[];
}

Permissions for application sections

Type declaration

  • ContentDelivery: string | string[]
  • ContentModel: string[]
  • EnvironmentAliases: string | string[]
  • Environments: string | string[]
  • Settings: string | string[]
  • Tags: string | string[]
policies: {
    actions: "all" | ActionType[];
    constraint: ConstraintType;
    effect: string;
}[]
sys: BasicMetaSysProps & {
    space: SysLink;
}

Methods

  • Deletes this object on the server.

    Memberof

    Role

    Func

    delete

    Returns

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

    Example

    const contentful = require('contentful-management')

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

    client.getSpace('<space_id>')
    .then((space) => space.getRole('<role_id>'))
    .then((role) => role.delete())
    .then((role) => console.log(`role deleted.`))
    .catch(console.error)

    Returns Promise<void>

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

    Returns

    Object returned from the server with updated changes.

    Example

    const contentful = require('contentful-management')

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

    client.getSpace('<space_id>')
    .then((space) => space.getRole('<roles_id>'))
    .then((roles) => {
    roles.name = 'New role name'
    return roles.update()
    })
    .then((roles) => console.log(`roles ${roles.sys.id} updated.`))
    .catch(console.error)

    Returns Promise<Role>