TeamSpaceMembership

TeamSpaceMembership

Source:
Team Space Membership instances

Type Definitions

TeamSpaceMembership

Source:
Properties:
Name Type Description
sys Meta.Sys System metadata
admin boolean User is an admin
roles array Array of Role Links
toPlainObject() function Returns this Team Space Membership 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.getTeamSpaceMembership('<team_space_membership_id>'))
.then((teamSpaceMembership) => teamSpaceMembership.delete())
.then(() => console.log(`spaceMembership 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.<SpaceMembership>}

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.getTeamSpaceMembership('team_space_membership_id'))
 .then((teamSpaceMembership) => {
   item.roles = [
     {
       sys: {
         type: 'Link',
         linkType: 'Role',
         id: 'role_id'
       }
     }
   ]
 })
 .then((spaceMembership) => console.log(`spaceMembership ${spaceMembership.sys.id} updated.`))
 .catch(console.error)
Returns:
Object returned from the server with updated changes.
Type
Promise.<SpaceMembership>