Vai al contenuto principale
Usa defineField() per aggiungere un campo a un oggetto che non possiedi — un oggetto standard di Twenty come Person o Company, oppure un oggetto fornito da un’altra app installata. A differenza dei campi inline dichiarati all’interno di defineObject, i campi autonomi richiedono un objectUniversalIdentifier per specificare quale oggetto estendono.
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' },
  ],
});

Punti chiave

  • objectUniversalIdentifier identifica l’oggetto di destinazione. Per gli oggetti standard di Twenty, importa la costante da 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
    // …
    
  • Quando definisci campi inline dentro defineObject(), non hai bisogno di objectUniversalIdentifier — viene ereditato dall’oggetto padre.
  • defineField() è l’unico modo per aggiungere campi a oggetti che non hai creato con defineObject().
  • Il percorso del file dipende da te. La convenzione è src/fields/\<name>.field.ts, ma l’SDK rileva i campi ovunque in src/.
  • Per aggiungere una scheda a un layout di pagina standard (ad es. la pagina di dettaglio di Task o Company), utilizza definePageLayoutTab con STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS da twenty-sdk/define.

Aggiungere una relazione a un oggetto esistente

Per aggiungere un campo di relazione (ad esempio collegare il tuo oggetto personalizzato a un Person standard), usa defineField() con FieldType.RELATION. Lo schema è lo stesso delle relazioni inline, ma con objectUniversalIdentifier impostato esplicitamente. Vedi Relazioni per lo schema bidirezionale.