Interface TeamMembership

interface TeamMembership {
    admin: boolean;
    organizationMembershipId: string;
    sys: MetaSysProps & {
        organization: {
            sys: MetaLinkProps;
        };
        organizationMembership: {
            sys: MetaLinkProps;
        };
        team: {
            sys: MetaLinkProps;
        };
    };
    delete(): Promise<void>;
    toPlainObject(): TeamMembershipProps;
    update(): Promise<TeamMembership>;
}

Hierarchy (view full)

Properties

admin organizationMembershipId sys

Methods

delete toPlainObject update

Properties

admin

admin: boolean

Is admin

organizationMembershipId

organizationMembershipId: string

Organization membership id

sys

sys: MetaSysProps & {
    organization: {
        sys: MetaLinkProps;
    };
    organizationMembership: {
        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.getOrganization('organizationId') .then(org => org.getTeamMembership('teamId', 'teamMembershipId')) .then((teamMembership) => { teamMembership.delete(); }) .catch(console.error) ```

toPlainObject

update

  • update(): Promise<TeamMembership>

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

    Returns Promise<TeamMembership>

    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.getOrganization('organizationId') .then(org => org.getTeamMembership('teamId', 'teamMembershipId')) .then((teamMembership) => { teamMembership.admin = true; teamMembership.update(); }) .catch(console.error) ```

Settings

Member Visibility

On This Page

Properties
Methods