Lime Web Components API Documentation - v6.24.0
    Preparing search index...

    Interface LimeObject

    A Lime object

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

    Indexable

    • [property: string]: any

      Dynamic properties of the limeobject

    Index

    Properties

    createdtime descriptive id timestamp

    Methods

    getFile getLimetype getValue

    Properties

    createdtime: string

    The created time of the limeobject

    descriptive: string

    Descriptive of the limeobject

    id: number

    Id of the lime object

    timestamp: string

    The last time the limeobject updated

    Methods

    • Get an attached file

      Parameters

      • name: string

        name of the file property

      Returns LimeFile

      the file if it exists, otherwise undefined

    • Get the limetype of the object

      Returns LimeType

      the limetype

    • Get the value of a property by name

      Parameters

      • name: string

        name of property to get the value of. Allows a path to be specified using dot notation to get the value of a related property

      Returns any

      the value of the specified property. If it is a relation, the related LimeObject will be returned

    Settings

    Member Visibility

    On This Page

    Properties
    Methods