Interface OrganizationMembership

interface OrganizationMembership {
    role: string;
    status: boolean;
    sys: MetaSysProps & {
        user: {
            sys: MetaLinkProps;
        };
    };
    delete(): Promise<void>;
    toPlainObject(): OrganizationMembershipProps;
    update(): Promise<OrganizationMembership>;
}

Hierarchy (view full)

Properties

role status sys

Methods

delete toPlainObject update

Properties

role

role: string

Role

status

status: boolean

status

sys

sys: MetaSysProps & {
    user: {
        sys: MetaLinkProps;
    };
}

System metadata

Methods

delete

  • delete(): Promise<void>

  • Deletes this object on the server. @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((organizationMembership) => { organizationMembership.delete(); }) .catch(console.error)

    Returns Promise<void>

toPlainObject

update

  • update(): Promise<OrganizationMembership>

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

    Returns Promise<OrganizationMembership>

    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.getOrganizationMembership('organizationMembership_id')) .then((organizationMembership) => { organizationMembership.role = 'member'; organizationMembership.update(); }) .catch(console.error)

Settings

Member Visibility

On This Page

Properties
Methods