Interface LimeObject

Represents a business object instance in Lime CRM.

A LimeObject is an instance of a LimeType with actual data values. It contains the object's properties, metadata, and methods for accessing data including related objects. Use the getValue() method to access properties — it supports dot notation for navigating relations.

Key characteristics:

Each object has a unique numeric ID
Contains audit timestamps (created, last updated)
Has a descriptive text representation
Use getValue() to access properties, with dot notation for relations
Can have attached files

Example: Use a decorator to get the current object

import { State } from '@stencil/core';
import {
    LimeObject,
    SelectCurrentLimeObject,
} from '@limetech/lime-web-components';

class MyComponent {
    @State()
    @SelectCurrentLimeObject()
    private limeObject: LimeObject;

    private logObject() {
        console.log(this.limeObject.descriptive);
        console.log(this.limeObject.id);
        console.log(new Date(this.limeObject.createdtime).toLocaleDateString());
        console.log(this.limeObject.getValue('name'));
    }
}

Example: Access properties using getValue() with dot notation

import { State } from '@stencil/core';
import {
    LimeObject,
    SelectCurrentLimeObject,
} from '@limetech/lime-web-components';

class MyComponent {
    @State()
    @SelectCurrentLimeObject()
    private deal: LimeObject;

    private readDealValues() {
        const dealName = this.deal.getValue('name');
        const dealValue = this.deal.getValue('value');

        // The path must have been loaded, otherwise the result is `undefined`.
        const companyName = this.deal.getValue('company.name');

        return { dealName, dealValue, companyName };
    }
}

Remarks

Only loaded properties are readable. Nested objects and properties are not lazy loaded, so decide which paths to load up front. See getValue.

The system fields id, createdtime, timestamp, and descriptive come from LimeObjectSystemProperties. Property values are typed as LimeObjectValue.

interface LimeObject {
    createdtime: string;
    descriptive: string;
    id: number;
    timestamp: string;
    getFile(name: string): LimeFile | undefined;
    getLimetype(): LimeType;
    getValue(name: string): any;
    [property: string]: any;
}

Hierarchy (View Summary)

LimeObjectSystemProperties
- LimeObject

Indexable

[property: string]: any
Dynamic property access for object properties.

Properties are accessible via bracket notation, but prefer getValue instead for consistent and relation-aware access.

Index

Properties

createdtime descriptive id timestamp

Methods

getFile getLimetype getValue

Properties

createdtime

createdtime: string

ISO 8601 timestamp when this object was created.

This is an audit field that records when the record was first created in the system. The timestamp includes date and time with timezone.

Example: Format the creation date

import { PlatformServiceName } from '@limetech/lime-web-components';

const repository = platform.get(PlatformServiceName.LimeObjectRepository);
const limeObject = repository.getObject('company', 1234);

if (limeObject) {
    const created = new Date(limeObject.createdtime);
    console.log(`Created on: ${created.toLocaleDateString()}`);
}

descriptive

descriptive: string

Human-readable text representation of this object.

This is the display name shown in lists, dropdowns, and references. Calculated from labels set on the LimeType's properties. Can be a single field or a combination of multiple fields.

Example: Display names for two different limetypes

import { PlatformServiceName } from '@limetech/lime-web-components';

const repository = platform.get(PlatformServiceName.LimeObjectRepository);

const company = repository.getObject('company', 1234);
const person = repository.getObject('person', 5678);

console.log(company?.descriptive); // "Acme Corporation"
console.log(person?.descriptive); // "John Doe" (firstname + lastname)

id

id: number

Unique identifier for this object.

The ID is a positive integer that uniquely identifies this record within its LimeType. IDs are auto-generated and immutable.

Example: Read the id of a cached object

import { PlatformServiceName } from '@limetech/lime-web-components';

const repository = platform.get(PlatformServiceName.LimeObjectRepository);
const limeObject = repository.getObject('company', 1234);

if (limeObject) {
    console.log(`Object ID: ${limeObject.id}`); // "Object ID: 1234"
}

timestamp

timestamp: string

ISO 8601 timestamp of the last modification to this object.

Updated automatically whenever any property of the object changes.

Example: Show how long ago the object changed

import { PlatformServiceName } from '@limetech/lime-web-components';

const repository = platform.get(PlatformServiceName.LimeObjectRepository);
const limeObject = repository.getObject('company', 1234);

if (limeObject) {
    const updated = new Date(limeObject.timestamp);
    const minutesAgo = (Date.now() - updated.getTime()) / 60_000;
    console.log(`Last updated ${Math.floor(minutesAgo)} minutes ago`);
}

