Interface SpaceMembership

interface SpaceMembership {
    admin: boolean;
    roles: SysLink[];
    sys: MetaSysProps & {
        space: SysLink;
        user: SysLink;
    };
    user: SysLink;
    delete(): Promise<void>;
    toPlainObject(): SpaceMembershipProps;
    update(): Promise<SpaceMembership>;
}

Hierarchy (view full)

Properties

admin roles sys user

Methods

delete toPlainObject update

Properties

admin

admin: boolean

roles

roles: SysLink[]

sys

sys: MetaSysProps & {
    space: SysLink;
    user: SysLink;
}

user

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

toPlainObject

update

  • update(): Promise<SpaceMembership>

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

    Returns Promise<SpaceMembership>

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

Settings

Member Visibility

On This Page

Properties
Methods