Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SpaceMembership

Hierarchy

Index

Properties

Methods

Properties

admin

admin: boolean

User is an admin

name

name: string

roles

roles: { sys: MetaLinkProps }[]

sys

sys: MetaSysProps & { space: { sys: MetaLinkProps } }

Methods

delete

  • delete(): Promise<void>

  • 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.getSpaceMembership('<spaceMembership_id>'))
.then((spaceMembership) => spaceMembership.delete())
.then(() => console.log(`spaceMembership deleted.`))
.catch(console.error)

    Returns Promise<void>

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

toPlainObject

update

  • 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.getSpaceMembership('<spaceMembership_id>'))
.then((spaceMembership) => {
 spaceMembership.name = 'new space membership name'
})
.then((spaceMembership) => console.log(`spaceMembership ${spaceMembership.sys.id} updated.`))
.catch(console.error)

    Returns Promise<SpaceMembership>

    Object returned from the server with updated changes.