객체 확장하기

defineField()를 사용해 소유하지 않은 객체(예: Person이나 Company 같은 표준 Twenty 객체 또는 다른 설치된 앱에서 제공하는 객체)에 필드를 추가합니다. defineObject 안에 선언된 인라인 필드와 달리, 독립형 필드는 어느 객체를 확장할지 지정하기 위해 objectUniversalIdentifier가 필요합니다.

src/fields/company-loyalty-tier.field.ts

import { defineField, FieldType } from 'twenty-sdk/define';

export default defineField({
  universalIdentifier: 'f2a1b3c4-d5e6-7890-abcd-ef1234567890',
  objectUniversalIdentifier: '701aecb9-eb1c-4d84-9d94-b954b231b64b', // Company object
  name: 'loyaltyTier',
  type: FieldType.SELECT,
  label: 'Loyalty Tier',
  icon: 'IconStar',
  options: [
    { value: 'BRONZE', label: 'Bronze', position: 0, color: 'orange' },
    { value: 'SILVER', label: 'Silver', position: 1, color: 'gray' },
    { value: 'GOLD', label: 'Gold', position: 2, color: 'yellow' },
  ],
});

핵심 요점

objectUniversalIdentifier는 대상 객체를 식별합니다. 표준 Twenty 객체의 경우 twenty-sdk에서 상수를 가져옵니다:

import { STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS } from 'twenty-sdk/define';

// STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.universalIdentifier
// STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.person.universalIdentifier
// STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.opportunity.universalIdentifier
// …

defineObject()에서 필드를 인라인으로 정의할 때는, objectUniversalIdentifier가 필요하지 않습니다 — 상위 객체에서 상속됩니다.
defineField()는 defineObject()로 생성하지 않은 객체에 필드를 추가하는 유일한 방법입니다.
파일 위치는 자유롭게 정할 수 있습니다. 규칙으로는 src/fields/\<name>.field.ts를 사용하지만, SDK는 src/ 어디에서든 필드를 감지합니다.
표준 페이지 레이아웃(예: Task 또는 Company 상세 페이지)에 탭을 추가하려면, twenty-sdk/define의 STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS와 함께 definePageLayoutTab을(를) 사용하십시오.

기존 객체에 관계 추가하기

관계 필드(예: 사용자 정의 객체를 표준 Person에 연결)를 추가하려면, FieldType.RELATION과 함께 defineField()를 사용하세요. 패턴은 인라인 관계와 동일하지만, objectUniversalIdentifier를 명시적으로 설정합니다. 양방향 패턴은 Relations를 참조하세요.

개요

앱

API

셀프 호스팅

기여

핵심 요점

기존 객체에 관계 추가하기

​핵심 요점

​기존 객체에 관계 추가하기

핵심 요점

기존 객체에 관계 추가하기