Class TeamNode

Represents a team in the RAAIN system. This class manages team members and their contracts.

Remarks

Used in the API endpoint: api/teams?name=customerTeam

Example

const teamNode = new TeamNode({
  id: 'team1',
  name: 'Customer Team',
  description: 'Main customer support team',
  contracts: ['basic', 'premium'],
  contacts: [peopleNode1, peopleNode2]
});

Hierarchy (view full)

Constructors

constructor

Properties

id version TYPE name description contracts contacts

Accessors

links

Methods

getLinks getLink getLinkIds getLinksCount addLinks getVersion toJSON

Constructors

constructor

Properties

id

id: string

Unique identifier for the node

version

version: string

Version string of the node

Static Readonly TYPE

TYPE: "team" = 'team'

name

name: string

description

description: string

contracts

contracts: string[]

contacts

contacts: PeopleNode[]

Accessors

links

Methods

getLinks

getLink

getLinkIds

getLinksCount

  • getLinksCount(linkType?): number

  • Gets the count of links, optionally filtered by type.

    Parameters

    • Optional linkType: string

      Optional type of links to count

    Returns number

    The number of links

addLinks

getVersion

toJSON

  • toJSON(): {
        id: string;
        links: Link[];
        version?: string;
        name: string;
        description: string;
        contracts: string[];
        contacts: PeopleNode[];
    }

  • Converts the node to a JSON object.

    Returns {
        id: string;
        links: Link[];
        version?: string;
        name: string;
        description: string;
        contracts: string[];
        contacts: PeopleNode[];
    }

    A JSON object containing the node's data

    • id: string
    • links: Link[]
    • Optional version?: string
    • name: string
    • description: string
    • contracts: string[]
    • contacts: PeopleNode[]

Settings

Member Visibility

Theme

On This Page

constructoridversionTYPEnamedescriptioncontractscontactslinksgetLinksgetLinkgetLinkIdsgetLinksCountaddLinksgetVersiontoJSON