Methods

getFile

getFile(name: string): LimeFile | undefined

Get an attached file from a file property.

Returns the LimeFile object for file attachments. Use this to access file metadata (name, size, MIME type) and download URLs.

Parameters

name: string
Name of the file property.

Returns LimeFile | undefined

The LimeFile if a file is attached, undefined otherwise.

Example: Get a file attachment

import { PlatformServiceName } from '@limetech/lime-web-components';

const repository = platform.get(PlatformServiceName.LimeObjectRepository);
const limeObject = repository.getObject('deal', 1234);

const document = limeObject?.getFile('contract_pdf');

if (document) {
    console.log(`File: ${document.filename}`);
    console.log(`Size: ${document.size} bytes`);
    console.log(`Extension: ${document.extension}`);

    const downloadUrl = document.getUrl('download');
}

getLimetype

getLimetype(): LimeType

Get the LimeType definition for this object.

Returns the type definition containing schema information, property definitions, ACL rules, and other metadata about this object's type.

Returns LimeType

The LimeType definition.

Example: Read schema and permissions from the type

import { PlatformServiceName } from '@limetech/lime-web-components';

const repository = platform.get(PlatformServiceName.LimeObjectRepository);
const limeObject = repository.getObject('deal', 1234);

if (limeObject) {
    const limetype = limeObject.getLimetype();
    console.log(`Object type: ${limetype.name}`);
    console.log(`Display name: ${limetype.localname.singular}`);

    const canEdit = limetype.acl.update;

    const nameProperty = limetype.getProperty('name');
    console.log(`Name is required: ${nameProperty.required}`);
}

getValue

getValue(name: string): any
Get the value of a property using dot notation to navigate relations.

This method provides type-safe property access with support for navigating through related objects. Use dot notation to traverse relations, e.g., company.address.city to get the city of a company's address.

This is the recommended way to access all properties, including simple values and relations.

Only properties that were loaded are returned. There is no lazy loading today, so reading a property or a relation that was not loaded returns undefined instead of fetching it. Ask for the paths you need up front through LoadOptions.properties, using dot notation for values on related objects.
Parameters
- name: string
  Property name or path. Use dots to navigate relations.
Returns any
The property value, or undefined if the property was not loaded. For relations, returns the related LimeObject.
Example: Simple property access
```
import { PlatformServiceName } from '@limetech/lime-web-components';

const repository = platform.get(PlatformServiceName.LimeObjectRepository);
const deal = repository.getObject('deal', 1234);

const name = deal?.getValue('name');
const status = deal?.getValue('status');
const value = deal?.getValue('value');
```
Example: Values on related objects have to be loaded first
```
import { PlatformServiceName } from '@limetech/lime-web-components';

const repository = platform.get(PlatformServiceName.LimeObjectRepository);

const deal = await repository.loadObject('deal', 1234, {
    properties: ['name', 'company.name', 'contact.email'],
});

const companyName = deal?.getValue('company.name');
const contactEmail = deal?.getValue('contact.email');

// Not loaded above, so this is `undefined` rather than a fetch
const contactPhone = deal?.getValue('contact.phone');
```
See
LoadOptions.properties to choose which properties are loaded

Interface LimeObject

Example: Use a decorator to get the current object

Example: Access properties using getValue() with dot notation

Remarks

Hierarchy (View Summary)

Indexable

Index

Properties

Methods

Properties

createdtime

Example: Format the creation date

descriptive

Example: Display names for two different limetypes

id

Example: Read the id of a cached object

timestamp

Example: Show how long ago the object changed

Methods

getFile

Parameters

Returns LimeFile | undefined

Example: Get a file attachment

getLimetype

Returns LimeType

Example: Read schema and permissions from the type

getValue

Parameters

Returns any

Example: Simple property access

See

Settings

On This Page

Interface LimeObject

Example: Use a decorator to get the current object

Example: Access properties using getValue() with dot notation

Remarks

Hierarchy (View Summary)

Indexable

Index

Properties

Methods

Properties

createdtime

Example: Format the creation date

descriptive

Example: Display names for two different limetypes

id

Example: Read the id of a cached object

timestamp

Example: Show how long ago the object changed

Methods

getFile

Parameters

Returns LimeFile | undefined

Example: Get a file attachment

getLimetype

Returns LimeType

Example: Read schema and permissions from the type

getValue

Parameters

Returns any

Example: Simple property access

Example: Values on related objects have to be loaded first

See

Settings

On This Page