Interface Team

interface Team {
    description: string;
    name: string;
    sys: MetaSysProps & {
        memberCount: number;
        organization: {
            sys: MetaLinkProps;
        };
    };
    delete(): Promise<void>;
    toPlainObject(): TeamProps;
    update(): Promise<Team>;
}

Hierarchy (view full)

Properties

description name sys

Methods

delete toPlainObject update

Properties

description

description: string

Description of the team

name

name: string

Name of the team

sys

sys: MetaSysProps & {
    memberCount: number;
    organization: {
        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('organization_id') .then(org => org.getOrganizationMembership('organizationMembership_id')) .then((team) => { team.delete(); }) .catch(console.error) ```

toPlainObject

update

  • update(): Promise<Team>

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

    Returns Promise<Team>

    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('organization_id') .then(org => org.getTeam('team_id')) .then((team) => { team.description = 'new description'; team.update(); }) .catch(console.error) ```

Settings

Member Visibility

On This Page

Properties
Methods