Interface TeamSpaceMembership

interface TeamSpaceMembership {
    admin: boolean;
    roles: {
        sys: MetaLinkProps;
    }[];
    sys: MetaSysProps & {
        space: {
            sys: MetaLinkProps;
        };
        team: {
            sys: MetaLinkProps;
        };
    };
    delete(): Promise<void>;
    toPlainObject(): TeamSpaceMembershipProps;
    update(): Promise<TeamSpaceMembership>;
}

Hierarchy (view full)

Properties

admin roles sys

Methods

delete toPlainObject update

Properties

admin

admin: boolean

Is admin

roles

roles: {
    sys: MetaLinkProps;
}[]

Roles

sys

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

System metadata

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.getTeamSpaceMembership('<team_space_membership_id>')) .then((teamSpaceMembership) => teamSpaceMembership.delete()) .then(() => console.log(`spaceMembership deleted.`)) .catch(console.error) ```

toPlainObject

update

  • update(): Promise<TeamSpaceMembership>

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

    Returns Promise<TeamSpaceMembership>

    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.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) ```

Settings

Member Visibility

On This Page

Properties
Methods